Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/next release #294

Merged
merged 10 commits into from
Dec 1, 2024
Merged

Feature/next release #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5eef9be
refactor: leveraging FileUtils in FileReporter
giulong Nov 23, 2024
9a4d757
refactor: suppress unused warning on TestBookSessionListener
giulong Nov 23, 2024
50b07dd
refactor: make all singletons references not static
giulong Nov 23, 2024
8dead4c
misc: Versioning useful run configurations
giulong Nov 23, 2024
20f2d56
refactor: overloading FileUtils.write method to accept a string
giulong Nov 23, 2024
7c2e3f1
feature: Test events reporter
giulong Nov 30, 2024
cf458eb
build: versioning docs run configuration
giulong Nov 30, 2024
ead0c25
it: testing tests steps report is produced for dynamic tests as well
giulong Nov 30, 2024
789bb79
refactor: reading test-steps template leveraging fileUtils.readTemplate
giulong Nov 30, 2024
5d9be7e
docs: test steps consumer docs
giulong Dec 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .run/docs.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="docs" type="ShConfigurationType">
<option name="SCRIPT_TEXT" value="bundle install &amp;&amp; bundle exec jekyll serve --config _config.yml,_config_local.yml --open-url http://127.0.0.1:4000/spectrum/" />
<option name="INDEPENDENT_SCRIPT_PATH" value="true" />
<option name="SCRIPT_PATH" value="" />
<option name="SCRIPT_OPTIONS" value="" />
<option name="INDEPENDENT_SCRIPT_WORKING_DIRECTORY" value="true" />
<option name="SCRIPT_WORKING_DIRECTORY" value="$PROJECT_DIR$/docs" />
<option name="INDEPENDENT_INTERPRETER_PATH" value="true" />
<option name="INTERPRETER_PATH" value="/bin/zsh" />
<option name="INTERPRETER_OPTIONS" value="" />
<option name="EXECUTE_IN_TERMINAL" value="false" />
<option name="EXECUTE_SCRIPT_FILE" value="false" />
<envs />
<method v="2" />
</configuration>
</component>
21 changes: 21 additions & 0 deletions .run/it-appium.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="it-appium" type="JUnit" factoryName="JUnit">
<module name="it-appium" />
<extension name="coverage">
<pattern>
<option name="PATTERN" value="io.github.giulong.spectrum.it_appium.tests.*" />
<option name="ENABLED" value="true" />
</pattern>
</extension>
<option name="PACKAGE_NAME" value="io.github.giulong.spectrum.it_appium.tests" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED -Dspectrum.driver=uiAutomator2 -Dspectrum.log.level=INFO" />
<dir value="$PROJECT_DIR$/it-appium/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -ntp -P framework-onl" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/it-grid.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="it-grid" type="JUnit" factoryName="JUnit">
<module name="it-grid" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED" />
<dir value="$PROJECT_DIR$/it-grid/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/it-macos.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="it-macos" type="JUnit" factoryName="JUnit">
<module name="it-macos" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED" />
<dir value="$PROJECT_DIR$/it-macos/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/it-testbook.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="it-testbook" type="JUnit" factoryName="JUnit">
<module name="it-testbook" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED" />
<dir value="$PROJECT_DIR$/it-testbook/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/it.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="it" type="JUnit" factoryName="JUnit">
<module name="it" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED" />
<dir value="$PROJECT_DIR$/it/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/parallel it firefox.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="parallel it firefox" type="JUnit" factoryName="JUnit">
<module name="it" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED -Dspectrum.browser=firefox -Djunit.jupiter.execution.parallel.enabled=true -Djunit.jupiter.execution.parallel.mode.default=same_thread -Djunit.jupiter.execution.parallel.mode.classes.default=concurrent" />
<dir value="$PROJECT_DIR$/it/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/parallel it-appium.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="parallel it-appium" type="JUnit" factoryName="JUnit">
<module name="it-appium" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED -Djunit.jupiter.extensions.autodetection.enabled=true -Djunit.jupiter.execution.parallel.enabled=true -Djunit.jupiter.execution.parallel.mode.default=same_thread -Djunit.jupiter.execution.parallel.mode.classes.default=concurrent" />
<dir value="$PROJECT_DIR$/it-appium/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/parallel it-grid.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="parallel it-grid" type="JUnit" factoryName="JUnit">
<module name="it-grid" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED -Djunit.jupiter.extensions.autodetection.enabled=true -Djunit.jupiter.execution.parallel.enabled=true -Djunit.jupiter.execution.parallel.mode.default=same_thread -Djunit.jupiter.execution.parallel.mode.classes.default=concurrent" />
<dir value="$PROJECT_DIR$/it-grid/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/parallel it-macos.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="parallel it-macos" type="JUnit" factoryName="JUnit">
<module name="it-macos" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED -Djunit.jupiter.extensions.autodetection.enabled=true -Djunit.jupiter.execution.parallel.enabled=true -Djunit.jupiter.execution.parallel.mode.default=same_thread -Djunit.jupiter.execution.parallel.mode.classes.default=concurrent" />
<dir value="$PROJECT_DIR$/it-macos/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/parallel it-testbook.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="parallel it-testbook" type="JUnit" factoryName="JUnit">
<module name="it-testbook" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED -Djunit.jupiter.extensions.autodetection.enabled=true -Djunit.jupiter.execution.parallel.enabled=true -Djunit.jupiter.execution.parallel.mode.default=same_thread -Djunit.jupiter.execution.parallel.mode.classes.default=concurrent" />
<dir value="$PROJECT_DIR$/it-testbook/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
14 changes: 14 additions & 0 deletions .run/parallel it.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="parallel it" type="JUnit" factoryName="JUnit">
<module name="it" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="directory" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/sun.nio.fs=ALL-UNNAMED -Djunit.jupiter.extensions.autodetection.enabled=true -Djunit.jupiter.execution.parallel.enabled=true -Djunit.jupiter.execution.parallel.mode.default=same_thread -Djunit.jupiter.execution.parallel.mode.classes.default=concurrent" />
<dir value="$PROJECT_DIR$/it/src/test/java" />
<method v="2">
<option name="Make" enabled="true" />
<option name="Maven.BeforeRunTask" enabled="true" file="$PROJECT_DIR$/pom.xml" goal="install -DskipTests -DskipSign -Dmaven.plugin.validation=BRIEF -ntp -P framework-only" />
</method>
</configuration>
</component>
38 changes: 38 additions & 0 deletions .run/spectrum checkstyle.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="spectrum checkstyle" type="MavenRunConfiguration" factoryName="Maven">
<MavenSettings>
<option name="myGeneralSettings" />
<option name="myRunnerSettings" />
<option name="myRunnerParameters">
<MavenRunnerParameters>
<option name="cmdOptions" />
<option name="profiles">
<set />
</option>
<option name="goals">
<list>
<option value="checkstyle:checkstyle" />
<option value="-Dcheckstyle.config.location=checkstyle.xml" />
<option value="-DskipSign" />
<option value="-DskipTests" />
<option value="-ntp" />
<option value="-pl" />
<option value="spectrum" />
</list>
</option>
<option name="multimoduleDir" />
<option name="pomFileName" />
<option name="profilesMap">
<map />
</option>
<option name="projectsCmdOptionValues">
<list />
</option>
<option name="resolveToWorkspace" value="false" />
<option name="workingDirPath" value="$PROJECT_DIR$" />
</MavenRunnerParameters>
</option>
</MavenSettings>
<method v="2" />
</configuration>
</component>
37 changes: 37 additions & 0 deletions .run/spectrum framework-only.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="spectrum framework-only" type="MavenRunConfiguration" factoryName="Maven">
<MavenSettings>
<option name="myGeneralSettings" />
<option name="myRunnerSettings" />
<option name="myRunnerParameters">
<MavenRunnerParameters>
<option name="cmdOptions" />
<option name="profiles">
<set />
</option>
<option name="goals">
<list>
<option value="install" />
<option value="-DskipTests" />
<option value="-DskipSign" />
<option value="-ntp" />
<option value="-P" />
<option value="framework-only" />
</list>
</option>
<option name="multimoduleDir" />
<option name="pomFileName" />
<option name="profilesMap">
<map />
</option>
<option name="projectsCmdOptionValues">
<list />
</option>
<option name="resolveToWorkspace" value="false" />
<option name="workingDirPath" value="$PROJECT_DIR$" />
</MavenRunnerParameters>
</option>
</MavenSettings>
<method v="2" />
</configuration>
</component>
39 changes: 39 additions & 0 deletions .run/spectrum full build.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="spectrum full build" type="MavenRunConfiguration" factoryName="Maven">
<MavenSettings>
<option name="myGeneralSettings" />
<option name="myRunnerSettings" />
<option name="myRunnerParameters">
<MavenRunnerParameters>
<option name="cmdOptions" />
<option name="profiles">
<set />
</option>
<option name="goals">
<list>
<option value="clean" />
<option value="install" />
<option value="-DskipSign" />
<option value="-DbrowsersTests" />
<option value="-DappiumTests" />
<option value="-DmacosTests" />
<option value="-fae" />
<option value="-ntp" />
</list>
</option>
<option name="multimoduleDir" />
<option name="pomFileName" />
<option name="profilesMap">
<map />
</option>
<option name="projectsCmdOptionValues">
<list />
</option>
<option name="resolveToWorkspace" value="false" />
<option name="workingDirPath" value="$PROJECT_DIR$" />
</MavenRunnerParameters>
</option>
</MavenSettings>
<method v="2" />
</configuration>
</component>
13 changes: 13 additions & 0 deletions .run/unit tests.run.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="unit tests" type="JUnit" factoryName="JUnit">
<module name="spectrum" />
<option name="PACKAGE_NAME" value="" />
<option name="MAIN_CLASS_NAME" value="" />
<option name="METHOD_NAME" value="" />
<option name="TEST_OBJECT" value="package" />
<option name="VM_PARAMETERS" value="-ea --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED -Djunit.jupiter.extensions.autodetection.enabled=true" />
<method v="2">
<option name="Make" enabled="true" />
</method>
</configuration>
</component>
11 changes: 9 additions & 2 deletions DEV.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ To avoid manual operations, at the end of the full build, the `cleanup` module w
You can leverage the [Maven wrapper](https://maven.apache.org/wrapper/) bundled in this repo.
Below you can see how to build the entire project or just few submodules.

> ⚠️ Run configurations<br/>
> IntelliJ run configurations are versioned in the [.run](.run) folder. If you use IntelliJ IDEA,
> they're imported automatically, meaning you can already leverage a set of useful configurations
> to build the framework and to run unit and integration tests for each module.

## Full build

This is how to trigger the full build:
Expand Down Expand Up @@ -151,5 +156,7 @@ To be able to run it locally so to make and review your changes before pushing t

1. Setup your local environment as explained
in [Testing your GitHub Pages site locally with Jekyll](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll)
2. Run Jekyll under the `docs` folder with `cd docs && bundle exec jekyll serve --config _config.yml,_config_local.yml`
3. Browse the docs at http://127.0.0.1:4000/spectrum/
2. Run Jekyll under the `docs` folder with `cd docs && bundle install && bundle exec jekyll serve --config _config.yml,_config_local.yml --open-url http://127.0.0.1:4000/spectrum/`

> 💡 **Tip**<br/>
> You can leverage the [docs](.run/docs.run.xml) run configuration, which is automatically loaded in IntelliJ
Loading