-
-
Notifications
You must be signed in to change notification settings - Fork 314
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
Added churn testsuite #5101
Added churn testsuite #5101
Changes from 11 commits
2833dee
f6fa4df
517b988
e7c6f7c
3dc815d
4db1633
550593a
655e499
1cc8542
2249bc0
ec66f1a
59ebac8
a7457b6
b69d963
9684763
8826b5d
90ec5e7
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,36 @@ | ||||||
# churn | ||||||
Test targeting garbage collector(s). | ||||||
The suite is able to operate with all GCs in OpenJDK. If your implementation is missing some, the calls to them will fall. If you have some additional one, an enabling wrapper must be created first. | ||||||
|
||||||
## Running churn locally | ||||||
clone https://github.com/rh-openjdk/churn read https://github.com/rh-openjdk/churn/blob/master/README and run run.sh | ||||||
|
||||||
### Setting up the environment: | ||||||
Java required. Maven recommended, churn can be compiled via direct javac if needed | ||||||
Java is used from JAVA_HOME or guessed from PATH. | ||||||
run.sh can use OTOOL_garbageCollector and OTOOL_JDK_VERSION instead of GC argument. See https://github.com/rh-openjdk/churn/blob/master/README for details. | ||||||
See https://github.com/rh-openjdk/churn/tree/master/bin for list of supported GCs. The compressed ops in upstream run can be controlled by runner or NOCOMP=-nocoops variable (for run.sh) | ||||||
|
||||||
## Running via aqavit | ||||||
judovana marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
The support for compressed ops is handled by aqavit itself. It is currently not sure if churn will be able to honor it. If not, churn will be fixed. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
Similarly the java version and JAVA_HOME are handled by aqavit. | ||||||
judovana marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
### Executing the testsuite | ||||||
The `BUILD_LIST of functional/churn` contains three targets: | ||||||
* _churn_1m_allGCs | ||||||
* _churn_5h_allGCs | ||||||
* _churn_custom | ||||||
|
||||||
There are major differences in them: | ||||||
* churn_1m_allGCs - is testing ground, which runs each GC only for aprox 10 seconds, to simply see if the setup works | ||||||
* churn_5h_allGCs - Is running each GC a bit over, which runs each GC for aprox hour and half. A minimum, which can find some real GC issue. | ||||||
* churn_custom - this one needs you to set and export CHURN_GCS and CHURN_DURATION to select GC(or GCs) and duration. So it allows you to test your custom GC - if churn supports that, despite of anybody else (eg `default` or `ALL` thinks) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I had adapt this only partially, as I had not (yet!) followed the APPLICATION_OPTIONS and 5 minutes as you requested (subject of another discussion) |
||||||
|
||||||
churn_1m_allGCs and churn_5h_allGCs are using pony `ALL` keyword, which is interpreted (based on hardcoded list) as all GC in tested JVM. The set time is divided among them. | ||||||
Note, that if you use `churn_custom` and enumeration, eg `CHURN_GCS="zgc g1"` then the time will not be divided. The `CHURN_DURATION` is in seconds | ||||||
The `CHURN_GCS="defaultgc"`will set the tested GC to defautl GC as run.sh think is right. So be aware. Although it is maintained, if your custom JDK have custom GC, it is unlikely to be known | ||||||
judovana marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
### reading results: | ||||||
judovana marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
tap file and compressed xmlfile is genrated. Use eg https://github.com/jenkinsci/report-jtreg-plugin or https://plugins.jenkins.io/tap/ to read them. | ||||||
judovana marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
<?xml version="1.0"?> | ||
|
||
<!-- | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# https://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
--> | ||
|
||
<project name="churn" default="build" basedir="."> | ||
<taskdef resource="net/sf/antcontrib/antlib.xml" /> | ||
<description> | ||
Test targeting garbage collector(s) | ||
</description> | ||
|
||
<!-- set properties for this build --> | ||
<property name="TEST" value="churn" /> | ||
<property name="DEST" value="${BUILD_ROOT}/functional/churn" /> | ||
<property name="src" location="./churn" /> | ||
|
||
<target name="THC.check"> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Opportunity to generalize the name to testcodeDir.check and testCodeDir.exists (which could also be made into an ant macrodef and moved to TKG, but not required for this PR), no need to use same ant target name as the TestHeadlessComponents ant tasks |
||
<condition property="THCdir.exists"> | ||
<available file="churn" type="dir"/> | ||
</condition> | ||
</target> | ||
|
||
<if> | ||
<contains string="${SPEC}" substring="zos"/> | ||
<then> | ||
<property name="GIT_REPO" value="[email protected]:" /> | ||
</then> | ||
<else> | ||
<property name="GIT_REPO" value="https://github.com/" /> | ||
</else> | ||
</if> | ||
|
||
<target name="getChurn" depends="THC.check" unless="THCdir.exists"> | ||
<exec executable="git" failonerror="true"> | ||
<arg value="clone" /> | ||
<arg value="${GIT_REPO}rh-openjdk/churn.git" /> | ||
</exec> | ||
</target> | ||
|
||
<target name="init"> | ||
<mkdir dir="${DEST}"/> | ||
</target> | ||
|
||
<target name="dist" depends="getChurn" description="generate the distribution"> | ||
<copy todir="${DEST}"> | ||
<fileset dir="${src}" includes="*.xml, *.mk"/> | ||
</copy> | ||
</target> | ||
|
||
<target name="build"> | ||
<antcall target="dist" inheritall="true" /> | ||
</target> | ||
</project> |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,88 @@ | ||||||
<?xml version='1.0' encoding='UTF-8'?> | ||||||
<!-- | ||||||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||||||
# you may not use this file except in compliance with the License. | ||||||
# You may obtain a copy of the License at | ||||||
# | ||||||
# https://www.apache.org/licenses/LICENSE-2.0 | ||||||
# | ||||||
# Unless required by applicable law or agreed to in writing, software | ||||||
# distributed under the License is distributed on an "AS IS" BASIS, | ||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||||||
# See the License for the specific language governing permissions and | ||||||
# limitations under the License. | ||||||
--> | ||||||
<playlist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../TKG/resources/playlist.xsd"> | ||||||
<test> | ||||||
<testCaseName>churn_1m_allGCs</testCaseName> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. churn_1m_allGCs is for testing only. When the PR is ready for merge can it be disabled by adding tag ? |
||||||
<command> | ||||||
export OTOOL_JDK_VERSION="$(JDK_VERSION)" ; \ | ||||||
export JREJDK="jdk" ; \ | ||||||
export OTOOL_garbageCollector="ALL" ; \ | ||||||
export DURATION="60" ; \ | ||||||
export TMPRESULTS="$(Q)$(REPORTDIR)$(D)report$(Q)"; \ | ||||||
cd $TMPRESULTS ; \ | ||||||
bash "$(TEST_ROOT)$(D)functional$(D)churn$(D)churn$(D)run.sh"; \ | ||||||
$(TEST_STATUS) | ||||||
</command> | ||||||
<levels> | ||||||
<level>dev</level> | ||||||
</levels> | ||||||
<platformRequirementsList> | ||||||
<platformRequirements>os.linux</platformRequirements> | ||||||
<platformRequirements>os.win</platformRequirements> | ||||||
<platformRequirements>os.osx</platformRequirements> | ||||||
</platformRequirementsList> | ||||||
<groups> | ||||||
<group>system</group> | ||||||
</groups> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's restrict to particular vendors for now, as I am not sure which vendors include the entire list of GCs that are in 'allGCs' in their distribution (in particular shenandoah) and we do not want to break others.
|
||||||
</test> | ||||||
<test> | ||||||
<testCaseName>churn_5h_allGCs</testCaseName> | ||||||
<command> | ||||||
export OTOOL_JDK_VERSION="$(JDK_VERSION)" ; \ | ||||||
export JREJDK="jdk" ; \ | ||||||
export OTOOL_garbageCollector="ALL" ; \ | ||||||
export DURATION="18000" ; \ | ||||||
export TMPRESULTS="$(Q)$(REPORTDIR)$(D)report$(Q)"; \ | ||||||
cd $TMPRESULTS ; \ | ||||||
bash "$(TEST_ROOT)$(D)functional$(D)churn$(D)churn$(D)run.sh"; \ | ||||||
$(TEST_STATUS) | ||||||
</command> | ||||||
<levels> | ||||||
<level>dev</level> | ||||||
</levels> | ||||||
<platformRequirementsList> | ||||||
<platformRequirements>os.linux</platformRequirements> | ||||||
<platformRequirements>os.win</platformRequirements> | ||||||
<platformRequirements>os.osx</platformRequirements> | ||||||
</platformRequirementsList> | ||||||
<groups> | ||||||
<group>system</group> | ||||||
</groups> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I will add this element, But I think the generic openjdk should be for sure here. I now recall, there may be issue with shenandoah on jdk8, but I would rather workaround it in CHURN itself, then exclude generic oepnjdk. Thoughts? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I had made the listing of GCs dynamic: rh-openjdk/churn@17f1b83 it is still based on known values, but at least will not enforce not-existing GC. Any advice on enabling more vendors? (compelltyh up to you :) tyvm!!) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can onboard other vendors once we see this running for a few weeks at the project, we are just bringing this in now cautiously, but then can broaden it later (and we will do that by testing it against other vendor distros before enabling them). |
||||||
</test> | ||||||
<test> | ||||||
<testCaseName>churn_custom</testCaseName> | ||||||
judovana marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
<command> | ||||||
export OTOOL_JDK_VERSION="$(JDK_VERSION)" ; \ | ||||||
export JREJDK="jdk" ; \ | ||||||
export OTOOL_garbageCollector="${CHURN_GCS}" ; \ | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I do not understand this requirements:
The APPLICATION_OPTIONS is something what is custom in aqavit? Isn't it some more general setup? To remove custom duration s moreover killing the purpise of the changeset and the suite. If you are developing custom GC or porting JDK to new paltform, you want to run churn on each GC you care about (usually default or the single custom one) for several hours. 300s is useles. Generally any hardcoded value in the "custom" setupo is (IMO) bad. Can we stay with originals pelase? Or maybe an APPLICATION_OPTIONS contain key=value pairs? (but as GC can be space separated list of GCs, it sounds bad). Or maybe APPLICATION_OPTIONS_GC and APPLICATION_OPTIONS_DURATION ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Seeing your touch to readme - is there eal fear, that some ccrazy eprson will start 20days long churn run? If so, then I would lke to still keep the duration adjsutable, and only eg limit it from top. if such logic would be desirable, then also the churn_1m_allGCs and churn_5h_allGCs may actually take GC as parameter. And fallback to "ALL" if nothing provided. wdyt? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please see that I have asked that this churn_custom target is disabled (using the Also in our world, no one is allowed to go onto test machines and set CHURN_DURATION and CHURN_GCS environment variables, and we would not want them to do that (for lots of reasons, not the least of which is transparency of machine config). This leaves me to the point to look at this test target as a useful thing when someone wants to run a Grinder to test a particular GC for a short duration, which is why I suggest leveraging the existing APPLICATION_OPTIONS mechanism for pinpointed testing of a particular GC failure. All that to be said, feel free to not take those review comments and apply them.
Yes, the other option is to remove the churn_custom target altogether from the playlist.xml file in this PR. That would be the expedient way to get this PR through. Could consider then leveraging APPLICATION_OPTIONS to pass a subset of GCs and if its blank, expect the churn test suite to default to all. |
||||||
export DURATION="${CHURN_DURATION}" ; \ | ||||||
judovana marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
export TMPRESULTS="$(Q)$(REPORTDIR)$(D)report$(Q)"; \ | ||||||
cd $TMPRESULTS ; \ | ||||||
bash "$(TEST_ROOT)$(D)functional$(D)churn$(D)churn$(D)run.sh"; \ | ||||||
$(TEST_STATUS) | ||||||
</command> | ||||||
<levels> | ||||||
<level>dev</level> | ||||||
</levels> | ||||||
<platformRequirementsList> | ||||||
<platformRequirements>os.linux</platformRequirements> | ||||||
<platformRequirements>os.win</platformRequirements> | ||||||
<platformRequirements>os.osx</platformRequirements> | ||||||
</platformRequirementsList> | ||||||
<groups> | ||||||
<group>system</group> | ||||||
</groups> | ||||||
</test> | ||||||
</playlist> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.