Skip to content

Commit f70a97e

Browse files
artur-ciocanuArtur Ciocanu
artur-ciocanu
and
Artur Ciocanu
authored
chore: add Scala runtime tests (#1752)
Co-authored-by: Artur Ciocanu <[email protected]>
1 parent 758e3e7 commit f70a97e

File tree

15 files changed

+442
-0
lines changed

15 files changed

+442
-0
lines changed

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

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Runtime testing Scala models
2+
3+
on:
4+
push:
5+
pull_request:
6+
types: [opened, reopened, synchronize, ready_for_review]
7+
paths:
8+
- 'src/generators/scala/**'
9+
- 'test/runtime/runtime-scala/**'
10+
- 'test/runtime/**scala**'
11+
12+
jobs:
13+
test:
14+
name: Runtime testing Scala Models
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout repository
18+
uses: actions/checkout@v3
19+
- name: Check package-lock version
20+
uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master
21+
id: lockversion
22+
- name: Setup Node.js
23+
uses: actions/setup-node@v3
24+
with:
25+
node-version: "${{ steps.lockversion.outputs.version }}"
26+
cache: 'npm'
27+
cache-dependency-path: '**/package-lock.json'
28+
- name: Build library
29+
run: npm install && npm run build:prod
30+
- name: Setup Java
31+
uses: actions/setup-java@v2
32+
with:
33+
distribution: 'adopt'
34+
java-version: '11'
35+
- name: Generate Scala models
36+
run: npm run generate:runtime:scala
37+
- name: Run runtime tests
38+
run: npm run test:runtime:scala

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@ java_runtime_node
1010
*.log
1111
# Local Netlify folder
1212
.netlify
13+
.metals
14+
.scala-build

‎package.json

+2
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@
117117
"generate:runtime:typescript": "cross-env CI=true ts-node ./test/runtime/runtime-typescript.ts",
118118
"test:runtime:csharp": "cross-env CI=true jest ./test/runtime/runtime-csharp.spec.ts",
119119
"generate:runtime:csharp": "cross-env CI=true ts-node ./test/runtime/runtime-csharp.ts",
120+
"test:runtime:scala": "cross-env CI=true jest ./test/runtime/runtime-scala.spec.ts",
121+
"generate:runtime:scala": "cross-env CI=true ts-node ./test/runtime/runtime-scala.ts",
120122
"test:watch": "jest --watch",
121123
"docs": "npm run docs:api",
122124
"docs:api": "typedoc src/index.ts --out ./modelina-website/public/apidocs/generated --name Modelina",

‎test/runtime/runtime-scala.spec.ts

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
import { execCommand } from '../blackbox/utils/Utils';
2+
import path from 'path';
3+
4+
jest.setTimeout(50000);
5+
6+
test('Scala runtime testing', async () => {
7+
//The 'build' command here
8+
const buildCommand = `cd ${path.resolve(
9+
__dirname,
10+
'./runtime-scala'
11+
)} && ./gradlew build`;
12+
await execCommand(buildCommand);
13+
//The 'test' command here
14+
const testCommand = `cd ${path.resolve(
15+
__dirname,
16+
'./runtime-scala'
17+
)} && ./gradlew test`;
18+
await execCommand(testCommand);
19+
});

‎test/runtime/runtime-scala.ts

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import { SCALA_DEFAULT_PRESET, ScalaFileGenerator } from '../..';
2+
import path from 'path';
3+
import input from './generic-input.json';
4+
5+
const generator = new ScalaFileGenerator({
6+
presets: [SCALA_DEFAULT_PRESET]
7+
});
8+
9+
generator.generateToFiles(
10+
input,
11+
path.resolve(
12+
// eslint-disable-next-line no-undef
13+
__dirname,
14+
'./runtime-scala/src/main/scala/com/mycompany/app/generic'
15+
),
16+
{ packageName: 'com.mycompany.app.generic' }
17+
);

‎test/runtime/runtime-scala/.gitignore

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Gradle-specific files
2+
.gradle
3+
**/build/
4+
!src/**/build/
5+
6+
# Generated Src files
7+
src/main/
8+
9+
# Ignore Gradle GUI config
10+
gradle-app.setting
11+
12+
# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
13+
!gradle-wrapper.jar
14+
15+
# Avoid ignore Gradle wrappper properties
16+
!gradle-wrapper.properties
17+
18+
# Cache of project
19+
.gradletasknamecache
20+
21+
# Eclipse Gradle plugin generated files
22+
# Eclipse Core
23+
.project
24+
# JDT-specific (Eclipse Java Development Tools)
25+
.classpath

‎test/runtime/runtime-scala/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Modelina Scala Runtime project
2+
3+
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.
4+
5+
Here is how it works:
6+
- 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).
7+
- The tests are manually added and changed.
8+
- 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

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
package com.mycompany.app.generic
2+
3+
import org.scalatest.flatspec.AnyFlatSpec
4+
import org.scalatest.matchers.should.Matchers
5+
6+
class AddressSpec extends AnyFlatSpec with Matchers {
7+
"should generate model with the right fields" in {
8+
val address = Address(
9+
streetName = "Test address 2",
10+
houseNumber = 2,
11+
marriage = Some(true),
12+
members = Some(2),
13+
arrayType = List(2, "test"),
14+
nestedObject = Some(NestedObject("test", None))
15+
additionalProperties = None
16+
)
17+
18+
address.nestedObject.get.additionalProperties shouldBe None
19+
}
20+
}

