feat(container): add env key to specify env vars for containers

Also removed the `variables` key from the base test spec schema, and instead added the `env` key to the `generic` test spec schema (which is inherited by the `container` schema). BREAKING CHANGE: The `tests[].variables` config key has been removed from the `garden.yml` configuration file schema.
garden-io · Jul 2, 2018 · 9fa0cb8 · 9fa0cb8
1 parent a5096ee
commit 9fa0cb8
Show file tree

Hide file tree

Showing 21 changed files with 127 additions and 95 deletions.
diff --git a/docs/reference/config.md b/docs/reference/config.md
@@ -271,6 +271,13 @@ module:
             target:
 
 
+  # Key/value map of environment variables. Keys must be valid POSIX environment variable names
+  # (must be uppercase, may not start with `GARDEN`) and values must be primitives.
+  # 
+  # Optional.
+  env: 
+    {}
+
   # A list of tests to run in the module.
   # 
   # Optional.
@@ -290,12 +297,6 @@ module:
         - 
 
 
-      # Map of key/value pairs that are available during the test execution.
-      # 
-      # Optional.
-      variables: 
-        {}
-
       # Maximum duration (in seconds) of the test run.
       # 
       # Optional.
@@ -305,7 +306,15 @@ module:
       # 
       # Optional.
       command: 
-        -
+        - 
+
+
+      # Key/value map of environment variables. Keys must be valid POSIX environment variable
+      # names (must be uppercase, may not start with `GARDEN`) and values must be primitives.
+      # 
+      # Optional.
+      env: 
+        {}
 
 ```
 
@@ -387,43 +396,6 @@ module:
             target:
 
 
-  # A list of tests to run in the module.
-  # 
-  # Optional.
-  tests: 
-    # The test specification of a generic module.
-    # 
-    # Optional.
-    - # The name of the test.
-      # 
-      # Required.
-      name: 
-
-      # The names of services that must be running before the test is run.
-      # 
-      # Optional.
-      dependencies: 
-        - 
-
-
-      # Map of key/value pairs that are available during the test execution.
-      # 
-      # Optional.
-      variables: 
-        {}
-
-      # Maximum duration (in seconds) of the test run.
-      # 
-      # Optional.
-      timeout: 
-
-      # The command to run in the module build context in order to test it.
-      # 
-      # Optional.
-      command: 
-        -
-
-
   # Specify build arguments when building the container image.
   # 
   # Optional.
@@ -499,6 +471,13 @@ module:
           port:
 
 
+      # Key/value map of environment variables. Keys must be valid POSIX environment variable
+      # names (must be uppercase, may not start with `GARDEN`) and values must be primitives.
+      # 
+      # Optional.
+      env: 
+        {}
+
       # Specify how the service's health should be checked after deploying.
       # 
       # Optional.
@@ -578,5 +557,44 @@ module:
 
           hostPath:
 
+
+  # A list of tests to run in the module.
+  # 
+  # Optional.
+  tests: 
+    # The test specification of a generic module.
+    # 
+    # Optional.
+    - # The name of the test.
+      # 
+      # Required.
+      name: 
+
+      # The names of services that must be running before the test is run.
+      # 
+      # Optional.
+      dependencies: 
+        - 
+
+
+      # Maximum duration (in seconds) of the test run.
+      # 
+      # Optional.
+      timeout: 
+
+      # The command to run in the module build context in order to test it.
+      # 
+      # Optional.
+      command: 
+        - 
+
+
+      # Key/value map of environment variables. Keys must be valid POSIX environment variable
+      # names (must be uppercase, may not start with `GARDEN`) and values must be primitives.
+      # 
+      # Optional.
+      env: 
+        {}
+
 ```
 
diff --git a/examples/hello-world/services/hello-container/garden.yml b/examples/hello-world/services/hello-container/garden.yml
@@ -16,6 +16,8 @@ module:
           port: http
       dependencies:
         - hello-function
+      env:
+        FUNCTION_ENDPOINT: ${dependencies.hello-function.outputs.endpoint}
   build:
     dependencies:
       - hello-npm-package

