Merge pull request #16 from PractiTest/support-PAT-without-author-id

shmuelko · web-flow · commit 03ea76c4956e · 2022-06-21T13:30:36.000+03:00
support run without author-id and display better error messages
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # practitest-firecracker
 
-You will need to use the 'create-testset' action once and the 'populate-testset' action every time there is a new report.
-If the structure of the report changes (new tests are added for example), you will need to use the 'create-testset' action again. New TestSets will be created, but existing tests will be reused.
+You will need to use the 'create-and-populate-testset' action that will create and populate TestSets, Tests, Instances and Runs.
+If the structure of the report changes (new tests are added for example), you will need to use the 'create-and-populate-testset' action again. New TestSets will be created, but existing tests will be reused.
 
 If you don't have an existing 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 and follow the instructions in the link. Then you can continue here and set the config-path to your configuration file path.
@@ -23,35 +23,12 @@ java -jar practitest-firecracker-standalone.jar help
 ```
 to get more information about the parameters and commands.
 
-### create-testset
+### version
 
-Create new testset from reports folder:
+To check your jar version you can you this command:
 
 ``` shell
-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-testset
-```
-
-The call above will analyze the surefire reports and create tests and the 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).
-
-To set custom fields you will need to create a 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-standalone.jar \
-    --reports-path=SUREFIRE_REPORTS_PATH \
-    --testset-id=PRACTITEST_TESTSET_ID \
-    --author-id=PRACTITEST_USER_ID \
-    --config-path=CONFIG_FILE \
-    populate-testset
+java -jar practitest-firecracker-standalone.jar version
 ```
 
 ### create-and-populate-testset
@@ -62,32 +39,39 @@ Example:
 
 ``` shell
 java -jar practitest-firecracker-standalone.jar \
-    --reports-path=SUREFIRE_REPORTS_PATH \
-    --testset-name="TestSet name" \
+    --reports-path=REPORTS_FOLDER_PATH \
     --author-id=PRACTITEST_USER_ID \
     --config-path=CONFIG_FILE \
     create-and-populate-testset
 ```
-* In the future config files --testset-name will be defined inside of the config file so there will be no need to define it in the command line
+* author-id is not required in case of PAT (personal api token) is in use
+
+The call above will analyze the surefire reports and create and populate tests and the 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).
+
+To set custom fields you will need to create a 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).
+
 ### use Firecracker without config file
 
 You can use all the above commands without the config file. You will need to explicitly define
 parameters:
 --api-token=YOUR_API_TOKEN
 --email=YOUR_EMAIL
+--testset-name=TESTSET_NAME
 --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"}}
+--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 \
+    --testset-name=TESTSET_NAME \
+    --reports-path=REPORTS_FOLDER_PATH \
     --project-id=PRACTITEST_PROJECT_ID \
     --testset-name="TestSet name" \
     --author-id=PRACTITEST_USER_ID \
@@ -118,6 +102,11 @@ In case you want the name of the test to take its value from other attribute of
 
 Same goes for --pt-test-step-name that will define the name of the steps.
 
+--multitestset option will point if we are using multitestset file if it is true we will take the testsetname from
+the name attribute from inside the file.
+
+--test-case-as-pt-test-step will declare if we want to set testcase as single test or as a group of testcases.
+
 For more information contact our support.
 
 ## License
