Merge pull request #2 from fnproject/master

Origin repo changes sync

.circleci/config.yml

@@ -48,7 +48,10 @@ jobs:
 
       - run:
          name: Login to Docker
-         command: docker login -u $DOCKER_USER -p $DOCKER_PASS
+         command: |
+           if [[ "${CIRCLE_BRANCH}" == "master" && -z "${CIRCLE_PR_REPONAME}" ]]; then
+               docker login -u $DOCKER_USER -p $DOCKER_PASS
+           fi
 
       - run:
           name: Build fn-java-fdk Docker build image

.gitignore

@@ -9,4 +9,6 @@ target/
 logs/
 /headrevtag.txt
 *.bak
-*.versionsBackup
+*.versionsBackup
+.gradle
+examples/gradle-build/build

api/pom.xml

@@ -30,6 +30,31 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.netbeans.tools</groupId>
+                <artifactId>sigtest-maven-plugin</artifactId>
+                <version>1.0</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <sigfile>src/main/api/snapshot.sigfile</sigfile>
+                    <action>strictcheck</action>
+                    <packages>com.fnproject.fn.api,com.fnproject.fn.api.exception,com.fnproject.fn.api.flow</packages>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
+    <dependencies>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
 </project>

api/src/main/java/com/fnproject/fn/api/TypeWrapper.java

