Merge pull request #4 from PractiTest/readme-update

README + fix for populate command

Author: shmuelko

README.md

@@ -3,53 +3,47 @@
 You will need to use 'create-testset' action once and 'populate-testset' action every time there is a new report.
 If the structure of the report changes (new tests added for example), you will need to use 'create-testset' action again. New TestSet will be created, but existing tests will be reused.
 
+If you don't have exsiting CONFIG_FILE and you want to use it go to https://firecracker-ui-prod.practitest.com/ and generate one.
+To login you can use your PractiTest credentials, follow the instructions in the link and then you can continue here, set config-path to your configuration file path.
 ## Usage
 
+### help
+
+At every point you can run:
+
+``` shell
+java -jar practitest-firecracker-standalone.jar help
+```
+to get more information about the parameters and commands.
+
 ### create-testset
 
 Create new testset from reports folder:
 
 ``` shell
-java -jar practitest-firecracker-standaline.jar \
-    --api-token=YOUR_API_TOKEN \
-    --email=YOUR_EMAIL \
+java -jar practitest-firecracker-standalone.jar \
     --reports-path=SUREFIRE_REPORTS_PATH \
-    --project-id=PRACTITEST_PROJECT_ID \
     --testset-name="TestSet name" \
     --author-id=PRACTITEST_USER_ID \
+    --config-path=CONFIG_FILE \
     create-testset
 ```
 
 The call above will analyze the surefire reports and create tests and testset. If a test already exists, it will be reused.
-You can set various custom fields for tests when they are created (especially useful if you have mandatory fields configured in your tests).
-Here is an example for setting custom fields during creation of the tests and testset:
 
-``` shell
-java -jar practitest-firecracker-standaline.jar \
-    --api-token=YOUR_API_TOKEN \
-    --email=YOUR_EMAIL \
-    --reports-path=SUREFIRE_REPORTS_PATH \
-    --project-id=PRACTITEST_PROJECT_ID \
-    --testset-name="TestSet name" \
-    --author-id=PRACTITEST_USER_ID \
-    --additional-test-fields '{"custom-fields": {"---f-123": "foo", "---f-124": "bar"}}' \
-    --additional-testset-fields '{"custom-fields": {"---f-125": "baz"}}' \
-    create-testset
-
-```
+You can set various custom fields for tests when they are created (especially useful if you have mandatory fields configured in your tests).
 
-Replace the field ids with the actual IDs, you can see all your custom fields by calling this API call: [get-all-custom-fields-in-your-project](https://www.practitest.com/api-v2/#get-all-custom-fields-in-your-project)
+To set custom fields you will need to create configuration file in here https://firecracker-ui-prod.practitest.com/ after that you can use it to run the command line above with it (CONFIG_FILE).
 
 ### populate-testset
 Populate the testset from reports folder:
 
 ``` shell
-java -jar practitest-firecracker-standaline.jar \
-    --api-token=YOUR_API_TOKEN \
-    --email=YOUR_EMAIL \
+java -jar practitest-firecracker-standalone.jar \
     --reports-path=SUREFIRE_REPORTS_PATH \
-    --project-id=PRACTITEST_PROJECT_ID \
     --testset-id=PRACTITEST_TESTSET_ID \
+    --author-id=PRACTITEST_USER_ID \
+    --config-path=CONFIG_FILE \
     populate-testset
 ```
 
@@ -60,7 +54,29 @@ This will attempt to do the two actions above at once. It will search for TestSe
 Example:
 
 ``` shell
-java -jar practitest-firecracker-standaline.jar \
+java -jar practitest-firecracker-standalone.jar \
+    --reports-path=SUREFIRE_REPORTS_PATH \
+    --testset-name="TestSet name" \
+    --author-id=PRACTITEST_USER_ID \
+    --config-path=CONFIG_FILE \
+    create-and-populate-testset
+```
+### use Firecracker without config file
+
+You can use all the above command without the config file you will need to explicitly define
+parameters:
+--api-token=YOUR_API_TOKEN
+--email=YOUR_EMAIL
+--project-id=PRACTITEST_PROJECT_ID
+--additional-test-fields '{"custom-fields": {"---f-123": "foo", "---f-124": "bar"}, "system-fields"{"version": "2.3", "status":"Draft"}}'
+--additional-testset-fields '{"custom-fields": {"---f-125": "baz"}, "system-fields"{"version": "1.0", "assigned-to-id": "1"}}
+if they are relevant to the run (additional-fields not required).
+
+
+Example:
+
+``` shell
+java -jar practitest-firecracker-standalone.jar \
     --api-token=YOUR_API_TOKEN \
     --email=YOUR_EMAIL \
     --reports-path=SUREFIRE_REPORTS_PATH \
@@ -72,6 +88,9 @@ java -jar practitest-firecracker-standaline.jar \
     create-and-populate-testset
 ```
 
+You can set various custom fields for tests when they are created (especially useful if you have mandatory fields configured in your tests).
+
+Replace the field ids with the actual IDs, you can see all your custom fields by calling this API call: [get-all-custom-fields-in-your-project](https://www.practitest.com/api-v2/#get-all-custom-fields-in-your-project)
 
 ## License
 

src/practitest_firecracker/core.clj

@@ -51,10 +51,9 @@
 
           "populate-testset"
           (do
-            (populate-sf-results-old client
-                                     (:project-id options)
-                                     (:testset-id options)
-                                     additional-reports)
+            (populate-sf-results client
+                                 options
+                                 additional-reports)
             (exit 0 "Done"))
 
           "create-and-populate-testset"

src/practitest_firecracker/practitest.clj

@@ -10,7 +10,7 @@
 
 ;; ===========================================================================
 ;; api version
-(def ^:const fc-version "1.4.0")
+(def ^:const fc-version "1.1.1")
 
 ;; ===========================================================================
 ;; utils
@@ -381,7 +381,7 @@
   ;; otherwise -- go on
   (let [instances (ll-testset-instances client project-id testset-id)
         tests     (map (fn [test-suite]
-                         (let [name (str (:package-name test-suite) ":" (:name test-suite))]
+                         (let [name (:name test-suite)]
                            [name (ll-find-test client project-id name)]))
                        sf-test-suites)
         nil-tests (filter #(nil? (last %)) tests)]