Add tests for case-sensitive environment variables

Signed-off-by: Kyle Harding <[email protected]>

Author: klutchell

test/unit/lib/plugins/environments.test.js

@@ -365,7 +365,7 @@ describe('Environments Plugin test suite', () => {
           name: environment_name,
           variables: [
             {
-              name: 'test',
+              name: 'TEST',
               value: 'test'
             }
           ]
@@ -392,11 +392,151 @@ describe('Environments Plugin test suite', () => {
         expect(github.request).toHaveBeenCalledWith('GET /repos/:org/:repo/environments', { org, repo });
         expect(github.request).toHaveBeenCalledWith('GET /repos/:org/:repo/environments/:environment_name/variables', { org, repo, environment_name });
         expect(github.request).toHaveBeenCalledWith('GET /repos/:org/:repo/environments/:environment_name/deployment_protection_rules', { org, repo, environment_name });
+        // https://docs.github.com/en/rest/actions/variables#create-an-environment-variable
+        // Body parameters name and value are case-sensitive!
         expect(github.request).toHaveBeenCalledWith('POST /repos/:org/:repo/environments/:environment_name/variables', expect.objectContaining({
           org,
           repo,
           environment_name: environment_name,
-          name: 'test',
+          name: 'TEST',
+          value: 'test'
+        }));
+      })
+    })
+  })
+
+  // patch variable
+  describe('When there are existing variables and one requires an update', () => {
+    it('detect divergence and add the variable', async () => {
+      //arrange
+      environment_name = 'variables_environment'
+      // represent config with a reviewers being a user and a team
+      const plugin = new Environments(undefined, github, { owner: org, repo }, [
+        {
+          name: environment_name,
+          variables: [
+            {
+              name: 'test',
+              value: 'test'
+            }
+          ]
+        }
+      ], log, errors);
+
+      //model an existing environment with no reviewers
+      when(github.request)
+        .calledWith('GET /repos/:org/:repo/environments', { org, repo })
+        .mockResolvedValue({
+          data: {
+            environments: [
+              fillEnvironment({
+                name: environment_name,
+                variables: []
+              })
+            ]
+          }
+        });
+
+      when(github.request)
+        .calledWith('GET /repos/:org/:repo/environments/:environment_name/variables', { org, repo, environment_name })
+        .mockResolvedValue({
+          data: {
+            variables: [
+              {
+                name: 'test',
+                value: 'old'
+              },
+              {
+                name: 'test2',
+                value: 'test2'
+              }
+            ]
+          }
+        })
+
+      //act - run sync() in environments.js
+      await plugin.sync().then(() => {
+        //assert - update the variables
+        expect(github.request).toHaveBeenCalledWith('GET /repos/:org/:repo/environments', { org, repo });
+        expect(github.request).toHaveBeenCalledWith('GET /repos/:org/:repo/environments/:environment_name/variables', { org, repo, environment_name });
+        expect(github.request).toHaveBeenCalledWith('GET /repos/:org/:repo/environments/:environment_name/deployment_protection_rules', { org, repo, environment_name });
+        // https://docs.github.com/en/rest/actions/variables#update-an-environment-variable
+        // URL parameter variable_name is case-insensitive!
+        expect(github.request).toHaveBeenCalledWith('PATCH /repos/:org/:repo/environments/:environment_name/variables/:variable_name', expect.objectContaining({
+          org,
+          repo,
+          environment_name: environment_name,
+          variable_name: expect.stringMatching(/test/i),
+          value: 'test'
+        }));
+      })
+    })
+  })
+
+  // patch variable
+  describe('When there are existing mixed-case variables and one requires an update', () => {
+    it('detect divergence and update the variable', async () => {
+      //arrange
+      environment_name = 'variables_environment'
+      // represent config with a reviewers being a user and a team
+      const plugin = new Environments(undefined, github, { owner: org, repo }, [
+        {
+          name: environment_name,
+          variables: [
+            {
+              name: 'TEST',
+              value: 'test'
+            }
+          ]
+        }
+      ], log, errors);
+
+      //model an existing environment with no reviewers
+      when(github.request)
+        .calledWith('GET /repos/:org/:repo/environments', { org, repo })
+        .mockResolvedValue({
+          data: {
+            environments: [
+              fillEnvironment({
+                name: environment_name,
+                variables: []
+              })
+            ]
+          }
+        });
+
+      when(github.request)
+        .calledWith('GET /repos/:org/:repo/environments/:environment_name/variables', { org, repo, environment_name })
+        .mockResolvedValue({
+          data: {
+            variables: [
+              {
+                name: 'TEST',
+                value: 'old'
+              },
+              {
+                name: 'TEST2',
+                value: 'test2'
+              }
+            ]
+          }
+        })
+
+      //act - run sync() in environments.js
+      await plugin.sync().then(() => {
+        //assert - update the variables
+        expect(github.request).toHaveBeenCalledWith('GET /repos/:org/:repo/environments', { org, repo });
+        // https://docs.github.com/en/rest/actions/variables#list-environment-variables
+        // Returned properties are case-sensitive!
+        expect(github.request).toHaveBeenCalledWith('GET /repos/:org/:repo/environments/:environment_name/variables', { org, repo, environment_name });
+        expect(github.request).toHaveBeenCalledWith('GET /repos/:org/:repo/environments/:environment_name/deployment_protection_rules', { org, repo, environment_name });
+        // https://docs.github.com/en/rest/actions/variables#update-an-environment-variable
+        // URL parameter variable_name is case-insensitive!
+        expect(github.request).toHaveBeenCalledWith('PATCH /repos/:org/:repo/environments/:environment_name/variables/:variable_name', expect.objectContaining({
+          org,
+          repo,
+          environment_name: environment_name,
+          variable_name: expect.stringMatching(/test/i),
           value: 'test'
         }));
       })