Merge branch 'main' into driver-api

.github/workflows/build.yml

@@ -2,9 +2,7 @@ name: build
 
 on:
   push:
-    branches: main
-    paths:
-     - '!RELEASENOTES.**'
+  pull_request:
 
 jobs:
   build:

docsys/pom.xml

@@ -5,6 +5,9 @@
     <packaging>jar</packaging>
     <name>docsys</name>
     <url>http://nosqlbench.io/</url>
+    <properties>
+        <jersey.version>3.0.2</jersey.version>
+    </properties>
 
     <parent>
         <artifactId>mvn-defaults</artifactId>
@@ -31,7 +34,7 @@
         <dependency>
             <groupId>org.eclipse.jetty</groupId>
             <artifactId>jetty-server</artifactId>
-            <version>11.0.1</version>
+            <version>11.0.3</version>
         </dependency>
         <dependency>
             <groupId>org.eclipse.jetty</groupId>
@@ -52,23 +55,23 @@
         <dependency>
             <groupId>org.glassfish.jersey.core</groupId>
             <artifactId>jersey-server</artifactId>
-            <version>3.0.1</version>
+            <version>${jersey.version}</version>
 
         </dependency>
         <dependency>
             <groupId>org.glassfish.jersey.core</groupId>
             <artifactId>jersey-common</artifactId>
-            <version>3.0.2</version>
+            <version>${jersey.version}</version>
         </dependency>
         <dependency>
             <groupId>org.glassfish.jersey.containers</groupId>
             <artifactId>jersey-container-jetty-servlet</artifactId>
-            <version>3.0.1</version>
+            <version>${jersey.version}</version>
         </dependency>
         <dependency>
             <groupId>org.glassfish.jersey.inject</groupId>
             <artifactId>jersey-hk2</artifactId>
-            <version>3.0.1</version>
+            <version>${jersey.version}</version>
         </dependency>
 
         <dependency>

driver-cql-shaded/pom.xml

@@ -70,7 +70,6 @@
         <dependency>
             <groupId>org.antlr</groupId>
             <artifactId>antlr4-runtime</artifactId>
-            <version>4.9.2</version>
         </dependency>
 
         <dependency>

driver-cqld3-shaded/pom.xml

@@ -66,7 +66,6 @@
         <dependency>
             <groupId>org.antlr</groupId>
             <artifactId>antlr4-runtime</artifactId>
-            <version>4.9.2</version>
         </dependency>
 
         <dependency>

driver-dsegraph-shaded/pom.xml

@@ -70,7 +70,6 @@
     <dependency>
       <groupId>org.antlr</groupId>
       <artifactId>antlr4-runtime</artifactId>
-      <version>4.9.2</version>
     </dependency>
 
     <!--        <dependency>-->

engine-rest/src/main/java/io/nosqlbench/engine/rest/resources/ScenarioExecutorEndpoint.java

@@ -64,6 +64,15 @@ public class ScenarioExecutorEndpoint implements WebServiceObject {
     }
 
 
+    /**
+     * Run a NoSQLBench command just as you would on the command line. Certain parameters are translated
+     * (virtualized) into the workspace view for you automatically. That is, any path which would otherwise
+     * be resolved on the local file system will now be resolved in that same way but with the designated workspace
+     * as the base directory. All filesystem interaction which would otherwise happen in the current working
+     * directory should also be done relative to the designated workspace.
+     * @param rq
+     * @return
+     */
     @POST
     @Path("cli")
     @Consumes(MediaType.APPLICATION_JSON)
@@ -95,7 +104,6 @@ public class ScenarioExecutorEndpoint implements WebServiceObject {
             }
         }
 
-
         args = substituteFilenames(rq, args);
         NBCLICommandParser.parse(args, cmdList, workspace.asIncludes());
         ScriptBuffer buffer = new BasicScriptBuffer();
@@ -193,6 +201,12 @@ public class ScenarioExecutorEndpoint implements WebServiceObject {
 //        return Response.created(scenarioUri).build();
 //    }
 
+    /**
+     * Return a view of a named scenario, just as with {@link #getScenarios()}}.
+     * If the named scenario is not present, an error will be returned instead.
+     * @param scenarioName
+     * @return
+     */
     @GET
     @Path("scenario/{scenarioName}")
     @Produces(MediaType.APPLICATION_JSON)
@@ -207,6 +221,11 @@ public class ScenarioExecutorEndpoint implements WebServiceObject {
         }
     }
 
+    /**
+     * @return a view of all the scenarios known to the scenarios executor, whether starting,
+     * running, errored or otherwise. If the scenario is completed, then the result,
+     * including the IO log will be provided, otherwise an exception to explain why it failed.
+     */
     @GET
     @Path("scenarios")
     @Produces(MediaType.APPLICATION_JSON)

mvn-defaults/pom.xml

@@ -13,6 +13,7 @@
 
     <!-- properties for package versions -->
     <ascii.data.version>1.2.0</ascii.data.version>
+    <antlr4.version>4.9.2</antlr4.version>
     <commons.codec.version>1.14</commons.codec.version>
     <commons.compress.version>1.20</commons.compress.version>
     <commons.csv.version>1.8</commons.csv.version>
@@ -270,7 +271,7 @@
       <dependency>
         <groupId>org.antlr</groupId>
         <artifactId>antlr4-runtime</artifactId>
-        <version>4.9.2</version>
+        <version>${antlr4.version}</version>
       </dependency>
 
       <dependency>
@@ -547,7 +548,7 @@
         <plugin>
           <groupId>org.antlr</groupId>
           <artifactId>antlr4-maven-plugin</artifactId>
-          <version>4.9.2</version>
+          <version>${antlr4.version}</version>
         </plugin>
         <plugin>
           <groupId>org.codehaus.mojo</groupId>

virtdata-lang/pom.xml

@@ -19,7 +19,6 @@
             <groupId>org.antlr</groupId>
             <artifactId>antlr4-runtime</artifactId>
         </dependency>
-
     </dependencies>
 
     <build>

virtdata-lib-realer/src/main/java/io/nosqlbench/virtdata/library/realer/CountryCodes.java

@@ -17,7 +17,7 @@ public class CountryCodes extends CSVSampler implements LongFunction<String> {
 
     @Example("CountryCodes()")
     public CountryCodes() {
-        super("COUNTRY_CODE","n/a","name","countries.csv");
+        super("COUNTRY_CODE","n/a","name","data/countries.csv");
     }
 
 }