feat: add functions_env_vars (GoogleCloudPlatform#1551)

grant · web-flow · commit 5e4fbfe6883f · 2019-09-09T16:49:34.000-03:00
* feat: add functions_env_vars

* fix: Address function_ent comments around naming and tests

* Comments

* fix: Adds org.junit.contrib.java.lang.system.EnvironmentVariables to fix env vars

* docs: Convert JavaDoc to single comment

* fix: Fix lint issue
diff --git a/functions/snippets/pom.xml b/functions/snippets/pom.xml
@@ -60,6 +60,13 @@
       <scope>test</scope>
     </dependency>
 
+    <!-- Required for mocking env vars -->
+    <dependency>
+      <groupId>com.github.stefanbirkner</groupId>
+      <artifactId>system-rules</artifactId>
+      <version>1.19.0</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <!-- Required for Java 8 (Alpha) functions in the inline editor -->
diff --git a/functions/snippets/src/main/java/EnvVars.java b/functions/snippets/src/main/java/EnvVars.java
@@ -0,0 +1,36 @@
+/*
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// [START functions_env_vars]
+import java.io.IOException;
+import java.io.PrintWriter;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+public class EnvVars {
+  // Returns the environment variable "foo" set during function deployment.
+  public void envVar(HttpServletRequest request, HttpServletResponse response)
+      throws IOException {
+    PrintWriter writer = response.getWriter();
+    String foo = System.getenv("FOO");
+    if (foo == null) {
+      foo = "Specified environment variable is not set.";
+    }
+    writer.write(foo);
+  }
+}
+
+// [END functions_env_vars]
diff --git a/functions/snippets/src/test/java/SnippetsTests.java b/functions/snippets/src/test/java/SnippetsTests.java
@@ -32,7 +32,9 @@
 import javax.servlet.http.HttpServletResponse;
 import org.junit.After;
 import org.junit.Before;
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.contrib.java.lang.system.EnvironmentVariables;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
 
@@ -45,6 +47,10 @@ public class SnippetsTests {
   private ByteArrayOutputStream stdOut;
   private StringWriter responseOut;
 
+  @Rule
+  public final EnvironmentVariables environmentVariables
+      = new EnvironmentVariables();
+
   @Before
   public void beforeTest() throws Exception {
     // Use a new mock for each test
@@ -167,6 +173,13 @@ public void helloBackgroundTest() throws IOException {
     assertThat(responseOut.toString(), containsString("Hello John!"));    
   }
 
+  @Test
+  public void envTest() throws IOException {
+    environmentVariables.set("FOO", "BAR");
+    new EnvVars().envVar(request, response);
+    assertThat(responseOut.toString(), containsString("BAR"));
+  }
+  
   @Test
   public void helloExecutionCount() throws IOException {
     new Concepts().executionCount(request, response);
