chore: add Scala runtime tests (#1752)

Co-authored-by: Artur Ciocanu <[email protected]>

.github/workflows/runtime-scala-testing.yml

@@ -0,0 +1,38 @@
+name: Runtime testing Scala models
+
+on:
+  push:
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review]
+    paths:
+      - 'src/generators/scala/**'
+      - 'test/runtime/runtime-scala/**'
+      - 'test/runtime/**scala**'
+
+jobs:
+  test:
+    name: Runtime testing Scala Models
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Check package-lock version
+        uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master
+        id: lockversion
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "${{ steps.lockversion.outputs.version }}"
+          cache: 'npm'
+          cache-dependency-path: '**/package-lock.json'
+      - name: Build library
+        run: npm install && npm run build:prod
+      - name: Setup Java
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt'
+          java-version: '11'
+      - name: Generate Scala models
+        run: npm run generate:runtime:scala
+      - name: Run runtime tests
+        run: npm run test:runtime:scala

.gitignore

@@ -10,3 +10,5 @@ java_runtime_node
 *.log
 # Local Netlify folder
 .netlify
+.metals
+.scala-build

package.json

@@ -117,6 +117,8 @@
     "generate:runtime:typescript": "cross-env CI=true ts-node ./test/runtime/runtime-typescript.ts",
     "test:runtime:csharp": "cross-env CI=true jest ./test/runtime/runtime-csharp.spec.ts",
     "generate:runtime:csharp": "cross-env CI=true ts-node ./test/runtime/runtime-csharp.ts",
+    "test:runtime:scala": "cross-env CI=true jest ./test/runtime/runtime-scala.spec.ts",
+    "generate:runtime:scala": "cross-env CI=true ts-node ./test/runtime/runtime-scala.ts",
     "test:watch": "jest --watch",
     "docs": "npm run docs:api",
     "docs:api": "typedoc src/index.ts --out ./modelina-website/public/apidocs/generated --name Modelina",

test/runtime/runtime-scala.spec.ts

@@ -0,0 +1,19 @@
+import { execCommand } from '../blackbox/utils/Utils';
+import path from 'path';
+
+jest.setTimeout(50000);
+
+test('Scala runtime testing', async () => {
+  //The 'build' command here
+  const buildCommand = `cd ${path.resolve(
+    __dirname,
+    './runtime-scala'
+  )} && ./gradlew build`;
+  await execCommand(buildCommand);
+  //The 'test' command here
+  const testCommand = `cd ${path.resolve(
+    __dirname,
+    './runtime-scala'
+  )} && ./gradlew test`;
+  await execCommand(testCommand);
+});

test/runtime/runtime-scala.ts

@@ -0,0 +1,17 @@
+import { SCALA_DEFAULT_PRESET, ScalaFileGenerator } from '../..';
+import path from 'path';
+import input from './generic-input.json';
+
+const generator = new ScalaFileGenerator({
+  presets: [SCALA_DEFAULT_PRESET]
+});
+
+generator.generateToFiles(
+  input,
+  path.resolve(
+    // eslint-disable-next-line no-undef
+    __dirname,
+    './runtime-scala/src/main/scala/com/mycompany/app/generic'
+  ),
+  { packageName: 'com.mycompany.app.generic' }
+);

test/runtime/runtime-scala/.gitignore

@@ -0,0 +1,25 @@
+# Gradle-specific files
+.gradle
+**/build/
+!src/**/build/
+
+# Generated Src files
+src/main/
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Avoid ignore Gradle wrappper properties
+!gradle-wrapper.properties
+
+# Cache of project
+.gradletasknamecache
+
+# Eclipse Gradle plugin generated files
+# Eclipse Core
+.project
+# JDT-specific (Eclipse Java Development Tools)
+.classpath

test/runtime/runtime-scala/README.md

@@ -0,0 +1,8 @@
+# Modelina Scala Runtime project
+
+This is the Modelina Scala runtime project that is used to test the Scala-generated code from Modelina at runtime to ensure that everything works as expected.
+
+Here is how it works:
+- The models are first generated during the build phase of the project, by running the root npm script `npm run generate:runtime:scala`. These models are pre-defined with the [generic input](../generic-input.json).
+- The tests are manually added and changed.
+- When the project is tested, it tests the generated models at runtime for semantic errors.

test/runtime/runtime-scala/bin/test/com/mycompany/app/generic/AddressSpec.scala

@@ -0,0 +1,20 @@
+package com.mycompany.app.generic
+
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
+
+class AddressSpec extends AnyFlatSpec with Matchers {
+  "should generate model with the right fields" in {
+    val address = Address(
+      streetName = "Test address 2",
+      houseNumber = 2,
+      marriage = Some(true),
+      members = Some(2),
+      arrayType = List(2, "test"),
+      nestedObject = Some(NestedObject("test", None))
+      additionalProperties = None
+    )
+
+    address.nestedObject.get.additionalProperties shouldBe None
+  }
+}

test/runtime/runtime-scala/build.gradle

@@ -0,0 +1,12 @@
+plugins {
+    id 'scala'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation 'org.scala-lang:scala-library:2.12.14'
+    testImplementation 'org.scalatest:scalatest_2.12:3.2.9'
+}

test/runtime/runtime-scala/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStorePath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME

test/runtime/runtime-scala/gradlew

@@ -0,0 +1,172 @@
+#!/usr/bin/env sh
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+    echo "$*"
+}
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+  NONSTOP* )
+    nonstop=true
+    ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+    JAVACMD=`cygpath --unix "$JAVACMD"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Escape application args
+save () {
+    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+    echo " "
+}
+APP_ARGS=$(save "$@")
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS --illegal-access=permit $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
+if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
+  cd "$(dirname "$0")"
+fi
+
+exec "$JAVACMD" "$@"