[ENG-14822][steps] Coerce env in steps to string

Author: szdziedzic

packages/steps/src/BuildConfig.ts

@@ -188,7 +188,12 @@ const BuildFunctionCallSchema = Joi.object({
   name: Joi.string(),
   workingDirectory: Joi.string(),
   shell: Joi.string(),
-  env: Joi.object().pattern(Joi.string(), Joi.string().allow('')),
+  env: Joi.object().pattern(
+    Joi.string(),
+    Joi.alternatives()
+      .try(Joi.number(), Joi.string().allow(''))
+      .custom((value) => String(value))
+  ),
   if: Joi.string(),
   timeout_minutes: Joi.number().positive(),
   // Internal field for metrics collection. Not documented publicly.

packages/steps/src/__tests__/BuildConfig-test.ts

@@ -258,7 +258,7 @@ describe(validateConfig, () => {
 
           expect(() => {
             validateConfig(BuildConfigSchema, buildConfig);
-          }).toThrowError(/"build.steps\[0\].run.env.ENV1" must be a string/);
+          }).toThrowError(/"build.steps\[0\].run.env.ENV1" must be one of \[number, string\]/);
         });
         test('invalid env type', () => {
           const buildConfig = {
@@ -278,7 +278,27 @@ describe(validateConfig, () => {
 
           expect(() => {
             validateConfig(BuildConfigSchema, buildConfig);
-          }).toThrowError(/"build.steps\[0\].run.env.ENV1" must be a string/);
+          }).toThrowError(/"build.steps\[0\].run.env.ENV1" must be one of \[number, string\]/);
+        });
+        test('env number coerced to string', () => {
+          const buildConfig = {
+            build: {
+              steps: [
+                {
+                  run: {
+                    command: 'echo 123',
+                    env: {
+                      HOMEBREW_NO_AUTO_UPDATE: 1,
+                    },
+                  },
+                },
+              ],
+            },
+          };
+
+          const config = validateConfig(BuildConfigSchema, buildConfig);
+          assert(isBuildStepCommandRun(config.build.steps[0]));
+          expect(config.build.steps[0].run.env).toEqual({ HOMEBREW_NO_AUTO_UPDATE: '1' });
         });
         test('valid timeout_minutes', () => {
           const buildConfig = {
@@ -471,6 +491,36 @@ describe(validateConfig, () => {
             validateConfig(BuildConfigSchema, buildConfig);
           }).not.toThrowError();
         });
+        test('call with env number coerced to string', () => {
+          const buildConfig = {
+            build: {
+              steps: [
+                {
+                  say_hi: {
+                    env: {
+                      HOMEBREW_NO_AUTO_UPDATE: 1,
+                      PORT: 3000,
+                      VERBOSE: 'true',
+                    },
+                  },
+                },
+              ],
+            },
+            functions: {
+              say_hi: {
+                command: 'echo "Hi!"',
+              },
+            },
+          };
+
+          const config = validateConfig(BuildConfigSchema, buildConfig);
+          const step = config.build.steps[0] as BuildStepFunctionCall;
+          expect(step['say_hi'].env).toEqual({
+            HOMEBREW_NO_AUTO_UPDATE: '1',
+            PORT: '3000',
+            VERBOSE: 'true',
+          });
+        });
         test('call with if statement', () => {
           const buildConfig = {
             build: {
@@ -518,7 +568,7 @@ describe(validateConfig, () => {
 
           expect(() => {
             validateConfig(BuildConfigSchema, buildConfig);
-          }).toThrowError(/"build.steps\[0\].say_hi.env.ENV1" must be a string/);
+          }).toThrowError(/"build.steps\[0\].say_hi.env.ENV1" must be one of \[number, string\]/);
         });
         test('invalid env structure', () => {
           const buildConfig = {
@@ -544,7 +594,7 @@ describe(validateConfig, () => {
 
           expect(() => {
             validateConfig(BuildConfigSchema, buildConfig);
-          }).toThrowError(/"build.steps\[0\].say_hi.env.ENV1" must be a string/);
+          }).toThrowError(/"build.steps\[0\].say_hi.env.ENV1" must be one of \[number, string\]/);
         });
         test('call with inputs boolean', () => {
           const buildConfig = {