Merge pull request #38 from testmonitor/add-find-or-create-folders

Author: thijskok

pom.xml

@@ -6,7 +6,7 @@
     <groupId>com.testmonitor</groupId>
     <artifactId>api-java-client</artifactId>
     <packaging>jar</packaging>
-    <version>2.0.0</version>
+    <version>2.0.4</version>
 
     <name>TestMonitorClient</name>
     <description>TestMonitor API client</description>

src/main/java/com/testmonitor/actions/TestCaseFolders.java

@@ -2,7 +2,9 @@
 
 import com.testmonitor.api.Connector;
 import com.testmonitor.parsers.TestCaseFolderParser;
+import com.testmonitor.parsers.TestCaseParser;
 import com.testmonitor.resources.Project;
+import com.testmonitor.resources.TestCase;
 import com.testmonitor.resources.TestCaseFolder;
 import org.apache.hc.core5.http.NameValuePair;
 import org.apache.hc.core5.http.message.BasicNameValuePair;
@@ -93,7 +95,7 @@ public TestCaseFolder get(Integer id) throws IOException, URISyntaxException {
     /**
      * Create a test case folder
      *
-     * @param testCaseFolder The test case your want to create
+     * @param testCaseFolder The name of the test case folder
      *
      * @return The created test case folder
      */
@@ -110,7 +112,7 @@ public TestCaseFolder create(TestCaseFolder testCaseFolder) throws IOException {
     /**
      * Create a test case folder
      *
-     * @param name The test case folder name you want to create
+     * @param name The name of the test case folder
      *
      * @return The created test case folder
      */
@@ -123,14 +125,14 @@ public TestCaseFolder create(String name) throws IOException {
     }
 
     /**
-     * Create a test case subfolder
+     * Create a test case folder
      *
      * @param name The name of the test case folder
      * @param parent The parent folder
      *
      * @return The created test case folder
      */
-    public TestCaseFolder createSubfolder(String name, TestCaseFolder parent) throws IOException {
+    public TestCaseFolder create(String name, TestCaseFolder parent) throws IOException {
         TestCaseFolder testCaseFolder = new TestCaseFolder();
 
         testCaseFolder
@@ -142,14 +144,14 @@ public TestCaseFolder createSubfolder(String name, TestCaseFolder parent) throws
     }
 
     /**
-     * Create a test case subfolder
+     * Create a test case folder
      *
      * @param child The name of the test case folder
      * @param parent The parent folder
      *
      * @return The created test case folder
      */
-    public TestCaseFolder createSubfolder(TestCaseFolder child, TestCaseFolder parent) throws IOException {
+    public TestCaseFolder create(TestCaseFolder child, TestCaseFolder parent) throws IOException {
         return this.create(child.setParent(parent));
     }
 
@@ -200,6 +202,87 @@ public TestCaseFolder clone(TestCaseFolder source, String name) throws IOExcepti
         return this.clone(source, name, true, true);
     }
 
+    /**
+     * Find a test case folder using the provided name or create a new one.
+     *
+     * @param name The provided name and parent folder
+     *
+     * @return A test case folder matching the name or a new test case folder
+     */
+    public TestCaseFolder findOrCreate(String name) throws IOException, URISyntaxException {
+        ArrayList<TestCaseFolder> testCaseFolders = this.findByName(name);
+
+        if (testCaseFolders.size() > 0) {
+            return testCaseFolders.get(0);
+        }
+
+        return this.create(name);
+    }
+
+    /**
+     * Find a test case folder using the provided name and parent folder or create a new one.
+     *
+     * @param name The name of the test case folder
+     * @param parent The parent folder
+     *
+     * @return A test case folder matching the name or a new test case folder
+     */
+    public TestCaseFolder findOrCreate(String name, TestCaseFolder parent) throws IOException, URISyntaxException {
+        ArrayList<TestCaseFolder> testCaseFolders = this.findByName(name, parent);
+
+        if (testCaseFolders.size() > 0) {
+            return testCaseFolders.get(0);
+        }
+
+        return this.create(name, parent);
+    }
+
+    /**
+     * Find a test case folder using the provided name.
+     *
+     * @param name The name of the test case folder
+     *
+     * @return Test case folders matching the provided name.
+     */
+    public ArrayList<TestCaseFolder> findByName(String name) throws IOException, URISyntaxException {
+        List<NameValuePair> params = new ArrayList<>();
+
+        params.add(new BasicNameValuePair("project_id", this.projectId.toString()));
+        params.add(new BasicNameValuePair("filter[name]", name));
+
+        return TestCaseFolderParser.parse(this.connector.get("test-case/folders", params));
+    }
+
+    /**
+     * Find a test case folder using the provided name and parent folder id
+     *
+     * @param name The name of the test case folder
+     * @param parentId The id of the parent folder
+     *
+     * @return Test case folders matching the provided name.
+     */
+    public ArrayList<TestCaseFolder> findByName(String name, Integer parentId) throws IOException, URISyntaxException {
+        List<NameValuePair> params = new ArrayList<>();
+
+        params.add(new BasicNameValuePair("project_id", this.projectId.toString()));
+        params.add(new BasicNameValuePair("parent_id", parentId.toString()));
+        params.add(new BasicNameValuePair("filter[name]", name));
+
+        return TestCaseFolderParser.parse(this.connector.get("test-case/folders", params));
+    }
+
+    /**
+     * Find a test case folder using the provided name and parent folder
+     *
+     * @param name The name of the test case folder
+     * @param parent The parent folder
+     *
+     * @return Test case folders matching the provided name.
+     */
+    public ArrayList<TestCaseFolder> findByName(String name, TestCaseFolder parent) throws IOException, URISyntaxException {
+        return this.findByName(name, parent.getId());
+    }
+
     /**
      * Update a test case folder.
      *