Add JRE tests

Author: parttimenerd

cf_cli_java_plugin.go

@@ -228,6 +228,21 @@ var commands = []Command{
 JMAP_COMMAND=$(find -executable -name jmap | head -1 | tr -d [:space:])
 # SAP JVM: Wrap everything in an if statement in case jvmmon is available
 JVMMON_COMMAND=$(find -executable -name jvmmon | head -1 | tr -d [:space:])
+# if we have neither jmap nor jvmmon, we cannot generate a heap dump and should exit with an error
+if [ -z "${JMAP_COMMAND}" ] && [ -z "${JVMMON_COMMAND}" ]; then
+  echo >&2 "jvmmon or jmap are required for generating heap dump, you can modify your application manifest.yaml on the 'JBP_CONFIG_OPEN_JDK_JRE' environment variable. This could be done like this:
+		---
+		applications:
+		- name: <APP_NAME>
+		  memory: 1G
+		  path: <PATH_TO_BUILD_ARTIFACT>
+		  buildpack: https://github.com/cloudfoundry/java-buildpack
+		  env:
+			JBP_CONFIG_OPEN_JDK_JRE: '{ jre: { repository_root: "https://java-buildpack.cloudfoundry.org/openjdk-jdk/bionic/x86_64", version: 11.+ } }'
+		
+	"
+  exit 1
+fi
 if [ -n "${JMAP_COMMAND}" ]; then
 OUTPUT=$( ${JMAP_COMMAND} -dump:format=b,file=@FILE_NAME $(pidof java) ) || STATUS_CODE=$?
 if [ ! -s @FILE_NAME ]; then echo >&2 ${OUTPUT}; exit 1; fi
@@ -248,8 +263,24 @@ fi`,
 		Name:          "thread-dump",
 		Description:   "Generate a thread dump from a running Java application",
 		GenerateFiles: false,
-		SshCommand: "JSTACK_COMMAND=`find -executable -name jstack | head -1`; if [ -n \"${JSTACK_COMMAND}\" ]; then ${JSTACK_COMMAND} $(pidof java); exit 0; fi; " +
-			"JVMMON_COMMAND=`find -executable -name jvmmon | head -1`; if [ -n \"${JVMMON_COMMAND}\" ]; then ${JVMMON_COMMAND} -pid $(pidof java) -c \"print stacktrace\"; fi",
+		SshCommand: `JSTACK_COMMAND=$(find -executable -name jstack | head -1);
+		JVMMON_COMMAND=$(find -executable -name jvmmon | head -1) 
+		if [ -z "${JMAP_COMMAND}" ] && [ -z "${JVMMON_COMMAND}" ]; then
+		echo >&2 "jvmmon or jmap are required for generating heap dump, you can modify your application manifest.yaml on the 'JBP_CONFIG_OPEN_JDK_JRE' environment variable. This could be done like this:
+				---
+				applications:
+				- name: <APP_NAME>
+				memory: 1G
+				path: <PATH_TO_BUILD_ARTIFACT>
+				buildpack: https://github.com/cloudfoundry/java-buildpack
+				env:
+					JBP_CONFIG_OPEN_JDK_JRE: '{ jre: { repository_root: "https://java-buildpack.cloudfoundry.org/openjdk-jdk/bionic/x86_64", version: 11.+ } }'
+				
+			"
+		exit 1
+		fi
+		if [ -n \"${JSTACK_COMMAND}\" ]; then ${JSTACK_COMMAND} $(pidof java); exit 0; fi;
+		if [ -n \"${JVMMON_COMMAND}\" ]; then ${JVMMON_COMMAND} -pid $(pidof java) -c \"print stacktrace\"; fi`,
 	},
 	{
 		Name:          "vm-info",

test/README.md

@@ -64,6 +64,7 @@ Example output:
 - **`test_asprof.py`** - Async-profiler tests (SapMachine only)
 - **`test_cf_java_plugin.py`** - Integration and workflow tests
 - **`test_disk_full.py`** - Tests for disk full scenarios (e.g., heap dump with no space left)
+- ** `test_jre21.py`** - JRE21/non-SapMachine21-specific tests (e.g., heap dump, thread dump, etc.)
 
 ## Test Selection & Execution
 
@@ -158,7 +159,7 @@ from framework.decorators import test
 from framework.runner import TestBase
 
 class TestExample(TestBase):
-    @test("all")  # or @test("sapmachine21")
+    @test  # or @test(ine21")
     def test_heap_dump_basic(self, t, app):
         t.heap_dump("--local-dir .") \
             .should_succeed() \

test/apps/jre21/manifest.yml

@@ -0,0 +1,12 @@
+---
+applications:
+- name: jre21
+  random-route: true
+  path: test.jar
+  memory: 1024M
+  buildpacks:
+  - https://github.com/cloudfoundry/java-buildpack.git
+  env:
+    TARGET_RUNTIME: tomcat
+    JBP_CONFIG_COMPONENTS: '{jres: ["JavaBuildpack::Jre::OpenJdkJRE"]}'
+    JBP_CONFIG_OPEN_JDK_JRE: '{ jre: { version: 21.+ } }'

test/apps/jre21/test.jar

@@ -13,22 +13,25 @@
 
 
 def test(*apps, no_restart=False):
-    """Ultra-minimal test decorator.
+    """Test decorator.
 
     Usage:
-        @test("all")
-        @test("sapmachine11", "sapmachine21")
-        @test("all", no_restart=True)  # Skip app restart after test
+        @test
+        @test(no_restart=True)  # Skip app restart after test
 
     Args:
-        *apps: App names to test on ("all", "sapmachine11", "sapmachine21")
+        *apps: App names to test on, defaults to "sapmachine21"
         no_restart: If True, skip app restart after test
     """
 
     # Determine which apps to test
     if "all" in apps or not apps:
         test_apps = get_available_apps()
+    elif not apps:
+        # If no apps specified, default to sapmachine21
+        test_apps = ["sapmachine21"]
     else:
+        # Use the provided apps directly
         test_apps = list(apps)
 
     def decorator(test_func):

test/framework/decorators.py

@@ -554,6 +554,14 @@ def disk_full(ctx):
     return run_command([str(PYTEST), "test_disk_full.py"] + ctx.obj["pytest_args"])
 
 
+@cli.command()
+@click.pass_context
+def jre21(ctx):
+    """Run JRE21-specific tests."""
+    click.echo(f"{GREEN}Running JRE21 tests...")
+    return run_command([str(PYTEST), "test_jre21.py"] + ctx.obj["pytest_args"])
+
+
 @cli.command()
 @click.pass_context
 def all(ctx):

test/test.py

@@ -11,17 +11,17 @@
 class TestAsprofBasic(TestBase):
     """Basic async-profiler functionality."""
 
-    # @test("sapmachine11", no_restart=True)
+    # @test(ine11", no_restart=True)
     # def test_asprof_not_present(self, t, app):
     #    """Test that async-profiler is not present in JDK 21."""
     #    t.run(f"asprof {app} --args 'status'").should_fail().should_contain("not found")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_status_no_profiling(self, t, app):
         """Test asprof status when no profiling is active."""
         t.run(f"asprof-status {app}").should_succeed()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_start_provides_stop_instruction(self, t, app):
         """Test that asprof-start provides clear stop instructions."""
         t.run(f"asprof-start-cpu {app}").should_succeed().should_contain(f"Use 'cf java asprof-stop {app}'")
@@ -31,7 +31,7 @@ def test_start_provides_stop_instruction(self, t, app):
             "*.jfr"
         ).should_not_create_file()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_basic_profile(self, t, app):
         """Test basic async-profiler profile start and stop."""
         # Start profiling
@@ -40,7 +40,7 @@ def test_basic_profile(self, t, app):
         # Clean up
         t.run(f"asprof-stop {app}").should_succeed().should_create_file("*.jfr").should_create_no_remote_files()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_dry_run_commands(self, t, app):
         """Test async-profiler commands dry run functionality."""
         commands = [
@@ -55,7 +55,7 @@ def test_dry_run_commands(self, t, app):
         for cmd in commands:
             t.run(f"{cmd} {app} --dry-run").should_succeed().should_contain("cf ssh").no_files()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_error_handling(self, t, app):
         """Test error messages for invalid flags."""
         t.run(f"asprof-start-cpu {app} --invalid-flag").should_fail().no_files().should_contain("invalid")
@@ -64,7 +64,7 @@ def test_asprof_error_handling(self, t, app):
 class TestAsprofProfiles(TestBase):
     """Different async-profiler profiling modes."""
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_cpu_profiling(self, t, app):
         """Test CPU profiling with async-profiler."""
         # Start CPU profiling
@@ -81,7 +81,7 @@ def test_cpu_profiling(self, t, app):
             "jdk.NativeLibrary", 10
         )
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_wall_clock_profiling(self, t, app):
         """Test wall-clock profiling mode."""
         t.run(f"asprof-start-wall {app}").should_succeed()
@@ -90,7 +90,7 @@ def test_wall_clock_profiling(self, t, app):
 
         t.run(f"asprof-stop {app} --local-dir .").should_succeed().should_create_file(f"{app}-asprof-*.jfr")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_allocation_profiling(self, t, app):
         """Test allocation profiling mode."""
         t.run(f"asprof-start-alloc {app}").should_succeed()
@@ -99,15 +99,15 @@ def test_allocation_profiling(self, t, app):
 
         t.run(f"asprof-stop {app} --local-dir .").should_succeed().should_create_file(f"{app}-asprof-*.jfr")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_allocation_profiling_dry_run(self, t, app):
         """Test allocation profiling dry run."""
         # This should not create any files, just show the command
         t.run(f"asprof-start-alloc {app} --dry-run").should_succeed().should_contain("-e alloc").no_files()
         t.run(f"asprof-status {app}").should_succeed().no_files().should_contain("Profiler is not active")
         t.run(f"asprof-stop {app}").should_succeed()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_lock_profiling(self, t, app):
         """Test lock profiling mode."""
         t.run(f"asprof-start-lock {app}").should_succeed()
@@ -120,7 +120,7 @@ def test_lock_profiling(self, t, app):
 class TestAsprofAdvanced(TestBase):
     """Advanced async-profiler scenarios."""
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_stop_without_download(self, t, app):
         """Test stopping profiling without downloading results."""
         # Start profiling
@@ -131,7 +131,7 @@ def test_stop_without_download(self, t, app):
         # Stop without download
         t.run(f"asprof-stop {app} --no-download").should_succeed().should_not_create_file("*.jfr")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_keep_remote_file(self, t, app):
         """Test keeping profiling file on remote after download."""
         # Start profiling
@@ -144,7 +144,7 @@ def test_keep_remote_file(self, t, app):
             f"{app}-asprof-*.jfr"
         ).should_create_remote_file(file_extension=".jfr")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_workflow_with_multiple_checks(self, t, app):
         """Test complete workflow with comprehensive checks."""
         # Test each step of the profiling workflow
@@ -166,7 +166,7 @@ def test_workflow_with_multiple_checks(self, t, app):
 class TestAsprofLifecycle(TestBase):
     """Complete async-profiler workflow tests."""
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_full_cpu_profiling_workflow(self, t, app):
         """Test complete CPU profiling workflow with validation."""
         # 1. Verify no profiling initially
@@ -189,7 +189,7 @@ def test_full_cpu_profiling_workflow(self, t, app):
         # 6. Verify profiling has stopped
         t.run(f"asprof-status {app}").should_succeed().no_files().should_contain("Profiler is not active")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_multiple_profiling_sessions(self, t, app):
         """Test running multiple profiling sessions in sequence."""
         profiling_modes = ["cpu", "wall", "alloc"]
@@ -207,22 +207,22 @@ def test_multiple_profiling_sessions(self, t, app):
 class TestAsprofCommand(TestBase):
     """Tests for the general asprof command with --args (distinct from asprof-* commands)."""
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_help_command(self, t, app):
         """Test asprof help command via --args."""
         t.run(f"asprof {app} --args '--help'").should_succeed().should_contain("profiler").no_files()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_version_command(self, t, app):
         """Test asprof version command."""
         t.run(f"asprof {app} --args '--version'").should_succeed().should_start_with("Async-profiler ").no_files()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_status_via_args(self, t, app):
         """Test asprof status via --args (different from asprof-status command)."""
         t.run(f"asprof {app} --args 'status'").should_succeed().no_files().should_contain("Profiler is not active")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_start_auto_no_download(self, t, app):
         """Test that asprof start commands automatically set no-download."""
         t.run(f"asprof {app} --args 'start -e cpu -f /tmp/asprof/bla.jfr'").should_succeed().no_files()
@@ -233,7 +233,7 @@ def test_asprof_start_auto_no_download(self, t, app):
             "*.jfr"
         ).should_create_no_remote_files()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_with_custom_output_file(self, t, app):
         """Test asprof with custom output file using @FSPATH."""
         # Start profiling with custom file in the asprof folder
@@ -244,7 +244,7 @@ def test_asprof_with_custom_output_file(self, t, app):
         # Stop and download
         t.run(f"asprof {app} --args 'stop' --local-dir .").should_succeed().should_create_file("custom-profile.jfr")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_collect_multiple_files(self, t, app):
         """Test that asprof collects multiple files from the asprof folder."""
         # Create multiple files via asprof
@@ -259,7 +259,7 @@ def test_asprof_collect_multiple_files(self, t, app):
             "cpu.jfr"
         ).should_create_file("alloc.jfr")
 
-    @test("sapmachine21")
+    @test
     def test_asprof_keep_remote_files(self, t, app):
         """Test keeping remote files with asprof."""
         # Generate a file and keep it
@@ -269,7 +269,7 @@ def test_asprof_keep_remote_files(self, t, app):
             "keep-test.jfr"
         ).should_create_remote_file("keep-test.jfr")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_invalid_args_flag_for_non_args_commands(self, t, app):
         """Test that --args flag is rejected for commands that don't support it."""
         # asprof-start commands don't use @ARGS, so --args should be rejected
@@ -281,40 +281,40 @@ def test_asprof_invalid_args_flag_for_non_args_commands(self, t, app):
 class TestAsprofEdgeCases(TestBase):
     """Edge cases and error conditions for async-profiler."""
 
-    @test("sapmachine21")
+    @test
     def test_asprof_start_commands_file_flags_validation(self, t, app):
         """Test that asprof-start commands reject inappropriate file flags."""
         # asprof-start commands have GenerateFiles=false, so some file flags should be rejected
         for flag in ["--keep", "--no-download"]:
             t.run(f"asprof-start-cpu {app} {flag}").should_fail().should_contain("not supported for asprof-start-cpu")
 
-    #@test("sapmachine21")
-    #def test_asprof_stop_requires_prior_start(self, t, app):
+    # @test
+    # def test_asprof_stop_requires_prior_start(self, t, app):
     #    """Test asprof-stop behavior when no profiling is active."""
     #    t.run(f"asprof-stop {app}").should_fail().should_contain("[ERROR] Profiler has not started").no_files()
 
-    @test("sapmachine21")
+    @test
     def test_asprof_different_event_types(self, t, app):
         """Test CPU event type via asprof command."""
         # Test CPU event type
         t.run(f"asprof {app} --args 'start -e cpu'").should_succeed()
         time.sleep(0.5)
         t.run(f"asprof {app} --args 'stop'").should_succeed()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_output_formats(self, t, app):
         """Test JFR output format with asprof."""
         t.run(f"asprof {app} --args 'start -e cpu -o jfr -f @FSPATH/profile.jfr'").should_succeed()
         time.sleep(0.5)
         t.run(f"asprof {app} --args 'stop' --local-dir .").should_succeed().should_create_file("profile.jfr")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_recursive_args_validation(self, t, app):
         """Test that @ARGS cannot contain itself in asprof."""
         # This should fail due to the validation in replaceVariables
         t.run(f"asprof {app} --args 'echo @ARGS'").should_fail()
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_profiling_duration_and_interval(self, t, app):
         """Test asprof with duration parameter."""
         # Test duration parameter
@@ -323,7 +323,7 @@ def test_asprof_profiling_duration_and_interval(self, t, app):
         t.run(f"asprof {app} --args 'status'").should_succeed()  # Should show no active profiling
         t.run(f"asprof {app} --args 'stop' --local-dir .").should_succeed().should_create_file("duration.jfr")
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_list_command(self, t, app):
         # List should show available files
         t.run(f"asprof {app} --args 'list'").should_succeed().no_files().should_contain("Basic events:")
@@ -332,7 +332,7 @@ def test_asprof_list_command(self, t, app):
 class TestAsprofAdvancedFeatures(TestBase):
     """Advanced async-profiler features and workflows."""
 
-    @test("sapmachine21", no_restart=True)
+    @test(no_restart=True)
     def test_asprof_flamegraph_generation(self, t, app):
         """Test flamegraph generation with asprof."""
         t.run(f"asprof {app} --args 'start -e cpu'").should_succeed()