Issues/216 - Import e2e cucumber tests into casper-java-sdk

.github/workflows/gradle.yml

@@ -1,6 +1,5 @@
-# This workflow will build a Java project with Gradle
+# This workflow will build a Java project with Gradle and run e2e cucumber tests
 # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
-
 name: Java CI with Gradle
 
 on:
@@ -15,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     services:
       nctl:
-        image: stormeye2000/cspr-nctl:1.5
+        image: stormeye2000/cspr-nctl:linux-1.5.2
         options: --name cspr-nctl
         env:
           PREDEFINED_ACCOUNTS: 'true'
@@ -36,6 +35,8 @@ jobs:
 
       - name: Checkout code
         uses: actions/checkout@v2
+        with:
+          submodules: recursive
 
       - name: Set up JDK 11
         uses: actions/setup-java@v2
@@ -49,12 +50,15 @@ jobs:
       # Copy the assets from the NCTL docker image and build
       - name: Build and test with Gradle
         run: |
-          cd sh && chmod +x docker-copy-assets.sh && ./docker-copy-assets.sh && cd ..
+          cd script && chmod +x docker-copy-assets && ./docker-copy-assets && cd ..
           ./gradlew clean build
 
       - name: Export project version
         run: echo "PROJECT_VERSION=$(./gradlew properties -q | grep "version:" | awk '{print $2}')" >> $GITHUB_ENV
 
+      - name: Export Cspr Node Version
+        run: echo "CSRP_NODE_VERSION=$(./gradlew properties -q | grep "csprNodeVersion:" | awk '{print $2}')" >> $GITHUB_ENV
+
       - name: Generate Javadoc
         run: ./gradlew javadoc
 
@@ -74,6 +78,11 @@ jobs:
           folder: build/reports/jacoco
           target-folder: docs/latest/jacoco
 
+      # Runs all the e2e cucumber tests against the docker container cspr-nctl
+      - name: e2e tests
+        run: ./script/e2e-test
+        continue-on-error: true
+
       - name: Deploy to GitHub Pages
         uses: JamesIves/[email protected]
         with:
@@ -106,4 +115,8 @@ jobs:
           folder: build/docs/javadoc
           target-folder: docs/${{ env.PROJECT_VERSION }}/javadoc
 
-
+      - name: Publish e2e tests
+        uses: deblockt/[email protected]
+        with:
+          access-token: ${{ secrets.GITHUB_TOKEN }}
+          path: "**/cucumber-report.json"

.gitignore