diff --git a/src/practitest_firecracker/cli.clj b/src/practitest_firecracker/cli.clj
@@ -66,19 +66,16 @@
    ["-h" "--help"]])
 
 (defn usage [options-summary]
-  (->> ["PractiTest Surefire reports analyzer."
+  (->> ["PractiTest reports analyzer."
         ""
         "Usage: java -jar practitest-firecracker-standaline.jar [options] action"
         ""
         "Options:"
         options-summary
         ""
         "Actions:"
-        "  create-testset              Analyzes the given Surefire reports directory and creates a TestSet with Tests and Steps in PractiTest to reflect"
-        "                              the structure of the report. Returns a TestSet ID that you should use to run the 'populate-testset' action"
-        "  populate-testset            Analyzes the given Surefire reports directory and populates the given TestSet with the data from the report"
-        "  create-and-populate-testset Shortcut to perform both actions. If the TestSet with the given name already exists, it will be reused. If it exists, but has completely different set of tests, an error will be reported."
-        ""]
+        "  create-and-populate-testset  Shortcut to perform both actions. If the TestSet with the given name already exists, it will be reused. If it exists, but has completely different set of tests, an error will be reported."
+        "  version                      Will display firecracker jar file version"]
        (string/join \newline)))
 
 (defn error-msg [errors]
@@ -111,48 +108,19 @@
       {:exit-message (error-msg errors)}
 
       (= "display-config" (first arguments))
-      (cond
-        :else
-        {:action "display-config" :options options})
+      {:action "display-config" :options options}
 
       (= "display-options" (first arguments))
-      (cond
-        :else
-        {:action "display-options" :options options})
-
-      ;; (= "create-testset" (first arguments))
-      ;; (cond
-      ;;   (nil? (:project-id options))
-      ;;   {:exit-message (missing-option-msg "create-testset" "project-id")}
-
-      ;;   (nil? (:author-id options))
-      ;;   {:exit-message (missing-option-msg "create-testset" "author-id")}
-
-      ;;   (nil? (:testset-name options))
-      ;;   {:exit-message (missing-option-msg "create-testset" "testset-name")}
+      {:action "display-options" :options options}
 
-      ;;   :else
-      ;;   {:action "create-testset" :options options})
-
-      (= "populate-testset" (first arguments))
-      (cond
-        (nil? (:project-id options))
-        {:exit-message (missing-option-msg "populate-testset" "project-id")}
-
-        (nil? (:testset-id options))
-        {:exit-message (missing-option-msg "populate-testset" "testset-id")}
-
-        :else
-        {:action "populate-testset" :options options})
+      (= "version" (first arguments))
+      {:action "version" :options options}
 
       (= "create-and-populate-testset" (first arguments))
       (cond
         (nil? (:project-id options))
         {:exit-message (missing-option-msg "create-and-populate-testset" "project-id")}
 
-        (nil? (:author-id options))
-        {:exit-message (missing-option-msg "create-and-populate-testset" "author-id")}
-
         (and (nil? (:testset-name options)) (not (:multitestset options)))
         {:exit-message (missing-option-msg "create-and-populate-testset" "testset-name")}
 
diff --git a/src/practitest_firecracker/core.clj b/src/practitest_firecracker/core.clj
@@ -3,22 +3,19 @@
    [practitest-firecracker.cli         :refer [parse-args]]
    [practitest-firecracker.practitest  :refer [make-client
                                                make-runs
-                                               populate-sf-results
                                                create-testsets
                                                group-tests
                                                create-or-update-tests
                                                create-instances
-                                               create-runs]]
+                                               create-runs
+                                               fc-version]]
    [practitest-firecracker.parser.core :refer [send-directory parse-files]]
+   [practitest-firecracker.utils       :refer [exit]]
    [clojure.pprint                     :as     pprint]
    [clojure.java.io                    :refer [file]]
    [clj-time.core                      :as     t])
   (:gen-class))
 