@@ -11,11 +11,11 @@ public interface TypeWrapper {
      *
      * For example, take the following classes:
      * <pre>{@code
-     * class GenericParent&lt;T&gt; {
+     * class GenericParent<T> {
      *   public void someMethod(T t) { // do something with t }
      * }
      *
-     * class ConcreteClass extends GenericParent&lt;String&gt; { }
+     * class ConcreteClass extends GenericParent<String> { }
      * }</pre>
      *
      * A {@link TypeWrapper} representing the first argument of {@code someMethod} would return {@code String.class}

api/src/main/java/com/fnproject/fn/api/flow/Flows.java

@@ -8,7 +8,9 @@
 /**
  * Fn Flow API entry point class  - this provides access to the current {@link Flow} for the current function invocation.
  */
-public class Flows {
+public final class Flows {
+    private Flows() {
+    }
 
     private static FlowSource flowSource;
 

api/src/test/java/com/fnproject/fn/api/flow/FlowsTest.java

@@ -0,0 +1,23 @@
+package com.fnproject.fn.api.flow;
+
+import java.lang.reflect.Modifier;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import org.junit.Test;
+
+public class FlowsTest {
+    public FlowsTest() {
+    }
+
+    /** People shall not be allowed to create subclasses of {@code Flow}:
+    * <pre>
+    * static class MyFlows extends Flows {
+    * }
+    * </pre>
+    */
+    @Test
+    public void dontSubclassFlows() {
+        assertTrue("Flows is final", Modifier.isFinal(Flows.class.getModifiers()));
+        assertEquals("No visible constructors", 0, Flows.class.getConstructors().length);
+    }
+}

build-image/Dockerfile

@@ -1,5 +1,5 @@
 FROM maven:3-jdk-8-slim
-
+ARG FN_REPO_URL
 ADD pom.xml /tmp/cache-deps/pom.xml
 ADD cache-deps.sh /tmp/cache-deps/cache-deps.sh
 ADD src /tmp/cache-deps/src

build-image/Dockerfile-jdk9

@@ -1,4 +1,5 @@
 FROM maven:3-jdk-9-slim
+ARG FN_REPO_URL
 
 ADD pom.xml /tmp/cache-deps/pom.xml
 ADD cache-deps.sh /tmp/cache-deps/cache-deps.sh

build-image/cache-deps.sh

@@ -1,4 +1,12 @@
 #!/bin/bash -ex
 
-cd /tmp/cache-deps && mvn test package dependency:copy-dependencies -Dmaven.repo.local=/usr/share/maven/ref/repository -Dmdep.prependGroupId=true -DoutputDirectory=target
+set -x
+set -e
+
+if [ -n "$FN_REPO_URL" ]; then
+  REPO_DFN="-Dfn.repo.url=$FN_REPO_URL"
+fi
+
+
+cd /tmp/cache-deps && mvn test package dependency:copy-dependencies -Dmaven.repo.local=/usr/share/maven/ref/repository -Dmdep.prependGroupId=true -DoutputDirectory=target $REPO_DFN
 cd / && rm -fr /tmp/cache-deps

build-image/docker-build.sh

@@ -3,5 +3,10 @@
 cd /tmp/staging-repository && python -mSimpleHTTPServer 18080 1>>/tmp/http-logs 2>&1 &
 SRV_PROCESS=$!
 
-docker build $*
+if [ -n "$DOCKER_LOCALHOST" ]; then
+  REPO_ENV="--build-arg FN_REPO_URL=http://$DOCKER_LOCALHOST:18080"
+fi
+
+docker build $REPO_ENV $*
+
 kill $SRV_PROCESS

build-image/pom.xml

@@ -8,6 +8,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <fnproject.version>1.0.0-SNAPSHOT</fnproject.version>
+        <fn.repo.url>http://172.17.0.1:18080</fn.repo.url>
     </properties>
 
     <!-- The artifact is irrelevant, this pom is only used to download dependencies. -->
@@ -64,7 +65,7 @@
     <repositories>
         <repository>
             <id>fn-maven-releases</id>
-            <url>http://172.17.0.1:18080</url>
+            <url>${fn.repo.url}</url>
         </repository>
     </repositories>
 </project>

examples/README.md

@@ -34,3 +34,6 @@ access to data entering the `fn` Java FDK.
 This example showcases the Fn Flow asynchronous execution API, by
 creating a workflow that takes an image and asynchronously generates three
 thumbnails for it, then uploads them to an object storage.
+
+## 5. Gradle build 
+This shows how to use Gradle to build functions using the Java FDK. 

examples/gradle-build/.dockerignore

@@ -0,0 +1,4 @@
+.gradle
+.idea
+.git
+build

examples/gradle-build/Dockerfile

@@ -0,0 +1,20 @@
+FROM gradle:4.5.1-jdk8 as build-stage
+WORKDIR /function
+# needed for gradle?
+USER root
+ENV GRADLE_USER_HOME /function/.gradle
+
+# Code build
+# Copy any build files into the build container and build
+COPY *.gradle /function/
+RUN ["gradle", "-s", "--no-daemon","--console","plain","cacheDeps"]
+
+# Copies build source into build container
+COPY src /function/src
+
+RUN ["gradle", "-s", "--no-daemon","--console","plain","build"]
+# Container build
+FROM fnproject/fn-java-fdk:1.0.56
+WORKDIR /function
+COPY --from=build-stage /function/build/libs/*.jar /function/build/deps/*.jar /function/app/
+CMD ["com.example.fn.HelloFunction::handleRequest"]

examples/gradle-build/README.md

@@ -0,0 +1,14 @@
+# Fn Gradle + Java fdk example 
+
+Fn uses Maven by default for  builds. This is an example that uses Fn's `docker` runtime format to build a Java function using the [Fn Java FDK](https://github.com/fnproject/fdk-java).
+
+The example consists of a `Dockerfile` that builds the function using gradle and copies the function's dependencies to `build/deps` and a func.yaml that uses that `Dockerfile` to build the function.
+
+Note that FDK versions are hard-coded in this example, you may need to update them manually to more recent version. 
+
+Key points:
+
+* [Dockerfile](Dockerfile) - contains the containerised docker build (based on dockerhub library/gradle images) and image build - this includes the gradle invocation
+* The `cacheDeps` task in `build.gradle` is invoked within the Dockerfile - The task pulls down dependencies into the container gradle cache to speed up docker builds. 
+* The `copyDeps` task in `build.gradle` copies the functions compile deps 
+* This uses JDK 8 by default  - you can change this to Java 9 by changing :  `FROM gradle:4.5.1-jdk8 as build-stage` to `FROM gradle:4.5.1-jdk9 as build-stage` and  `FROM fnproject/fn-java-fdk:1.0.56` to `FROM fnproject/fn-java-fdk:jdk9-1.0.56` 

examples/gradle-build/build.gradle

@@ -0,0 +1,32 @@
+apply plugin: 'java'
+
+ext {
+   fdkVersion = '1.0.56'
+}
+
+repositories {
+    mavenCentral()
+    maven {
+        url 'https://dl.bintray.com/fnproject/fnproject'
+    }
+}
+
+dependencies {
+    runtime "com.fnproject.fn:api:$fdkVersion"
+    // runtime "com.fnproject.fn:runtime:$fdkVersion" // this is optional and included with its deps in the base image to reduce layer size
+
+    testCompile "junit:junit:4.12"
+    testCompile "com.fnproject.fn:testing:$fdkVersion"
+}
+
+task cacheDeps(type: Exec) {
+    configurations.testRuntime.files
+    commandLine 'echo', 'Downloaded all dependencies'
+}
+
+task copyDeps(type: Copy) {
+  from configurations.compile
+  into "${project.buildDir}/deps"
+}
+
+build.dependsOn copyDeps

examples/gradle-build/func.yaml

@@ -0,0 +1,4 @@
+name: gradle_build
+version: 0.0.3
+runtime: docker
+format: http

examples/gradle-build/src/main/java/com/example/fn/HelloFunction.java

@@ -0,0 +1,10 @@
+package com.example.fn;
+
+public class HelloFunction {
+
+    public String handleRequest(String input) {
+        String name = (input == null || input.isEmpty()) ? "world"  : input;
+        return "Hello, " + name + "!";
+    }
+
+}

examples/gradle-build/src/test/java/com/example/fn/HelloFunctionTest.java

@@ -0,0 +1,22 @@
+package com.example.fn;
+
+import com.fnproject.fn.testing.*;
+import org.junit.*;
+
+import static org.junit.Assert.*;
+
+public class HelloFunctionTest {
+
+    @Rule
+    public final FnTestingRule testing = FnTestingRule.createDefault();
+
+    @Test
+    public void shouldReturnGreeting() {
+        testing.givenEvent().enqueue();
+        testing.thenRun(HelloFunction.class, "handleRequest");
+
+        FnResult result = testing.getOnlyResult();
+        assertEquals("Hello, world!", result.getBodyAsString());
+    }
+
+}

integration-tests/README.md

@@ -33,19 +33,21 @@ To run locally you will need to deploy the fn artifacts to a local repository:
 (in top-level dir)
 ```bash
 export REPOSITORY_LOCATION=/tmp/staging-repository
+# on OSX: 
+export DOCKER_LOCALHOST=docker.for.mac.localhost 
 
 mvn deploy -DaltDeploymentRepository=localStagingDir::default::file://"$REPOSITORY_LOCATION"
 ```
 
 You may also want to/need build local copies of the build images: 
 ```bash 
-cd build-images
+cd build-image
 ./docker-build.sh -t fnproject/fn-java-fdk-build .
-./docker-build.sh -f Dockerfile-jdk9 -t fnproject/fn-java-fdk-build:jdk9-latest .
 ```
 
 and runtime images: 
 ```
+cd runtime
 docker build -t fnproject/fn-java-fdk .
 docker build -f Dockerfile-jdk9 -t fnproject/fn-java-fdk:jdk9-latest .
 ```

integration-tests/main/test-1-jdk8/func.yaml

@@ -3,3 +3,4 @@ runtime: java8
 cmd: com.fnproject.fn.integration.test_1.CompleterFunction::handleRequest
 format: http
 timeout: 120
+name: test-1-jdk8

integration-tests/main/test-1/func.yaml

@@ -1,4 +1,5 @@
-version: 0.0.1
+name: test-1
+version: 0.0.5
 runtime: java
 cmd: com.fnproject.fn.integration.test_1.CompleterFunction::handleRequest
 format: http

integration-tests/main/test-2/func.yaml

@@ -1,4 +1,4 @@
-name: fn-test/test-2
+name: test-2
 version: 0.0.1
 runtime: java9
 cmd: com.fnproject.fn.integration.test2.PlainFunction::handleRequest

integration-tests/main/test-4/func.yaml

@@ -6,3 +6,4 @@ build:
   -Dmdep.prependGroupId=true -DoutputDirectory=target
 format: http
 timeout: 120
+name: test-4

integration-tests/main/test-5/func.yaml

@@ -3,3 +3,4 @@ runtime: java9
 cmd: com.fnproject.fn.integration.test_5.CompleterFunction::handleRequest
 format: http
 timeout: 120
+name: test-5

integration-tests/main/test-6/func.yaml

@@ -3,3 +3,4 @@ runtime: java9
 cmd: com.fnproject.fn.integration.test_6.CompleterFunction::handleRequest
 format: http
 timeout: 120
+name: test-6

integration-tests/run-local.sh

@@ -47,7 +47,7 @@ docker pull $FUNCTIONS_DOCKER_IMAGE
 
 FUNCTIONS_CONTAINER_ID=$(
     docker run -d \
-        -p 8080 \
+        -p 8080:8080 \
         -v /var/run/docker.sock:/var/run/docker.sock \
         --name functions-$SUFFIX \
         -e FN_LOG_LEVEL=debug \

integration-tests/smoke-test.sh

@@ -35,7 +35,7 @@ fi
 
 [[ -n "$PRE_BUILD_HOOK" ]] && $PRE_BUILD_HOOK
 
-fn build --no-cache >build-output 2>&1 || {
+fn -v build --no-cache >build-output 2>&1 || {
     echo "Test function build failed:"
     cat build-output
     exit 1

release.version

@@ -1 +1 @@
-1.0.57
+1.0.60