@@ -38,3 +38,5 @@ out/
 .vscode/*
 !.vscode/tasks.json
 !.vscode/launch.json
+/assets/
+/reports/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "cspr-standard-tests-resources"]
+	path = cspr-standard-tests-resources
+	url = [email protected]:stormeye2000/cspr-standard-tests-resources.git

build.gradle

@@ -14,12 +14,12 @@ apply plugin: 'java'
 
 group = 'network.casper'
 // Version number update for release
-version='2.4.1'
+version = '2.4.1'
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 
 repositories {
-	mavenCentral()
+    mavenCentral()
     maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots' }
 }
 
@@ -50,6 +50,18 @@ dependencies {
     testImplementation "org.junit.jupiter:junit-jupiter:${jupiterVersion}"
     // Used to compare json strings while testing
     testImplementation "org.skyscreamer:jsonassert:${jsonassertVersion}"
+    // Use for e2e cucumber testing against a node
+    testImplementation "io.cucumber:cucumber-java:${cucumberVersion}"
+    // Path to assests used by e2e testing
+    testImplementation files('assets')
+    // path to features and other standard test resources from git submodule
+    testImplementation files('cspr-standard-tests-resources')
+}
+
+configurations {
+    cucumberRuntime {
+        extendsFrom testImplementation
+    }
 }
 
 java {
@@ -89,9 +101,9 @@ test {
         //showStandardStreams true
         // set options for log level LIFECYCLE
         events TestLogEvent.FAILED,
-               TestLogEvent.PASSED,
-               TestLogEvent.SKIPPED
-               //TestLogEvent.STANDARD_OUT
+                TestLogEvent.PASSED,
+                TestLogEvent.SKIPPED
+        //TestLogEvent.STANDARD_OUT
         exceptionFormat TestExceptionFormat.FULL
         showExceptions true
         showCauses true
@@ -100,11 +112,11 @@ test {
         // set options for log level DEBUG and INFO
         debug {
             events TestLogEvent.STARTED,
-                   TestLogEvent.FAILED,
-                   TestLogEvent.PASSED,
-                   TestLogEvent.SKIPPED,
-                   TestLogEvent.STANDARD_ERROR
-                   TestLogEvent.STANDARD_OUT
+                    TestLogEvent.FAILED,
+                    TestLogEvent.PASSED,
+                    TestLogEvent.SKIPPED,
+                    TestLogEvent.STANDARD_ERROR
+            TestLogEvent.STANDARD_OUT
             exceptionFormat TestExceptionFormat.FULL
         }
         //info.events = debug.events
@@ -121,6 +133,32 @@ test {
     }
 }
 
+task cucumberCli() {
+
+    ext.cucmmber_name = System.getProperty('cucumber.name')
+    if (ext.cucmmber_name == null) {
+        ext.cucmmber_name = ''
+    }
+    println 'ext.cucmmber_name=' + ext.cucmmber_name;
+
+    dependsOn assemble, testClasses
+    doLast {
+        javaexec {
+            main = "io.cucumber.core.cli.Main"
+            classpath = configurations.cucumberRuntime + sourceSets.main.output + sourceSets.test.output
+            args = [
+                    '--plugin', 'pretty',
+                    '--plugin', 'html:build/reports/e2e/cucumber-report.html',
+                    '--plugin', 'junit:build/reports/e2e/cucumber-report.xml',
+                    '--plugin', 'json:build/reports/e2e/cucumber-report.json',
+                    '--glue', 'com.stormeye.evaluation',
+                    '--glue', 'com.casper.sdk',
+                    '--name', ext.cucmmber_name,
+                    'cspr-standard-tests-resources/features']
+        }
+    }
+}
+
 jacocoTestReport {
     dependsOn test
 

gradle.properties

@@ -1,5 +1,6 @@
 sbs4jVersion=0.1.8
 commonsIoVersion=2.11.0
+cucumberVersion=7.11.1
 cryptokeyVersion=0.4.0
 cxfRtRsSseVersion=3.5.5
 lombokPluginVersion=6.2.0

script/README.md

@@ -0,0 +1,39 @@
+# Scripts
+This readme describes the usage of scripts in this folder.
+## bootstrap
+The bootstrap script fetches the lasted from the 'cspr-standard-test-resources' git submodule that contains the e2e 
+cucumber features and associated test resources.
+
+## docker-bash
+Opens a bash terminal to the cspr-nctl docker container
+
+## docker-copy-assets
+Copies the required assent such a account key pairs from a running casper-nctl docker container
+
+## docker-run
+Runs the casper-nctl docker container
+
+## docker-stop
+Stops a running casper-nctl docker container
+
+## e2e-remote-debug
+Remote debugs one or more cucumber e2e tests, the 1st parameter is the cucumber name regex eg:
+
+```./script/e2e-remote-debug info_get_peers```
+
+The above example will start the JVM in debug mode and only execute the info_get_peers scenario.
+
+## e2e-test
+Executes the cucumber e2e tests against a docker instance. To run tests filtered by regex use the following:
+
+```./script/e2e-test -Dcucumber.name=info_get_status```
+
+where info_get_status is the pattern to filter on
+
+## remote-test-resources
+Deletes the git submodule 'cspr-standard-test-resources'. 
+
+**IMPORTANT NOTE**: DO NOT RUN UNLESS YOU REALLY WANT TO DELETE SUBMODULES
+
+## test
+Executes the JUnit tests

script/bootstrap

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+cd "$(dirname "$0")" || exit
+echo "Bootstrap installs all dependencies."
+
+echo "Installing features from [email protected]:stormeye2000/cspr-standard-tests-resources.git"
+
+if [ -d "../cspr-standard-test-resources" ]
+then
+    echo "cspr-standard-test-resources exists fetching submodules."
+    git submodule update --init --recursive
+else
+    echo "Cloning cspr-standard-test-resources as submodule."
+    git submodule add [email protected]:stormeye2000/cspr-standard-tests-resources.git ../cspr-standard-tests-resources
+fi

script/docker-bash

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+# opens a bash shell against the casper nctl docker container
+docker exec -it cspr-nctl bash

script/docker-copy-assets

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+BASEDIR=$(builtin cd .. || exit 1; pwd)
+# clear the assets folder
+rm -rf  "${BASEDIR}/assets"
+mkdir "${BASEDIR}/assets"
+# copy net-1 users
+docker cp cspr-nctl:/home/casper/casper-node/utils/nctl/assets/net-1/users "${BASEDIR}/assets/net-1"
+# copy net-1 chainspec
+docker cp cspr-nctl:/home/casper/casper-node/utils/nctl/assets/net-1/chainspec "${BASEDIR}/assets/net-1"
+# copy faucet keys
+docker cp cspr-nctl:/home/casper/casper-node/utils/nctl/assets/net-1/faucet "${BASEDIR}/assets/net-1"

script/docker-run

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+# run the cspr-nctl container in docker
+docker run --rm -it --name cspr-nctl -d -p 25101:25101 -p 11101:11101 -p 14101:14101 -p 18101:18101 stormeye2000/cspr-nctl:linux-1.5.2

script/docker-stop

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+# stop the cspr-nctl docker container
+docker stop cspr-nctl

script/e2e-remote-debug

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# remote debugs one or more cucumber e2e tests, the 1st parameter is the cucumber name regex eg:
+# ./script/e2e-remote-debug info_get_peers
+# The above example will start the JVM in debug mode and only execute the info_get_peers scenario.
+
+cd "$(dirname "$0")/.."|| exit 1
+./gradlew --stop
+./gradlew cucumber -Dorg.gradle.jvmargs='-Xdebug -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005;' -Dcucumber.name="${1}" --no-daemon

script/e2e-test

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+# executes the cucumber e2e tests against a docker instance
+cd "$(dirname "$0")/.." || exit 1
+# to run tests filtered by regex use the following:
+# ./script/e2e-test -Dcucumber.name=info_get_status
+# where info_get_status is the pattern to filter on
+./gradlew cucumber "$@"

script/remove-test-resources

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+cd "$(dirname "$0")" || exit
+cd ..
+echo "Removes all test resources git submodules."
+git submodule deinit -f cspr-standard-tests-resources
+rm -rf .git/modules/cspr-standard-tests-resources
+git rm -f cspr-standard-tests-resources
+rm .gitmodules

script/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+# executes the JUnit tests. To execute the cucumber test use the e2e-test script
+cd "$(dirname "$0")/.." || exit 1
+./gradlew test "$@"
+

src/main/java/com/casper/sdk/service/impl/event/EventServiceImpl.java

@@ -56,7 +56,7 @@ public <EventT extends Event<?>> AutoCloseable consumeEvents(final EventType eve
                                                                  final Consumer<Throwable> onFailure) {
 
         final URL url = urlBuilder.buildUrl(uri, eventType, startFrom);
-        logger.info("Targeting SSE URL {}", url);
+        logger.debug("Targeting SSE URL {}", url);
         final WebTarget target = sssClient.target(url.toString());
         final Response response = target.request("text/plain", "text/event-stream").get();
         final EventBuilder eventBuilder = new EventBuilder(eventType, eventTarget, target.getUri().toString());
@@ -73,7 +73,7 @@ public <EventT extends Event<?>> AutoCloseable consumeEvents(final EventType eve
                 }
             }
         }, throwable -> {
-            logger.error("SSE Event Error on {}", url, throwable);
+            logger.debug("SSE Event Error on {}", url, throwable);
             onFailure.accept(throwable);
         });
 

src/test/java/com/casper/sdk/e2e/event/EventHandler.java

@@ -0,0 +1,69 @@
+package com.casper.sdk.e2e.event;
+
+import com.casper.sdk.e2e.matcher.MatcherMap;
+import com.casper.sdk.e2e.utils.CasperClientProvider;
+import com.casper.sdk.model.event.Event;
+import com.casper.sdk.model.event.EventTarget;
+import com.casper.sdk.model.event.EventType;
+import org.hamcrest.Matcher;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.ArrayList;
+import java.util.List;
+
+
+/**
+ * Helper class for consuming and matching events.
+ *
+ * @author [email protected]
+ */
+public class EventHandler {
+
+    private final Logger logger = LoggerFactory.getLogger(EventHandler.class);
+    private final MatcherMap matcherMap = new MatcherMap();
+    private final List<AutoCloseable> sseSources = new ArrayList<>();
+
+    public EventHandler(final EventTarget eventTarget) {
+        consume(EventType.DEPLOYS, eventTarget);
+        consume(EventType.MAIN, eventTarget);
+        consume(EventType.SIGS, eventTarget);
+    }
+
+    public void close() {
+
+        for (AutoCloseable sseSource : sseSources) {
+            try {
+                sseSource.close();
+            } catch (Exception e) {
+                logger.error("Error closing SSE Source", e);
+            }
+        }
+    }
+
+    private void consume(final EventType eventType, final EventTarget eventTarget) {
+
+        logger.info("Got {} event {}", eventType, eventTarget);
+        sseSources.add(
+                CasperClientProvider.getInstance().getEventService().consumeEvents(
+                        eventType,
+                        eventTarget, null,
+                        this::handleMatchers,
+                        throwable -> logger.error("Error processing SSE event", throwable)
+                )
+        );
+    }
+
+    public <T> Matcher<T> addEventMatcher(final EventType eventType, final Matcher<T> matcher) {
+        matcherMap.addEventMatcher(eventType, matcher);
+        return matcher;
+    }
+
+    private void handleMatchers(Event<?> event) {
+        matcherMap.handleEvent(event);
+    }
+
+    public <T> void removeEventMatcher(final EventType eventType, final Matcher<T> matcher) {
+        matcherMap.removeEventMatcher(eventType, matcher);
+    }
+}