Getting Started with JSystem: Installation and First ProjectJSystem is a modular testing framework designed to simplify automated testing for Java applications, embedded systems, and hardware-in-the-loop environments. This guide walks you through installing JSystem, configuring your development environment, and building your first project — a simple automated test suite that runs a few test cases and generates a report.
Prerequisites
Before you begin, make sure you have the following installed:
- Java JDK 11 or later — JSystem requires a modern Java runtime.
- Apache Maven 3.6+ — used for dependency management and building projects.
- Git — optional but recommended for version control.
- A code editor or IDE (IntelliJ IDEA, Eclipse, or VS Code).
Overview of JSystem concepts
JSystem organizes tests using a hierarchy of components that make it easy to create maintainable suites.
- Test cases — individual tests, typically implemented as Java classes or methods.
- Test suites — collections of test cases organized for execution.
- Test runners — components that execute suites and manage setup/teardown.
- Reporters — modules that generate execution logs and test reports.
- Plugins — optional extensions for integrations (e.g., CI/CD, databases, hardware).
Installation
There are two common ways to use JSystem: as a standalone installation (if distributing an application that bundles it) or as a project dependency via Maven. This guide uses the Maven approach.
- Create a new Maven project
Open a terminal and run:
mvn archetype:generate -DgroupId=com.example.jsystem -DartifactId=jsystem-demo -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false cd jsystem-demo - Add JSystem dependencies
In your project’s pom.xml, add the JSystem core dependency and typical reporting plugin. Replace version numbers with the latest available.
<dependencies> <dependency> <groupId>org.jsystem</groupId> <artifactId>jsystem-core</artifactId> <version>1.2.3</version> </dependency> <dependency> <groupId>org.jsystem</groupId> <artifactId>jsystem-reporter</artifactId> <version>1.2.3</version> </dependency> <!-- Add testing frameworks if needed --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.13.2</version> <scope>test</scope> </dependency> </dependencies> - Update build plugins (optional)
Configure the Maven Surefire plugin to run JSystem tests during the test phase:
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>3.0.0-M7</version> </plugin> </plugins> </build> - Refresh project in your IDE so dependencies download.
Creating your first JSystem test
We’ll implement a simple test class that verifies basic operations.
- Create test class
Create src/test/java/com/example/jsystem/SimpleTest.java with:
package com.example.jsystem; import org.jsystem.framework.TestRunner; import org.jsystem.framework.annotations.Test; import org.junit.Assert; public class SimpleTest { @Test public void testAddition() { int a = 2; int b = 3; int sum = a + b; Assert.assertEquals("2 + 3 should be 5", 5, sum); } @Test public void testStringConcat() { String s = "Hello"; s += " World"; Assert.assertEquals("Hello World", s); } } Note: depending on the JSystem API, annotations and base classes may differ; adjust imports if necessary.
- Run tests
From command line:
mvn test Or run from your IDE’s test runner. Maven will execute the tests and generate reports via Surefire and any JSystem reporters configured.
Using JSystem runner and creating a suite
JSystem often uses its own runner and XML-based suites. Example steps:
- Create a suite XML (tests/suites/mySuite.xml):
<suite name="MySuite"> <testcase class="com.example.jsystem.SimpleTest" method="testAddition"/> <testcase class="com.example.jsystem.SimpleTest" method="testStringConcat"/> </suite> - Execute the suite with a simple Java runner (example):
package com.example.jsystem; import org.jsystem.framework.suite.SuiteRunner; import java.io.File; public class SuiteExecutor { public static void main(String[] args) throws Exception { File suiteFile = new File("tests/suites/mySuite.xml"); SuiteRunner runner = new SuiteRunner(suiteFile); runner.run(); } } Run:
mvn exec:java -Dexec.mainClass="com.example.jsystem.SuiteExecutor" Adjust plugin configuration to enable exec plugin.
Viewing reports and logs
- Check target/surefire-reports for JUnit-formatted results.
- JSystem reporter plugins typically produce HTML reports in target/jsystem-reports or a configurable directory.
- Logs appear in target/logs or console depending on configuration.
Integrating with CI/CD
- Add mvn test to your CI pipeline (GitHub Actions, GitLab CI, Jenkins).
- Archive test reports and artifacts for later analysis.
- Use JSystem plugins for reporting to external dashboards if needed.
Example GitHub Actions snippet:
name: Java CI on: [push] jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Set up JDK 17 uses: actions/setup-java@v4 with: java-version: '17' - name: Build and test run: mvn -B test - name: Upload test reports uses: actions/upload-artifact@v3 with: name: test-reports path: target/surefire-reports Troubleshooting common issues
- Dependency version conflicts — use mvn dependency:tree to inspect.
- Tests not recognized — ensure correct annotations/imports for JSystem or JUnit.
- Reports missing — check reporter configuration and output directories.
Next steps & best practices
- Organize tests into logical suites (smoke, regression, integration).
- Use setup/teardown hooks for environment preparation.
- Parameterize tests and externalize test data.
- Integrate with code coverage tools (JaCoCo) and static analysis.
If you want, I can: provide a ready pom.xml with versions, adapt the example to a specific JSystem release you have, or convert the suite execution to use a Gradle build. Which would you like?