Now it makes it possible to interpret a given path by evaluating any (#696)

Kavabungoz · Ilya Ulizko · web-flow · commit 830b1c808651 · 2025-02-26T17:07:33.000Z
* Now it makes it possible to interpret a given path by evaluating any embedded expressions.

* Backed to Java version to 1.8; Backed to standard default delimiter for CSV; Changed plugin version from 0.3 to 0.2

* updated the wiki

* fixed markdown

* Reverted formatting changes to the old 'GoogleCode' format.

* Now the dialog opens in the directory where the current .jmx file is located

* Imports fixed

* Reverted BrowseAction

---------

Co-authored-by: Ilya Ulizko &lt;ulizko.i.m@sberbank.ru&gt;
diff --git a/infra/common/pom.xml b/infra/common/pom.xml
@@ -4,7 +4,7 @@
 
     <groupId>kg.apc</groupId>
     <artifactId>jmeter-plugins-cmn-jmeter</artifactId>
-    <version>0.7</version>
+    <version>0.8</version>
 
     <name>JMeter Plugins Common Classes</name>
     <description>Various utility classes to ease development of plugins</description>
@@ -45,8 +45,8 @@
     </build>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <maven.compiler.source>1.7</maven.compiler.source>
-        <maven.compiler.target>1.7</maven.compiler.target>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
     </properties>
     <dependencies>
         <dependency>
diff --git a/infra/common/src/main/java/kg/apc/jmeter/gui/BrowseAction.java b/infra/common/src/main/java/kg/apc/jmeter/gui/BrowseAction.java
@@ -1,9 +1,12 @@
 package kg.apc.jmeter.gui;
 
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
+import org.apache.jmeter.services.FileServer;
+
 import javax.swing.JFileChooser;
 import javax.swing.JTextField;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.io.File;
 import org.apache.jmeter.gui.GuiPackage;
 
 public class BrowseAction implements ActionListener {
@@ -13,34 +16,36 @@ public class BrowseAction implements ActionListener {
     private String lastPath = ".";
 
     public BrowseAction(JTextField filename) {
-        control = filename;
+        this.control = filename;
     }
 
     public BrowseAction(JTextField filename, boolean isDirectoryBrowse) {
-        control = filename;
+        this.control = filename;
         this.isDirectoryBrowse = isDirectoryBrowse;
     }
 
-   @Override
+    @Override
     public void actionPerformed(ActionEvent e) {
         JFileChooser chooser = getFileChooser();
-        if (chooser != null) {
-            if(GuiPackage.getInstance() != null) {
-                int returnVal = chooser.showOpenDialog(GuiPackage.getInstance().getMainFrame());
-                if(returnVal == JFileChooser.APPROVE_OPTION) {
-                   control.setText(chooser.getSelectedFile().getPath());
-                }
-                lastPath = chooser.getCurrentDirectory().getPath();
+        if (chooser != null && GuiPackage.getInstance() != null) {
+            int returnVal = chooser.showOpenDialog(GuiPackage.getInstance().getMainFrame());
+            if (returnVal == JFileChooser.APPROVE_OPTION) {
+                control.setText(chooser.getSelectedFile().getPath());
             }
+            lastPath = chooser.getCurrentDirectory().getPath();
         }
     }
 
     protected JFileChooser getFileChooser() {
-        JFileChooser ret = new JFileChooser(lastPath);
-        if(isDirectoryBrowse) {
+        String baseDir = FileServer.getFileServer().getBaseDir();
+        File initialDirectory = baseDir != null && !baseDir.isEmpty()
+                ? new File(baseDir)
+                : new File(lastPath);
+
+        JFileChooser ret = new JFileChooser(initialDirectory);
+        if (isDirectoryBrowse) {
             ret.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
         }
-
         return ret;
     }
-}
+}
diff --git a/plugins/csvars/pom.xml b/plugins/csvars/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>kg.apc</groupId>
     <artifactId>jmeter-plugins-csvars</artifactId>
-    <version>0.1</version>
+    <version>0.2</version>
 
     <name>Variables from CSV</name>
     <description>Variables from CSV</description>
@@ -33,14 +33,14 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <maven.compiler.source>1.7</maven.compiler.source>
-        <maven.compiler.target>1.7</maven.compiler.target>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
     </properties>
     <dependencies>
         <dependency>
             <groupId>kg.apc</groupId>
             <artifactId>jmeter-plugins-cmn-jmeter</artifactId>
-            <version>0.3</version>
+            <version>0.7</version>
         </dependency>
         <dependency>
             <groupId>org.powermock</groupId>
@@ -58,6 +58,12 @@
             <groupId>kg.apc</groupId>
             <artifactId>jmeter-plugins-emulators</artifactId>
             <version>0.2</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.slf4j</groupId>
+                    <artifactId>slf4j-nop</artifactId>
+                </exclusion>
+            </exclusions>
             <scope>test</scope>
         </dependency>
     </dependencies>
diff --git a/plugins/csvars/src/main/java/kg/apc/jmeter/config/VariablesFromCSV.java b/plugins/csvars/src/main/java/kg/apc/jmeter/config/VariablesFromCSV.java
@@ -1,6 +1,9 @@
 package kg.apc.jmeter.config;
 
 import org.apache.jmeter.config.Arguments;
+import org.apache.jmeter.engine.util.CompoundVariable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.Map;
 
@@ -12,25 +15,54 @@ public class VariablesFromCSV extends Arguments {
     public static final String SKIP_LINES = "skipLines";
     public static final int SKIP_LINES_DEFAULT = 0;
     public static final String STORE_SYS_PROP = "storeSysProp";
+    private static final Logger log = LoggerFactory.getLogger(VariablesFromCSV.class);
 
-    // It seems org.apache.jmeter.engine.Precompiler requires only this
-    // https://groups.google.com/forum/#!topic/jmeter-plugins/gWn7MTgvTfE method
     @Override
     public Map<String, String> getArgumentsAsMap() {
-        Map<String, String> variables = new VariableFromCsvFileReader(getFileName()).getDataAsMap(getVariablePrefix(), getSeparator(), getSkipLines());
-        //store in System Properties also
+        String fileName = getFileName();
+        String interpretedPath = interpretPath(fileName);
+
+        Map<String, String> variables = new VariableFromCsvFileReader(interpretedPath)
+                .getDataAsMap(getVariablePrefix(), getSeparator(), getSkipLines());
+
         if (isStoreAsSystemProperty()) {
-            for (Map.Entry<String, String> element : variables.entrySet()) {
-                String variable = element.getKey();
+            for (Map.Entry<String, String> entry : variables.entrySet()) {
+                String variable = entry.getKey();
                 if (System.getProperty(variable) == null) {
-                    System.setProperty(variable, element.getValue());
+                    System.setProperty(variable, entry.getValue());
                 }
             }
         }
 
         return variables;
     }
 
+    /**
+     * Interprets the given path by evaluating any embedded expressions.
+     *
+     * @param rawPath the raw path string that may contain expressions
+     * @return the interpreted path
+     */
+    public String interpretPath(String rawPath) {
+        if (rawPath == null || rawPath.isEmpty()) {
+            return rawPath;
+        }
+
+        try {
+            CompoundVariable compoundVariable = new CompoundVariable(rawPath);
+            String interpretedPath = compoundVariable.execute().trim();
+
+            if (!interpretedPath.isEmpty() && !new java.io.File(interpretedPath).exists()) {
+                throw new IllegalArgumentException("Interpreted path does not exist: " + interpretedPath);
+            }
+
+            return interpretedPath;
+        } catch (Exception ex) {
+            log.error("Error interpreting path: " + rawPath, ex);
+            throw new RuntimeException("Failed to interpret path: " + rawPath, ex);
+        }
+    }
+
     public String getVariablePrefix() {
         return getPropertyAsString(VARIABLE_PREFIX);
     }
diff --git a/plugins/csvars/src/main/java/kg/apc/jmeter/config/VariablesFromCSVGui.java b/plugins/csvars/src/main/java/kg/apc/jmeter/config/VariablesFromCSVGui.java
@@ -18,17 +18,21 @@
 import kg.apc.jmeter.gui.IntegerInputVerifier;
 import org.apache.jmeter.config.gui.AbstractConfigGui;
 import org.apache.jmeter.testelement.TestElement;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 public class VariablesFromCSVGui extends AbstractConfigGui {
 
     public static final String WIKIPAGE = "VariablesFromCSV";
 
+    private static final Logger log = LoggerFactory.getLogger(VariablesFromCSVGui.class);
+
     private JTextField fileName;
     private JTextField variablePrefix;
     private JTextField separator;
     private JTextField skipLines;
     private JCheckBox storeSysProp;
-    
+
     private JButton browseButton;
     private JButton checkButton;
     private JTextArea checkInfo;
@@ -39,11 +43,13 @@ public VariablesFromCSVGui() {
         initFields();
     }
 
+
     @Override
     public String getStaticLabel() {
         return JMeterPluginsUtils.prefixLabel("Variables From CSV File");
     }
 
+
     @Override
     public String getLabelResource() {
         return getClass().getCanonicalName();
@@ -53,7 +59,7 @@ public String getLabelResource() {
     public void configure(TestElement element) {
         super.configure(element);
         if (element instanceof VariablesFromCSV) {
-            VariablesFromCSV varsCsv = (VariablesFromCSV)element;
+            VariablesFromCSV varsCsv = (VariablesFromCSV) element;
             fileName.setText(varsCsv.getFileName());
             variablePrefix.setText(varsCsv.getVariablePrefix());
             separator.setText(varsCsv.getSeparator());
@@ -107,6 +113,7 @@ private void init() {
 
         addToPanel(mainPanel, labelConstraints, 0, 0, new JLabel("CSV File: ", JLabel.RIGHT));
         addToPanel(mainPanel, editConstraints, 1, 0, fileName = new JTextField(20));
+        fileName.setToolTipText("You can use expressions like ${__groovy(...)} for dynamic paths.");
         addToPanel(mainPanel, labelConstraints, 2, 0, browseButton = new JButton("Browse..."));
 
         GuiBuilderHelper.strechItemToComponent(fileName, browseButton);
diff --git a/site/dat/wiki/VariablesFromCSV.wiki b/site/dat/wiki/VariablesFromCSV.wiki
@@ -2,23 +2,23 @@
 
 <span class=''>[/?search=jpgc-csvars <i class='fa fa-download'></i> Download]</span>
 
-This Config item allows you to load variable values from CSV file. Variable names and values taken from CSV file, name from first column, value from second column, respectively.
+This Config item allows you to load variable values from CSV file. Variable names and values taken from CSV file, name from first column, value from second column, respectively. In the <i>CSV File:</i> window, you can specify the absolute path to your csv file. However, to make your test plans more portable, you can also use dynamic path by evaluating ${} expressions.
 
 == Tutorial ==
-Let's create a text file _c:\temp\testvariables.csv_ with following content:
+Let's create a text file <i>c:\temp\testvariables.csv</i> with following content:
 
 {{{
 First_Variable,here comes value 1
 Second_Variable,and here value 2
-}}} 
+}}}
 
-Let's create test plan with _Variables From CSV File_, _Thread Group_, _Debug Sampler_ and _View Results Tree_. Then configure _Variables From CSV File_, give it filename _testvariables.csv_, optional variable prefix `MyVar_` and column separator ','. Now your plan should look like this:
+1. To use the absolute path, let's create test plan with <i>Variables From CSV File</i>, <i>Thread Group</i>, <i>Debug Sampler</i> and <i>View Results Tree</i>. Then configure <i>Variables From CSV File</i>, specify the absolute path to <i>testvariables.csv</i>, optional variable prefix `MyVar_` and column separator ','. Now your plan should look like this:
 
-[/img/wiki/varsfromcsv1.png]
+[/site/img/wiki/varsfromcsv1.png]
 
-Save this test plan to _c:\temp\test1.jmx_.
+Save this test plan to <i>c:\temp\test1.jmx</i>.
 
-Now, run the test, go to _View Results Tree_ and click on _Debug Sampler_, then click on _Response data_ tab. You'll see that your variables from _testvariables.csv_ are defined in JMeter, e.g.:
+Now, run the test, go to <i>View Results Tree</i> and click on <i>Debug Sampler</i>, then click on <i>Response data</i> tab. You'll see that your variables from <i>testvariables.csv</i> are defined in JMeter, e.g.:
 
 {{{
 JMeterVariables:
@@ -30,4 +30,12 @@ START.HMS=153028
 START.MS=1264671028968
 START.YMD=20100128
 TESTSTART.MS=1264671163750
-}}}
+}}}
+
+2. To use dynamic path you should specify expressions enclosed in ${}, e.g.:
+
+{{{${__groovy(import org.apache.jmeter.services.FileServer; FileServer.getFileServer().getBaseDir();,)}${__groovy(File.separator;,)}resources${__groovy(File.separator;,)}properties.csv}}}
+
+This expression dynamically resolves the path (like <i>D:\JAVA_pet_projects\resources\properties.csv</i>) relative to the directory of the current <i>.jmx</i> file.
+
+[/site/img/wiki/varsfromcsv2.png]
diff --git a/site/img/wiki/varsfromcsv2.png b/site/img/wiki/varsfromcsv2.png