diff --git a/src/plugins/container.ts b/src/plugins/container.ts
@@ -15,6 +15,7 @@ import {
 } from "../types/module"
 import { LogSymbolType } from "../logger/types"
 import {
+  joiEnvVars,
   joiIdentifier,
   joiArray,
   validate,
@@ -43,12 +44,7 @@ import {
 import { DEFAULT_PORT_PROTOCOL } from "../constants"
 import { splitFirst } from "../util/util"
 import { keyBy } from "lodash"
-import {
-  genericModuleSpecSchema,
-  GenericModuleSpec,
-  GenericTestSpec,
-  genericTestSchema,
-} from "./generic"
+import { genericTestSchema, GenericTestSpec } from "./generic"
 
 export interface ServiceEndpointSpec {
   paths?: string[]
@@ -87,6 +83,7 @@ export interface ContainerServiceSpec extends BaseServiceSpec {
   command: string[],
   daemon: boolean
   endpoints: ServiceEndpointSpec[],
+  env: PrimitiveMap,
   healthCheck?: ServiceHealthCheckSpec,
   ports: ServicePortSpec[],
   volumes: ServiceVolumeSpec[],
@@ -168,6 +165,7 @@ const serviceSchema = baseServiceSchema
       .description("Whether to run the service as a daemon (to ensure only one runs per node)."),
     endpoints: joiArray(endpointSchema)
       .description("List of endpoints that the service exposes."),
+    env: joiEnvVars(),
     healthCheck: healthCheckSchema
       .description("Specify how the service's health should be checked after deploying."),
     ports: joiArray(portSchema)
@@ -178,11 +176,17 @@ const serviceSchema = baseServiceSchema
       .description("List of volumes that should be mounted when deploying the container."),
   })
 
+export class ContainerService extends Service<ContainerModule> { }
+
+export interface ContainerTestSpec extends GenericTestSpec { }
+
+export const containerTestSchema = genericTestSchema
+
 export interface ContainerModuleSpec extends ModuleSpec {
   buildArgs: PrimitiveMap,
   image?: string,
   services: ContainerServiceSpec[],
-  tests: GenericTestSpec[],
+  tests: ContainerTestSpec[],
 }
 
 export type ContainerModuleConfig = ModuleConfig<ContainerModuleSpec>
@@ -203,17 +207,15 @@ export const containerModuleSpecSchema = Joi.object()
     services: joiArray(serviceSchema)
       .unique("name")
       .description("List of services to deploy from this container module."),
-    tests: joiArray(genericTestSchema)
+    tests: joiArray(containerTestSchema)
       .description("A list of tests to run in the module."),
   })
   .description("Configuration for a container module.")
 
-export class ContainerService extends Service<ContainerModule> { }
-
 export class ContainerModule<
   M extends ContainerModuleSpec = ContainerModuleSpec,
   S extends ContainerServiceSpec = ContainerServiceSpec,
-  T extends GenericTestSpec = GenericTestSpec,
+  T extends ContainerTestSpec = ContainerTestSpec,
   > extends Module<M, S, T> { }
 
 export async function getImage(module: ContainerModule) {
@@ -327,7 +329,6 @@ export async function parseContainerModule({ moduleConfig }: ParseModuleParams<C
     dependencies: t.dependencies,
     spec: t,
     timeout: t.timeout,
-    variables: <PrimitiveMap>t.variables,
   }))
 
   // make sure we can build the thing

diff --git a/src/plugins/generic.ts b/src/plugins/generic.ts
@@ -47,12 +47,14 @@ export const name = "generic"
 
 export interface GenericTestSpec extends BaseTestSpec {
   command: string[],
+  env: PrimitiveMap,
 }
 
 export const genericTestSchema = baseTestSpecSchema
   .keys({
     command: Joi.array().items(Joi.string())
       .description("The command to run in the module build context in order to test it."),
+    env: joiEnvVars(),
   })
   .description("The test specification of a generic module.")
 
@@ -85,7 +87,6 @@ export async function parseGenericModule(
       dependencies: t.dependencies,
       spec: t,
       timeout: t.timeout,
-      variables: t.variables,
     })),
   }
 }
@@ -120,7 +121,7 @@ export async function testGenericModule({ module, testConfig }: TestModuleParams
     command.slice(1),
     {
       cwd: module.path,
-      env: { ...process.env, ...module.spec.env },
+      env: { ...process.env, ...module.spec.env, ...testConfig.spec.env },
       ignoreError: true,
     },
   )

