diff --git a/.github/workflows/runtime-scala-testing.yml b/.github/workflows/runtime-scala-testing.yml new file mode 100644 index 0000000000..70c2ab3c66 --- /dev/null +++ b/.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 diff --git a/.gitignore b/.gitignore index a7bb0b3463..dcfa7e2c8c 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ java_runtime_node *.log # Local Netlify folder .netlify +.metals +.scala-build diff --git a/package.json b/package.json index 3e895bf582..8508bcdb3e 100644 --- a/package.json +++ b/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", diff --git a/test/runtime/runtime-scala.spec.ts b/test/runtime/runtime-scala.spec.ts new file mode 100644 index 0000000000..d2a782d377 --- /dev/null +++ b/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); +}); diff --git a/test/runtime/runtime-scala.ts b/test/runtime/runtime-scala.ts new file mode 100644 index 0000000000..36966b33b7 --- /dev/null +++ b/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' } +); diff --git a/test/runtime/runtime-scala/.gitignore b/test/runtime/runtime-scala/.gitignore new file mode 100644 index 0000000000..0bab4ea098 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/test/runtime/runtime-scala/README.md b/test/runtime/runtime-scala/README.md new file mode 100644 index 0000000000..49b29a7518 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/test/runtime/runtime-scala/bin/test/com/mycompany/app/generic/AddressSpec.scala b/test/runtime/runtime-scala/bin/test/com/mycompany/app/generic/AddressSpec.scala new file mode 100644 index 0000000000..4fb7c08b2c --- /dev/null +++ b/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 + } +} diff --git a/test/runtime/runtime-scala/build.gradle b/test/runtime/runtime-scala/build.gradle new file mode 100644 index 0000000000..4e5a06b22b --- /dev/null +++ b/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' +} diff --git a/test/runtime/runtime-scala/gradle/wrapper/gradle-wrapper.jar b/test/runtime/runtime-scala/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000..58499e4f0f Binary files /dev/null and b/test/runtime/runtime-scala/gradle/wrapper/gradle-wrapper.jar differ diff --git a/test/runtime/runtime-scala/gradle/wrapper/gradle-wrapper.properties b/test/runtime/runtime-scala/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000000..78c860b4db --- /dev/null +++ b/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 diff --git a/test/runtime/runtime-scala/gradlew b/test/runtime/runtime-scala/gradlew new file mode 100755 index 0000000000..9d9cdba713 --- /dev/null +++ b/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" "$@" diff --git a/test/runtime/runtime-scala/gradlew.bat b/test/runtime/runtime-scala/gradlew.bat new file mode 100644 index 0000000000..e95643d6a2 --- /dev/null +++ b/test/runtime/runtime-scala/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/test/runtime/runtime-scala/settings.gradle b/test/runtime/runtime-scala/settings.gradle new file mode 100644 index 0000000000..a56c6bd55e --- /dev/null +++ b/test/runtime/runtime-scala/settings.gradle @@ -0,0 +1,18 @@ +/* + * This settings file was generated by the Gradle 'init' task. + * + * The settings file is used to specify which projects to include in your build. + * In a single project build this file can be empty or even removed. + * + * Detailed information about configuring a multi-project build in Gradle can be found + * in the user guide at https://docs.gradle.org/4.4.1/userguide/multi_project_builds.html + */ + +/* +// To declare projects as part of a multi-project build use the 'include' method +include 'shared' +include 'api' +include 'services:webservice' +*/ + +rootProject.name = 'runtime-scala' diff --git a/test/runtime/runtime-scala/src/test/scala/com/mycompany/app/generic/AddressSpec.scala b/test/runtime/runtime-scala/src/test/scala/com/mycompany/app/generic/AddressSpec.scala new file mode 100644 index 0000000000..815e0df40b --- /dev/null +++ b/test/runtime/runtime-scala/src/test/scala/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 { + it 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(Some("test"), None)), + additionalProperties = None + ) + + address.nestedObject.get.additionalProperties shouldBe None + } +}