https://github.com/electrostat-lab/jme3-testable
An API designed to automatically select and test jme3 examples.
https://github.com/electrostat-lab/jme3-testable
annotations api-design automated-testing desktop electrostat-lab java java-reflection jmonkeyengine3
Last synced: 7 months ago
JSON representation
An API designed to automatically select and test jme3 examples.
- Host: GitHub
- URL: https://github.com/electrostat-lab/jme3-testable
- Owner: Electrostat-Lab
- License: bsd-3-clause
- Created: 2024-02-09T11:50:39.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-09T12:12:42.000Z (about 2 years ago)
- Last Synced: 2025-02-06T23:30:43.041Z (about 1 year ago)
- Topics: annotations, api-design, automated-testing, desktop, electrostat-lab, java, java-reflection, jmonkeyengine3
- Language: Java
- Homepage:
- Size: 88.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jme3-testable API
This is an initial implementation for the testable api, targeting issue [jmonkeyengine#1649](https://github.com/jMonkeyEngine/jmonkeyengine/issues/1649), which suggests building a better test chooser backend for jme3-examples, where one can pickup which test cases to run inside a package.
This is a video demonstrating testables in action:
[](https://www.youtube.com/watch?v=u9biai9Yg38)
## F.A.Q:
**How can I make my own test?**:
A: Your test should `extends JmeTestApp` or `JmeTestState`, in either cases, you will override `launch()` method and add what you want to test there, whether a `JmeApplication.attachState(this); for AppStates` or `setting up AppSettings and start()` or `setting up a JmeSurfaceView for android`.
**Does this approach provide a recursive way of opening a package?**
A; Yep, all you need to do, is to give the package, which can be done by 2 methods :
METHOD-A :
```java
TestableExecutor.getInstance().launch("jme3test", "--No-Data--", tags);
```
METHOD-B :
```java
TestableExecutor.getInstance().launch(Main.class.getPackage().getName(),
"--No-Data--", tags);
```
**Can I test multiple packages that aren't on the same tree, at the same time?**
A: Yep, just use :
```java
TestableExecutor.getInstance().launch(new String[] {"jme3test.app", "jme3test.animation"},
"--No-Data--", tags);
```
**Can I use multiple tags in the same `@TestableTags` annoation?**
A: Yep, use this:
```java
@TestableTags({Launcher.TAG_WATER_FILTERS, Launcher.TAG_ALL})
```
But, no `@TestableTags` repetition...it complicates simple stuff and not clean anyway.
**What will happen if I have non-class files on my package**
A: Don't worry, the utility skips those.
**What will happen if I have other classes not implementing the Testable?**
A: Those are skipped too.
**Can I use this on android?**
A: Theoretically, you can, but I haven't found the time to test that yet.
**What will happen if I extended JmeTestApp and didn't add a `@TestableTags` with a signature?**
A: The utility will exclude this test, because how should it know 'is it ready to be executed?', if you want to run all Testables under a package then use a unified tag in all those classes, for example, add this to all the testables you want to run `Launcher.TAG_ALL` while you can still use other tags to filter your tests for other run configurations:
```java
@TestableTags({Launcher.TAG_WATER_FILTERS, Launcher.TAG_ALL})
```
I think that is it, for now, if that is what you are seeking, then i hope it will be helpful, please give a quick review.
## Examples:
1) The Testable class :
```java
package jme3test.app.test;
import com.jme3.system.AppSettings;
import com.avrsandbox.jme3.testable.app.JmeAppTest;
import com.jme3.scene.Geometry;
import com.jme3.scene.shape.Box;
import com.avrsandbox.jme3.testable.TestableTags;
import jme3test.Launcher;
/**
* Test a bare-bones application, without SimpleApplication.
*/
@TestableTags({Launcher.TAG_ALL})
public class BareBonesAppTest extends JmeAppTest {
private Geometry boxGeom;
public static void main(String[] args){
AppSettings settings = new AppSettings(true);
settings.setRenderer(AppSettings.LWJGL_OPENGL2);
settings.setAudioRenderer(AppSettings.LWJGL_OPENAL);
new BareBonesAppTest().launch(settings);
}
@Override
public void simpleUpdate(float tpf) {
super.simpleUpdate(tpf);
boxGeom.rotate(tpf * 2, tpf * 4, tpf * 3);
}
@Override
public void simpleInitApp() {
// create a box
boxGeom = new Geometry("Box", new Box(2, 2, 2));
// load some default material
boxGeom.setMaterial(assetManager.loadMaterial("Interface/Logo/Logo.j3m"));
// attach box to display in primary viewport
rootNode.attachChild(boxGeom);
}
@Override
public void launch(AppSettings userData) {
super.launch(userData);
setSettings(userData);
setShowSettings(false);
start();
}
}
```
2) The Launcher (main class) :
```java
package jme3test;
import com.jme3.system.AppSettings;
import com.avrsandbox.testable.util.TestableExecutor;
import java.lang.reflect.InvocationTargetException;
/**
* Tests the new jme test api.
*
* @author pavl_g.
*/
public class Launcher {
public static final String TAG_ALL = "ALL";
public static final String TAG_WATER_FILTERS = "WATER-FILTER";
public static final String TAG_PBR = "PBR";
public static final String[] tags = new String[] {
TAG_ALL
};
public static void main(String[] args) throws InstantiationException, IllegalAccessException,
ClassNotFoundException, NoSuchMethodException,
InvocationTargetException {
final AppSettings settings = new AppSettings(true);
settings.setRenderer(AppSettings.LWJGL_OPENGL2);
settings.setAudioRenderer(AppSettings.LWJGL_OPENAL);
TestableExecutor.getInstance().launch(new String[] {"jme3test"}, settings, tags);
}
}
```