Variable Groups bug fix (#200)

* Fixes #889

* Incorporated feedback

* Incorporated feedback

Author: sarath-p

src/commands/project/create-variable-group.ts

@@ -209,7 +209,7 @@ export const create = async (
       description: "Created from spk CLI",
       name: variableGroupName,
       type: "Vsts",
-      variables: [vars]
+      variables: vars
     };
     return await addVariableGroup(variableGroupData, accessOpts);
   } catch (err) {

src/lib/pipelines/variableGroup.test.ts

@@ -16,14 +16,13 @@ import {
   enableVerboseLogging,
   logger
 } from "../../logger";
-import { IVariableGroupData } from "../../types";
+import { IVariableGroupData, IVariableGroupDataVariable } from "../../types";
 import {
   addVariableGroup,
   addVariableGroupWithKeyVaultMap,
   authorizeAccessToAllPipelines,
   buildVariablesMap,
   doAddVariableGroup,
-  IVariablesMap,
   TaskApi
 } from "./variableGroup";
 
@@ -381,11 +380,10 @@ describe("authorizeAccessToAllPipelines", () => {
     };
 
     let authorized: boolean | undefined;
-    let error: Error | undefined;
     try {
       authorized = await authorizeAccessToAllPipelines(variableGroup);
     } catch (err) {
-      error = err;
+      logger.error(err);
     }
     expect(authorized).toBeUndefined();
   });
@@ -406,97 +404,68 @@ describe("authorizeAccessToAllPipelines", () => {
 
 describe("buildVariablesMap", () => {
   test("should create variable map with two variables", async () => {
-    const var1: IVariablesMap = {
+    const variables: IVariableGroupDataVariable = {
       var1: {
         isSecret: false,
         value: "val1"
-      }
-    };
-    const var2: IVariablesMap = {
+      },
       var2: {
         isSecret: true,
         value: "val2"
       }
     };
 
-    const variables: IVariablesMap[] = [];
-    variables.push(var1);
-    variables.push(var2);
-
-    let map: IVariablesMap | undefined;
-    const expectedMap: any = `{"0":{"var1":{"isSecret":false,"value":"val1"}},"1":{"var2":{"isSecret":true,"value":"val2"}}}`;
-    map = await buildVariablesMap(variables);
-    expect(JSON.stringify(map)).toEqual(expectedMap);
+    const map = await buildVariablesMap(variables);
+    expect(map).toEqual(variables);
     logger.info(`map: ${JSON.stringify(map)}`);
   });
 
   test("should create variable map with one variable", async () => {
-    const var1: IVariablesMap = {
+    const variables: IVariableGroupDataVariable = {
       var1: {
         isSecret: false,
         value: "val1"
       }
     };
 
-    const variables: IVariablesMap[] = [];
-    variables.push(var1);
-
-    let map: IVariablesMap | undefined;
-    const expectedMap: any = `{"0":{"var1":{"isSecret":false,"value":"val1"}}}`;
-    map = await buildVariablesMap(variables);
-    expect(JSON.stringify(map)).toEqual(expectedMap);
+    const map = await buildVariablesMap(variables);
+    expect(map).toEqual(variables);
   });
 
   test("should create empty variable map with no variables", async () => {
-    const variables: IVariablesMap[] = [];
-    let map: IVariablesMap | undefined;
-    const expectedMap: any = `{}`;
-    map = await buildVariablesMap(variables);
-    expect(JSON.stringify(map)).toEqual(expectedMap);
+    const variables: IVariableGroupDataVariable = {};
+    const map = await buildVariablesMap(variables);
+    expect(Object.keys(map).length).toBe(0);
   });
 
   test("should create variable map with two secrets", async () => {
-    const var1: IVariablesMap = {
+    const variables: IVariableGroupDataVariable = {
       secret1: {
         enabled: false
-      }
-    };
-    const var2: IVariablesMap = {
+      },
       secret2: {
         enabled: true
       }
     };
 
-    const variables: IVariablesMap[] = [];
-    variables.push(var1);
-    variables.push(var2);
-
-    let secretsMap: IVariablesMap | undefined;
-    const expectedMap: any = `{"0":{"secret1":{"enabled":false}},"1":{"secret2":{"enabled":true}}}`;
-    secretsMap = await buildVariablesMap(variables);
-    expect(JSON.stringify(secretsMap)).toEqual(expectedMap);
+    const secretsMap = await buildVariablesMap(variables);
+    expect(secretsMap).toEqual(variables);
   });
 
   test("should create variable map with one secret", async () => {
-    const var1: IVariablesMap = {
+    const variables: IVariableGroupDataVariable = {
       secret1: {
         enabled: true
       }
     };
 
-    const variables: IVariablesMap[] = [];
-    variables.push(var1);
-    let secretsMap: IVariablesMap | undefined;
-    const expectedMap: any = `{"0":{"secret1":{"enabled":true}}}`;
-    secretsMap = await buildVariablesMap(variables);
-    expect(JSON.stringify(secretsMap)).toEqual(expectedMap);
+    const secretsMap = await buildVariablesMap(variables);
+    expect(secretsMap).toEqual(variables);
   });
 
   test("should create empty variable map with no secrets", async () => {
-    const variables: IVariablesMap[] = [];
-    let secretsMap: IVariablesMap | undefined;
-    const expectedMap: any = `{}`;
-    secretsMap = await buildVariablesMap(variables);
-    expect(JSON.stringify(secretsMap)).toEqual(expectedMap);
+    const variables: IVariableGroupDataVariable = {};
+    const secretsMap = await buildVariablesMap(variables);
+    expect(Object.keys(secretsMap).length).toBe(0);
   });
 });

src/lib/pipelines/variableGroup.ts

@@ -252,24 +252,16 @@ export const authorizeAccessToAllPipelines = async (
   }
 };
 
-/**
- * Key/value interface for variables
- *
- */
-export interface IVariablesMap {
-  [key: string]: AzureKeyVaultVariableValue;
-}
-
 /**
  * Creates `IVariablesMap` object from variables key/value pairs
  *
  * @param variableGroup The Variable group object
  * @returns `IVariablesMap[]` with Varibale Group variables
  */
 export const buildVariablesMap = async (
-  variables: IVariablesMap[]
-): Promise<IVariablesMap> => {
-  const variablesMap: IVariablesMap = {};
+  variables: IVariableGroupDataVariable
+): Promise<IVariableGroupDataVariable> => {
+  const variablesMap: IVariableGroupDataVariable = {};
   logger.debug(`variables: ${JSON.stringify(variables)}`);
 
   for (const [key, value] of Object.entries(variables)) {

src/types.d.ts

@@ -143,7 +143,7 @@ export interface IVariableGroupData {
   name: string;
   description: string;
   type: string;
-  variables: IVariableGroupDataVariable[];
+  variables: IVariableGroupDataVariable;
   key_vault_provider?: {
     name: string;
     service_endpoint: IServiceEndpointData;