Skip to content

Testing hz applications #1762

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.

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

fcannizzohz
Copy link

@fcannizzohz fcannizzohz commented Jul 14, 2025

This is a revisited section of the testing application docs here https://docs.hazelcast.com/hazelcast/5.5/test/testing-apps
After the workshop, where we introduced the full set of testing helpers, we thought about extending this section to provide full coverage of what's available.
there are two NOTES that require attention.
there's a side project which I am also hoping to merge in the hazelcast examples repo https://github.com/fcannizzohz/demo-hz-testing

@fcannizzohz fcannizzohz requested a review from a team as a code owner July 14, 2025 16:43
@devOpsHazelcast
Copy link
Collaborator

devOpsHazelcast commented Jul 14, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

netlify bot commented Jul 14, 2025

Deploy Preview for hardcore-allen-f5257d ready!

Name Link
🔨 Latest commit f92f399
🔍 Latest deploy log https://app.netlify.com/projects/hardcore-allen-f5257d/deploys/68768cb54e10d9000854e676
😎 Deploy Preview https://deploy-preview-1762--hardcore-allen-f5257d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Rob-Hazelcast Rob-Hazelcast self-assigned this Jul 15, 2025
Copy link
Contributor

@Rob-Hazelcast Rob-Hazelcast left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. A few comments in-line, and I've done a quick copy edit for style etc. Might be good to have a bit more detail on how you use the code samples, but difficult for me to assess as a non-developer.

Approving, but please don't merge without:

  • Removing in-line notes
  • Engineering approval


For dependencies and tests setup, see: xref:testing-setup.adoc[Testing setup].

== JUnit 4: `HazelcastTestSupport`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Throughout this file, are these code samples in the right places? E.g. you've got TestHazelcastFactory/InstanceFactory under JUnit 4, but you've said they're for JUnit 5?


=== `JetTestSupport` (JUnit4)

Extend `JetTestSupport` to test pipelines with in-process Hazelcast. This utility class provides lifecycle management and assertion methods specifically designed for streaming and batch dataflows.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use "embedded mode" terminology for consistency, unless that's not what this is referring to?

@@ -0,0 +1,313 @@
= Introduction to Hazelcast Performance Testing with Simulator

*NOTE: THIS CONTENT IS WORK IN PROGRESS*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't publish with this note in place. Suggest either publishing this section as is, or removing it to a separate PR.

From my POV, there's some missing context under e.g. "inventory plan", but it doesn't look too far off completion.


- Supports both *throughput* and *latency*-oriented testing modes.
- Orchestrates tests across multiple clients and members, with configurable topologies.
- Provides out-of-the-box support static infrastructure, (support for cloud deployments is not yet available).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this square with "running tests against cloud-deployed Hazelcast clusters"? Please remove any references to cloud support if it's not available.

@@ -0,0 +1,394 @@
= Summary of helper methods

*NOTE: WE NEED TO AGREE WHAT METHODS WE WANT TO ENDORSE AND WHAT NOT. WHAT ARE THE METHODS THAT MAY BE USEFUL TO USERS?*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, don't publish (merge) without removing this note please.

}
----

Shutting down a single instance can be used to mimic failure scenarios `ìnstance.shutdown()`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing words, or new line with code sample?

@Rob-Hazelcast
Copy link
Contributor

Suggest adding "backport to all versions" label if there's nothing here tied to a future release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants