diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d26394e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2014 Andreas Weber + + 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 + + http://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. \ No newline at end of file diff --git a/README.md b/README.md index 99d322f..4354a21 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,28 @@ -TimestampTimerPlugin +Timestamp Timer PlugIn ========================== -JMeter plugin for timestamp based delays. +JMeter plugin for timestamp based delays (new timer component). + + +------------------------ +Installation +------------------------ +Just copy the TimestampPlugin.jar file into the folder lib/ext/ of your JMeter installation directory. +Exemplary test plans require the Standard Set of JMeter Plugins (http://jmeter-plugins.org) + +------------------------ +About the Timestamp File +------------------------ +The timestamp file must contain relative timestamps for request in seconds (seconds since start of load test). +Each line in the timestamp file must contain one timestamp which is followed by a semicolon (;). +One option for creating timestamp files is the workload modeling tool LIMBO: +http://se2.informatik.uni-wuerzburg.de/mediawiki-se/index.php/Tools#LIMBO:_Load_Intensity_Modeling_Tool + + +------------------------ +Usage +------------------------ +Try the provided TestPlans (Standard Set of JMeter Plugins (http://jmeter-plugins.org) required). +Start with: SingleThreadPool-DummySampler.jmx +Find the "Timestamp Timer" element and open a timestamp file (e.g. the provided timestamps.txt). +Run the TestPlan and watch the chart provided by the "jp@gc - Transactions per Second" element. diff --git a/TimestampPlugin.jar b/TimestampPlugin.jar new file mode 100644 index 0000000..504d9e2 Binary files /dev/null and b/TimestampPlugin.jar differ diff --git a/examples/SingleThreadPool-DummySampler.jmx b/examples/SingleThreadPool-DummySampler.jmx new file mode 100644 index 0000000..a043c7e --- /dev/null +++ b/examples/SingleThreadPool-DummySampler.jmx @@ -0,0 +1,161 @@ + + + + + + false + false + + + + + + + + continue + + false + -1 + + 100 + 0 + 1391782602000 + 1391782602000 + false + + + + + + true + true + 200 + OK + + + 0 + 0 + + + + + 1 + + + + + true + true + 200 + OK + ${TIMESTAMP_ID} / ${TIMESTAMP_TOTAL} + ${TIMESTAMP_ID} / ${TIMESTAMP_TOTAL} + 0 + 0 + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + false + false + false + false + false + 0 + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + false + false + false + false + false + 0 + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + false + false + false + false + false + 0 + true + + + + 1000 + false + + + + + + + + + diff --git a/examples/SingleThreadPool-HTTPSampler.jmx b/examples/SingleThreadPool-HTTPSampler.jmx new file mode 100644 index 0000000..9d52005 --- /dev/null +++ b/examples/SingleThreadPool-HTTPSampler.jmx @@ -0,0 +1,170 @@ + + + + + + false + false + + + + + + + + continue + + false + -1 + + 100 + 0 + 1391782602000 + 1391782602000 + false + + + + + + true + true + 200 + OK + + + 0 + 0 + + + + + 1 + + + + + + + + + + + + + + + GET + true + false + true + false + false + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + false + false + false + false + false + 0 + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + false + false + false + false + false + 0 + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + false + false + false + false + false + 0 + true + + + + 1000 + false + + + + + + + + + diff --git a/examples/TimestampTimerExample.jmx b/examples/TimestampTimerExample.jmx deleted file mode 100644 index a04353e..0000000 --- a/examples/TimestampTimerExample.jmx +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - false - false - - - - - - - - continue - - false - -1 - - 1 - 1 - 1391782602000 - 1391782602000 - false - - - - - - - 1 - - - - true - true - 200 - OK - - - 0 - 0 - - - - false - - saveConfig - - - true - true - true - - true - true - true - true - false - true - true - false - false - false - false - false - false - false - false - 0 - true - - - - 1000 - false - - - - - - false - - saveConfig - - - true - true - true - - true - true - true - true - false - true - true - false - false - false - false - false - false - false - false - 0 - true - - - - - - - - - diff --git a/examples/TwoThreadPools-DummySampler.jmx b/examples/TwoThreadPools-DummySampler.jmx new file mode 100644 index 0000000..e604c5c --- /dev/null +++ b/examples/TwoThreadPools-DummySampler.jmx @@ -0,0 +1,215 @@ + + + + + + false + false + + + + + + + + startnextloop + + false + -1 + + 1 + 0 + 1381265134000 + 1381265134000 + false + + + + + + true + true + 200 + OK + + + 0 + 0 + + + + + 1 + + + + ${TIMESTAMP_ID} + CURRENT_ID + + + + + + continue + + false + -1 + + 100 + + 1359887691000 + 1359887704000 + false + 2 + 0 + + + + 1 + + 1 + COUNT + + false + + + + ${COUNT} <= ${TIMESTAMP_TOTAL} + false + + + + true + true + 200 + OK + ${ID} / ${TIMESTAMP_TOTAL} + ${ID} / ${TIMESTAMP_TOTAL} + 0 + 0 + + + + + ID + CURRENT_ID + + + + + + ${COUNT} > ${TIMESTAMP_TOTAL} + false + + + + 0 + 0 + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + false + false + false + false + false + 0 + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + false + false + false + false + false + 0 + true + + + + + + + false + + saveConfig + + + true + true + true + + true + true + true + true + false + true + true + false + false + false + false + false + false + false + false + 0 + true + + + + 1000 + false + + + + + + + + diff --git a/examples/modelTimeStamps.txt b/examples/timestamps.txt similarity index 100% rename from examples/modelTimeStamps.txt rename to examples/timestamps.txt diff --git a/src/org/apache/jmeter/timers/timestamp/TimestampTimer.java b/src/org/apache/jmeter/timers/timestamp/TimestampTimer.java index b7e69af..131a204 100644 --- a/src/org/apache/jmeter/timers/timestamp/TimestampTimer.java +++ b/src/org/apache/jmeter/timers/timestamp/TimestampTimer.java @@ -8,6 +8,8 @@ import org.apache.jmeter.testbeans.TestBean; import org.apache.jmeter.testelement.AbstractTestElement; import org.apache.jmeter.testelement.TestStateListener; +import org.apache.jmeter.threads.JMeterContext; +import org.apache.jmeter.threads.JMeterVariables; import org.apache.jmeter.timers.Timer; /** @@ -16,7 +18,7 @@ * contain relative timestamps in seconds. Each line in the timestamp file must * contain one timestamp which is followed by a semicolon (;). * One option for creating timestamp files is the workload modeling tool LIMBO: - * @see LIMBO Website + * @see LIMBO Website * * Examplary file content for a timestamp file: * 0.5; @@ -31,8 +33,8 @@ * ... and so on * * Its possible to configure 2 different usage modes (important when Timer is placed in Thread Group with more than 1 threads): - * - "Every thread in thread group uses all timestamps" - * - "Timestamps are shared by threads in threadgroup" + * - "Every thread in thread group uses all time stamps" + * - "Timestamps are shared by threads in thread group (every time stamp is used once)" * * When the first option is used every thread will delay its execution at the same points of time. * The second option allows "sharing" of timestamps between the thread. When the thread group contains @@ -42,8 +44,7 @@ * @author Andreas Weber */ public class TimestampTimer extends AbstractTestElement implements Timer, TestStateListener, TestBean { - - + private static final int SAFETY_DELAY = 1000; private static final long serialVersionUID = 240L; /** @@ -64,40 +65,58 @@ public String toString() { return propertyName; } } + + private class Timestamp { + public long id; + public long timestamp; + public Timestamp(long id, long timestamp) { + super(); + this.id = id; + this.timestamp = timestamp; + } + } /** * usage mode: does every thread use all timestamps or are they shared between threads in thread group (default) */ - private Mode usageMode = Mode.TimestampsSharedWithinThreadGroup; - private String timestampFile = ""; - long startTime; - private BlockingQueue timestampMillis = new LinkedBlockingQueue(); - private boolean started = false; - private long lastTimestamp = 0; + private Mode usageMode = Mode.TimestampsSharedWithinThreadGroup; + private String timestampFile = ""; + long startTime; + private BlockingQueue timestampList = new LinkedBlockingQueue(); + private boolean started = false; + private long lastTimestamp = 0; @Override public long delay() { - long delay = 0; - Long currentTimestamp = null; + Timestamp currentTimestamp = null; try { - currentTimestamp = timestampMillis.poll(10, + currentTimestamp = timestampList.poll(10, TimeUnit.MILLISECONDS); } catch (InterruptedException e) {} - - if (currentTimestamp == null) - { - // No timestamp left, let thread wait until end of test (otherwise it would produce samples where they should not appear) - currentTimestamp = lastTimestamp; - } - long plannedStart = startTime + currentTimestamp; + JMeterContext context = getThreadContext(); + JMeterVariables vars = context.getVariables(); + long plannedStart; + if (currentTimestamp != null) { + plannedStart = startTime + currentTimestamp.timestamp; + vars.put("TIMESTAMP_ID", Long.toString(currentTimestamp.id)); + } else { + // No timestamp left, delay thread until end of test. + plannedStart = startTime + lastTimestamp + SAFETY_DELAY; + vars.put("TIMESTAMP_ID", Long.toString(0)); + // Stops thread + // Be careful, the next sampler will be executed anyway! + // Thus the timer should always be embedded in an dummy sampler (if not every thread will produce one overhead sample) + context.getThread().stop(); + } long now = System.currentTimeMillis(); if (plannedStart > now) { delay = plannedStart - now; } + return delay; } @@ -106,24 +125,25 @@ public TimestampTimer() { super(); } - /** - * Initializes Timer. This means: - * - Timestamp file is read - * - Start time is saved - * - First timestamp which is intended to be used by the thread is selected - */ + private void readTimestampFile() { LinkedList timestamps = new LinkedList(); boolean timestampsAvailable = TimestampUtils.readTimestampFile(timestampFile, ";", timestamps); if (timestampsAvailable) { - timestampMillis.clear(); + timestampList.clear(); lastTimestamp = 0; - if (timestamps.size() > 0) + int numberOfTimestamps = timestamps.size(); + long count = 0; + if (numberOfTimestamps > 0) { - lastTimestamp = timestamps.get(timestamps.size()-1); - timestampMillis.addAll(timestamps); + lastTimestamp = timestamps.get(numberOfTimestamps-1); + for (long time : timestamps) + { + count++; + timestampList.add(new Timestamp(count, time)); + } } } } @@ -152,7 +172,17 @@ public void setFilename(String filename) { @Override public void testStarted() { started = true; - startTime = System.currentTimeMillis(); + JMeterContext context = getThreadContext(); + JMeterVariables vars = context.getVariables(); + String startTimeString = vars.get("TIMESTAMPTIMER_START"); + if (startTimeString != null) + { + startTime = Long.parseLong(startTimeString); + } else { + startTime = System.currentTimeMillis(); + vars.put("TIMESTAMPTIMER_START", Long.toString(startTime)); + vars.put("TIMESTAMP_TOTAL", Long.toString(timestampList.size())); + } } @@ -182,10 +212,10 @@ public Object clone() { clone.startTime = startTime; switch (usageMode) { case TimestampsSharedWithinThreadGroup: - clone.timestampMillis = timestampMillis; + clone.timestampList = timestampList; break; case AllThreadsUseAllTimestamps: - clone.timestampMillis = new LinkedBlockingQueue(timestampMillis); + clone.timestampList = new LinkedBlockingQueue(timestampList); break; } clone.started = started; diff --git a/src/org/apache/jmeter/timers/timestamp/TimestampTimerResources.properties b/src/org/apache/jmeter/timers/timestamp/TimestampTimerResources.properties index 4e7e0e6..ea6c74b 100644 --- a/src/org/apache/jmeter/timers/timestamp/TimestampTimerResources.properties +++ b/src/org/apache/jmeter/timers/timestamp/TimestampTimerResources.properties @@ -1,7 +1,7 @@ displayName=Timestamp Timer timestamp_timer.displayName=Configure Timestamp Timer filename.displayName=Timestamp File -filename.shortDescription=Name of the file (within your supporting file directory) that holds timestamp data +filename.shortDescription=Name of the file (within your supporting file directory) that holds time stamp data usageMode.displayName=Usage Mode -calcMode.1=Every thread in thread group uses all timestamps -calcMode.2=Timestamps are shared by threads in thread group (every timestamp is used once) \ No newline at end of file +calcMode.1=Every thread in thread group uses all time stamps +calcMode.2=Timestamps are shared by threads in thread group (every time stamp is used once) \ No newline at end of file diff --git a/src/org/apache/jmeter/timers/timestamp/TimestampUtils.java b/src/org/apache/jmeter/timers/timestamp/TimestampUtils.java index 890d7a1..451f8fd 100644 --- a/src/org/apache/jmeter/timers/timestamp/TimestampUtils.java +++ b/src/org/apache/jmeter/timers/timestamp/TimestampUtils.java @@ -13,7 +13,7 @@ * Timestamp files must contain relative timestamps in seconds. Each line in the timestamp file must * contain one timestamp which is followed by a semicolon (;). * One option for creating timestamp files is the workload modeling tool LIMBO: - * @see LIMBO Website + * @see LIMBO Website * * Examplary file content for a timestamp file: * 0.5;