Usage instructions and Brief introduction

(this page is for developing and maintaining this project)

Development Instructions

Prerequisites

Following instructions apply to Windows machines:

1. Run PowerShell as Administrator -- required by Chocolatey
2. Install Chocolatey -- https://chocolatey.org/install#individual
3. choco install -y temurin11
4. choco install -y git
5. choco install -y gpg4win -- required for signing commits
6. choco install -y tortoisegit -- optional
7. choco install -y intellijidea-ultimate or choco install eclipse-java-oxygen

There should be similar commands for Mac and various Linux distros.

Maven Settings

Either copy development-maven-settings.xml to your ~/.m2 as settings.xml, or run Maven with mvnw -settings development-maven-settings.xml from this directory.

IDE Configuration

Project settings are shared via .idea folder see https://www.jetbrains.com/help/idea/creating-and-managing-projects.html#share-project-through-vcs and https://www.jetbrains.com/help/idea/sharing-your-ide-settings.html#settings-repository

Lombok and TestNG

see IDE Configuration

AspectJ

Screenshots and tracing logs require AspectJ instrumentation. AspectJ plugin is required in order to compile, run and debug in an IDE:

• Eclipse -- https://www.eclipse.org/ajdt/
• IntelliJ -- bundled (https://www.jetbrains.com/help/idea/aspectj.html), requires additional configuration as follows:
  1. ajc (AspectJ Compiler) must be used
  2. AspectJ facet must be configured in "post-compile weave mode" for following modules: qa-testing-example, qa-testing-utils, qa-testing-extra and qa-jgiven-commons

Testing

mvnw on the root project will run all tests.

Deploying

By pushing or merging into main branch. See the deploy-site-for-jdk11.

Releasing/Versioning

We use SemVer for versioning.

To initiate a release, run the Release action.

The above has the following effects:

• SNAPSHOT suffix will be removed
• sources will be committed and tagged according to current version
• artifacts will be deployed to OSSRH
• versions will be bumped up forming a new SNAPSHOT
• a new commit will be made on main branch
• after few hours released artifacts will appear on Maven Central at https://search.maven.org/search?q=dev.aherscu

Known Issues

see docs/KNOWN-ISSUES.md

Contributing

Please read CONTRIBUTING.md for details on our process for submitting pull requests to us, and please ensure you follow the CODE_OF_CONDUCT.md.

License

This project is licensed under the Apache License - see the LICENSE file for details.

My GPG Public Key

For validating published artifacts, use https://keys.openpgp.org/search?q=39F1B2495B0260B2D974C634F89B5DBA3AF082E0

Importing GPG Private Key

Per OSSRH depolyment rules, all artifacts must be signed using gpg -- https://central.sonatype.org/publish/publish-maven/#gpg-signed-components

gpg --import 39F1B2495B0260B2D974C634F89B5DBA3AF082E0.gpg

and ensure your correct Maven Settings as described above.

Running Web/Mobile tests on SauceLabs

Must add following environment variables before launching Maven:

• SAUCELABS_USER
• SAUCELABS_PASSWORD

These are available from https://app.saucelabs.com/

Acknowledgments