diff --git a/src/plugins/google/google-app-engine.ts b/src/plugins/google/google-app-engine.ts
@@ -67,7 +67,7 @@ export const gardenPlugin = (): GardenPlugin => ({
         const appYaml: any = {
           runtime: "custom",
           env: "flex",
-          env_variables: runtimeContext.envVars,
+          env_variables: { ...runtimeContext.envVars, ...service.spec.env },
         }
 
         if (config.healthCheck) {

diff --git a/src/plugins/google/google-cloud-functions.ts b/src/plugins/google/google-cloud-functions.ts
@@ -93,7 +93,6 @@ export async function parseGcfModule(
     tests: moduleConfig.spec.tests.map(t => ({
       name: t.name,
       dependencies: t.dependencies,
-      variables: t.variables,
       timeout: t.timeout,
       spec: t,
     })),

diff --git a/src/plugins/kubernetes/actions.ts b/src/plugins/kubernetes/actions.ts
@@ -288,7 +288,7 @@ export async function testModule(
 ): Promise<TestResult> {
   const testName = testConfig.name
   const command = testConfig.spec.command
-  runtimeContext.envVars = { ...runtimeContext.envVars, ...testConfig.variables }
+  runtimeContext.envVars = { ...runtimeContext.envVars, ...testConfig.spec.env }
   const timeout = testConfig.timeout || DEFAULT_TEST_TIMEOUT
 
   const result = await runModule({ ctx, provider, env, module, command, interactive, runtimeContext, silent, timeout })

diff --git a/src/plugins/kubernetes/deployment.ts b/src/plugins/kubernetes/deployment.ts
@@ -117,7 +117,7 @@ export async function createDeployment(service: ContainerService, runtimeContext
     },
   }
 
-  const envVars = extend({}, runtimeContext.envVars)
+  const envVars = { ...runtimeContext.envVars, ...service.spec.env }
 
   const labels = {
     // tier: service.tier,

diff --git a/src/plugins/local/local-docker-swarm.ts b/src/plugins/local/local-docker-swarm.ts
@@ -64,7 +64,7 @@ export const gardenPlugin = (): GardenPlugin => ({
           }
         })
 
-        const envVars = map(runtimeContext.envVars, (v, k) => `${k}=${v}`)
+        const envVars = map({ ...runtimeContext.envVars, ...service.spec.env }, (v, k) => `${k}=${v}`)
 
         const volumeMounts = service.spec.volumes.map(v => {
           // TODO-LOW: Support named volumes

diff --git a/src/plugins/local/local-google-cloud-functions.ts b/src/plugins/local/local-google-cloud-functions.ts
@@ -57,6 +57,7 @@ export const gardenPlugin = (): GardenPlugin => ({
             endpoints: [{
               port: "http",
             }],
+            env: {},
             healthCheck: { tcpPort: "http" },
             ports: [
               {

diff --git a/src/types/common.ts b/src/types/common.ts
@@ -30,7 +30,7 @@ export const joiPrimitive = () => Joi.alternatives().try(Joi.number(), Joi.strin
   .description("Number, string or boolean")
 
 export const identifierRegex = /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/
-export const envVarRegex = /^[a-zA-Z_][a-zA-Z0-9_]*$/
+export const envVarRegex = /^(?!GARDEN)[A-Z_][A-Z0-9_]*$/
 
 export const joiIdentifier = () => Joi
   .string().regex(identifierRegex)
@@ -47,18 +47,24 @@ export const joiIdentifierMap = (valueSchema: JoiObject) => Joi
 export const joiVariables = () => Joi
   .object().pattern(/[\w\d]+/i, joiPrimitive())
   .default(() => ({}), "{}")
+  .unknown(false)
   .description("Key/value map, keys may contain letters and numbers, and values must be primitives.")
 
 export const joiEnvVarName = () => Joi
   .string().regex(envVarRegex)
   .description(
-    "Valid POSIX environment variable name (may contain letters, numbers and underscores and must start with a letter.",
+    "Valid POSIX environment variable name (may contain letters, numbers and underscores and must start with a " +
+    "letter). Must be uppercase, and must not start with `GARDEN`.",
 )
 
 export const joiEnvVars = () => Joi
   .object().pattern(envVarRegex, joiPrimitive())
   .default(() => ({}), "{}")
-  .description("Key/value map, keys must be valid POSIX environment variable names, and values must be primitives.")
+  .unknown(false)
+  .description(
+    "Key/value map of environment variables. Keys must be valid POSIX environment variable names " +
+    "(must be uppercase, may not start with `GARDEN`) and values must be primitives.",
+)
 
 export const joiArray = (schema) => Joi
   .array().items(schema)