‎test/runtime/runtime-scala/build.gradle

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
plugins {
2+
id 'scala'
3+
}
4+
5+
repositories {
6+
mavenCentral()
7+
}
8+
9+
dependencies {
10+
implementation 'org.scala-lang:scala-library:2.12.14'
11+
testImplementation 'org.scalatest:scalatest_2.12:3.2.9'
12+
}

‎test/runtime/runtime-scala/gradle/wrapper/gradle-wrapper.jar

54.3 KB
Binary file not shown.

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

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
2+
distributionBase=GRADLE_USER_HOME
3+
distributionPath=wrapper/dists
4+
zipStorePath=wrapper/dists
5+
zipStoreBase=GRADLE_USER_HOME

‎test/runtime/runtime-scala/gradlew

+172
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
#!/usr/bin/env sh
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Attempt to set APP_HOME
10+
# Resolve links: $0 may be a link
11+
PRG="$0"
12+
# Need this for relative symlinks.
13+
while [ -h "$PRG" ] ; do
14+
ls=`ls -ld "$PRG"`
15+
link=`expr "$ls" : '.*-> \(.*\)$'`
16+
if expr "$link" : '/.*' > /dev/null; then
17+
PRG="$link"
18+
else
19+
PRG=`dirname "$PRG"`"/$link"
20+
fi
21+
done
22+
SAVED="`pwd`"
23+
cd "`dirname \"$PRG\"`/" >/dev/null
24+
APP_HOME="`pwd -P`"
25+
cd "$SAVED" >/dev/null
26+
27+
APP_NAME="Gradle"
28+
APP_BASE_NAME=`basename "$0"`
29+
30+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31+
DEFAULT_JVM_OPTS=""
32+
33+
# Use the maximum available, or set MAX_FD != -1 to use that value.
34+
MAX_FD="maximum"
35+
36+
warn () {
37+
echo "$*"
38+
}
39+
40+
die () {
41+
echo
42+
echo "$*"
43+
echo
44+
exit 1
45+
}
46+
47+
# OS specific support (must be 'true' or 'false').
48+
cygwin=false
49+
msys=false
50+
darwin=false
51+
nonstop=false
52+
case "`uname`" in
53+
CYGWIN* )
54+
cygwin=true
55+
;;
56+
Darwin* )
57+
darwin=true
58+
;;
59+
MINGW* )
60+
msys=true
61+
;;
62+
NONSTOP* )
63+
nonstop=true
64+
;;
65+
esac
66+
67+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68+
69+
# Determine the Java command to use to start the JVM.
70+
if [ -n "$JAVA_HOME" ] ; then
71+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72+
# IBM's JDK on AIX uses strange locations for the executables
73+
JAVACMD="$JAVA_HOME/jre/sh/java"
74+
else
75+
JAVACMD="$JAVA_HOME/bin/java"
76+
fi
77+
if [ ! -x "$JAVACMD" ] ; then
78+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79+
80+
Please set the JAVA_HOME variable in your environment to match the
81+
location of your Java installation."
82+
fi
83+
else
84+
JAVACMD="java"
85+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86+
87+
Please set the JAVA_HOME variable in your environment to match the
88+
location of your Java installation."
89+
fi
90+
91+
# Increase the maximum file descriptors if we can.
92+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93+
MAX_FD_LIMIT=`ulimit -H -n`
94+
if [ $? -eq 0 ] ; then
95+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96+
MAX_FD="$MAX_FD_LIMIT"
97+
fi
98+
ulimit -n $MAX_FD
99+
if [ $? -ne 0 ] ; then
100+
warn "Could not set maximum file descriptor limit: $MAX_FD"
101+
fi
102+
else
103+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104+
fi
105+
fi
106+
107+
# For Darwin, add options to specify how the application appears in the dock
108+
if $darwin; then
109+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110+
fi
111+
112+
# For Cygwin, switch paths to Windows format before running java
113+
if $cygwin ; then
114+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116+
JAVACMD=`cygpath --unix "$JAVACMD"`
117+
118+
# We build the pattern for arguments to be converted via cygpath
119+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120+
SEP=""
121+
for dir in $ROOTDIRSRAW ; do
122+
ROOTDIRS="$ROOTDIRS$SEP$dir"
123+
SEP="|"
124+
done
125+
OURCYGPATTERN="(^($ROOTDIRS))"
126+
# Add a user-defined pattern to the cygpath arguments
127+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129+
fi
130+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
131+
i=0
132+
for arg in "$@" ; do
133+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135+
136+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138+
else
139+
eval `echo args$i`="\"$arg\""
140+
fi
141+
i=$((i+1))
142+
done
143+
case $i in
144+
(0) set -- ;;
145+
(1) set -- "$args0" ;;
146+
(2) set -- "$args0" "$args1" ;;
147+
(3) set -- "$args0" "$args1" "$args2" ;;
148+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154+
esac
155+
fi
156+
157+
# Escape application args
158+
save () {
159+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160+
echo " "
161+
}
162+
APP_ARGS=$(save "$@")
163+
164+
# Collect all arguments for the java command, following the shell quoting and substitution rules
165+
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"
166+
167+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169+
cd "$(dirname "$0")"
170+
fi
171+
172+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)