-(defn exit [status msg]
-  (println msg)
-  (System/exit status))
-
 (defmacro timef
   [module expr]
   `(let [start# (. System (nanoTime))
@@ -33,8 +30,8 @@
       (exit (if ok? 0 1) exit-message)
       (let [client             (make-client (select-keys options [:email :api-token :api-uri :max-api-rate]))
             directory          (:reports-path options)
-            dirs               (for [dir directory] (clojure.java.io/file dir))
-            parsed-dirs        (for [dir (file-seq (first dirs))] (parse-files dir))
+            dirs               (when-not (nil? directory) (for [dir directory] (clojure.java.io/file dir)))
+            parsed-dirs        (when-not (nil? dirs) (for [dir (file-seq (first dirs))] (parse-files dir)))
             additional-reports (send-directory parsed-dirs (:test-case-as-pt-test-step options) (:multitestset options) (:testset-name options) false)
             start-time         (t/now)]
           (case action
@@ -48,26 +45,8 @@
               (pprint/pprint {"=============== options: ===============" options})
               (pprint/pprint {"=============== args: ===============" args}))
 
-            ;; "create-testset"
-            ;; (do
-            ;;   (doall
-            ;;    (pmap
-            ;;     (fn [report]
-            ;;       (let [testset (create-or-update-sf-testset client options report)]
-            ;;         (pprint/pprint (format "Populated TestSet ID: %s" (:id testset)))))
-            ;;     additional-reports))
-            ;;   (exit 0 "Done"))
-
-            "populate-testset"
-            (do
-              (doall
-               (pmap
-                (fn [report]
-                  (populate-sf-results client
-                                       options
-                                       report))
-                additional-reports))
-              (exit 0 "Done"))
+            "version"
+            (println "Version: " fc-version)
 
             "create-and-populate-testset"
             (do
diff --git a/src/practitest_firecracker/practitest.clj b/src/practitest_firecracker/practitest.clj
@@ -5,14 +5,15 @@
    [clojure.walk                     :refer [postwalk]]
    [clj-http.client                  :as http]
    [clojure.tools.logging            :as log]
+   [cheshire.core                    :as json]
    [practitest-firecracker.query-dsl :refer [query? eval-query]]
    [throttler.core                   :refer [fn-throttler]]
-   [practitest-firecracker.utils     :refer [parse-id print-run-time test-need-update?]]
+   [practitest-firecracker.utils     :refer [parse-id print-run-time test-need-update? exit group-errors]]
    [clojure.pprint                   :as     pprint]))
 
 ;; ===========================================================================
 ;; api version
-(def ^:const fc-version "2.0.2")
+(def ^:const fc-version "2.0.4")
 
 ;; ===========================================================================
 ;; utils
@@ -32,9 +33,7 @@
   (apply format (str base-uri resource-uri-template) params))
 
 (defn throw-api-exception [ex-info status body uri]
-  (throw (ex-info "API request failed" {:status status
-                                        :body   body
-                                        :uri    uri})))
+  (exit status (group-errors body)))
 
 (defn api-call [{:keys [credentials uri method query-params form-params]}]
   (assert (not (and query-params form-params))
@@ -490,21 +489,6 @@
                    :attributes run
                    :steps run-steps}))))))
 
-(defn populate-sf-results [client {:keys [project-id testset-id display-action-logs] :as options} sf-test-suites]
-  (when display-action-logs (log/infof "populating testset %s with results from %d suites" testset-id (count sf-test-suites)))
-  (when (or (:skip-validation? options)
-            (validate-testset client project-id testset-id sf-test-suites))
-    (doall
-     (pmap (fn [test-suite]
-             (let [test-name       (sf-test-suite->pt-test-name options test-suite)
-                   log             (if display-action-logs (log/infof "instance test-name: %s " test-name) nil)
-                   test            (ll-find-test client [project-id display-action-logs] test-name)
-                   instance        (ll-find-instance client [project-id display-action-logs] testset-id (:id test))
-                   [run run-steps] (sf-test-suite->run-def options test-suite)]
-               (ll-create-run client [project-id display-action-logs] (:id instance) run run-steps)))
-           sf-test-suites))
-    true))
-
 (defn find-sf-testset [client [project-id display-action-logs] options testset-name]
   (let [testset (ll-find-testset client [project-id display-action-logs] testset-name)]
     (when testset
diff --git a/src/practitest_firecracker/query_dsl.clj b/src/practitest_firecracker/query_dsl.clj
@@ -55,6 +55,12 @@
                                (throw
                                 (ex-info "Syntax error: 'drop-last' must have one or two arguments"
                                          {:query query})))
+        'take-last           (case (count args)
+                               1 (take-last 1 (first args))
+                               2 (take-last (first args) (second args))
+                               (throw
+                                 (ex-info "Syntax error: 'take-last' must have one or two arguments"
+                                          {:query query})))
         'concat              (apply str args)
         'capitalize          (if (= 1 (count args))
                                (map string/capitalize (first args))
diff --git a/src/practitest_firecracker/utils.clj b/src/practitest_firecracker/utils.clj
@@ -1,7 +1,9 @@
 (ns practitest-firecracker.utils
   (:require
    [clj-time.core                      :as t]
-   [clojure.pprint                     :as pprint]))
+   [clojure.pprint                     :as pprint]
+   [clojure.string                     :as string]
+   [cheshire.core                      :as json]))
 
 (defn print-run-time [text start-time]
   (let [sec-pass   (t/in-seconds (t/interval start-time (t/now)))
@@ -21,3 +23,10 @@
                             ;; :test test})
         ]
     true))
+
+(defn exit [status msg]
+  (println msg)
+  (System/exit status))
+
+(defn group-errors [body]
+  (str "Errors: \n" (string/join "\n" (map #(str "- " %) (map :title (:errors (json/parse-string body true)))))))
