scripts/scufl2-info/test/scufl2_info/test/handler.clj

;   Licensed to the Apache Software Foundation (ASF) under one or more
;   contributor license agreements.  See the NOTICE file distributed with
;   this work for additional information regarding copyright ownership.
;   The ASF licenses this file to You 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.
;
(ns scufl2-info.test.handler
  (:use clojure.test
        scufl2-info.util
        ring.mock.request  
        cheshire.core 
        scufl2-info.handler))

(defn test-workflow-bundle [wfbundle]
    (is (not (nil? wfbundle)))
    (is (= (get wfbundle "@id") "http://ns.taverna.org.uk/2010/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/" ))
    (is (= (get wfbundle "@type") "WorkflowBundle"))
    (is (contains? wfbundle "@context"))
    (is (= (get-in wfbundle ["@context" "@vocab"]) "http://ns.taverna.org.uk/2010/scufl2#"))
    (is (= (get-in wfbundle ["@context" "@base"]) "http://ns.taverna.org.uk/2010/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/")))

(defn test-workflow-run [run]
    (is (not (nil? run)))
    (is (= (get run "@id") "http://ns.taverna.org.uk/2011/run/745c1f72-d57b-45ee-a7cc-437358f91e45/" ))
    (is (= (get run "@type") "WorkflowRun"))
    (is (contains? run "wasEnactedBy"))
    (is (= (get-in run ["wasEnactedBy" "@type"]) "tavernaprov:TavernaEngine" ))
    (is (contains? run "@context"))
     (is (= (get-in run ["@context" "@vocab"]) "http://purl.org/wf4ever/wfprov#"))
    (is (= (get-in run ["@context" "tavernaprov"]) "http://ns.taverna.org.uk/2012/tavernaprov/"))
    (is (= (get-in run ["@context" "@base"]) "http://ns.taverna.org.uk/2011/run/745c1f72-d57b-45ee-a7cc-437358f91e45/")))

(defn test-process-run [run]
    (is (not (nil? run)))
    (is (= (get run "@id") "process/ee12ac67-8cbc-440d-b3c0-b959257d154a/" ))
    (is (= (get run "@type") "ProcessRun"))
    (is (contains? run "wasEnactedBy"))
    (is (= (get-in run ["wasEnactedBy" "@type"]) "tavernaprov:TavernaEngine" ))
    (is (contains? run "@context"))
    (is (= (get-in run ["@context" "@vocab"]) "http://purl.org/wf4ever/wfprov#"))
    (is (= (get-in run ["@context" "tavernaprov"]) "http://ns.taverna.org.uk/2012/tavernaprov/"))
    (is (= (get-in run ["@context" "@base"]) "http://ns.taverna.org.uk/2011/run/745c1f72-d57b-45ee-a7cc-437358f91e45/")))

(defn test-data-reference [data]
  (is (not (nil? data)))
  (is (= (get data "@id") "http://ns.taverna.org.uk/2011/data/745c1f72-d57b-45ee-a7cc-437358f91e45/ref/d2079164-3cd8-4b58-b6ff-c3bf61e3e04e/"))
  ; TODO: Should there be a tavernaprov:Value or something?
  (is (in? (get data "@type") "Artifact"))
  (is (in? (get data "@type") "prov:Entity"))
  (is (= (get data "involvedInRun") "http://ns.taverna.org.uk/2011/run/745c1f72-d57b-45ee-a7cc-437358f91e45/"))
  (is (= (get-in data ["@context" "@vocab"]) "http://purl.org/wf4ever/wfprov#"))
  (is (= (get-in data ["@context" "tavernaprov"]) "http://ns.taverna.org.uk/2012/tavernaprov/")))

(defn test-data-list [data]
  (is (not (nil? data)))
  (is (= (get data "@id") "http://ns.taverna.org.uk/2011/data/745c1f72-d57b-45ee-a7cc-437358f91e45/list/486b0d87-74d4-49d5-8dad-fb64bf65ac80/false/1"))
  (is (in? (get data "@type") "prov:Collection"))
  (is (in? (get data "@type") "Artifact"))
  (is (in? (get data "@type") "prov:Entity"))
  (is (= (get data "depth") 1))
  (is (= (get data "involvedInRun") "http://ns.taverna.org.uk/2011/run/745c1f72-d57b-45ee-a7cc-437358f91e45/"))
  (is (= (get-in data ["@context" "@vocab"]) "http://purl.org/wf4ever/wfprov#"))
  (is (= (get-in data ["@context" "tavernaprov"]) "http://ns.taverna.org.uk/2012/tavernaprov/")))

(defn test-data-list-error [data]
  (is (not (nil? data)))
  (is (= (get data "@id") "http://ns.taverna.org.uk/2011/data/745c1f72-d57b-45ee-a7cc-437358f91e45/list/6b6ba3ed-d526-4d26-b16c-92976bf409fb/true/2"))
  (is (in? (get data "@type") "prov:Collection"))
  (is (in? (get data "@type") "Artifact"))
  (is (in? (get data "@type") "prov:Entity"))
  (is (in? (get data "@type") "tavernaprov:ContainsError"))
  (is (= (get data "depth") 2))
  (is (= (get data "involvedInRun") "http://ns.taverna.org.uk/2011/run/745c1f72-d57b-45ee-a7cc-437358f91e45/"))
  (is (= (get-in data ["@context" "@vocab"]) "http://purl.org/wf4ever/wfprov#"))
  (is (= (get-in data ["@context" "tavernaprov"]) "http://ns.taverna.org.uk/2012/tavernaprov/")))

(defn test-data-error [data]
  (is (not (nil? data)))
  (is (= (get data "@id") "http://ns.taverna.org.uk/2011/data/745c1f72-d57b-45ee-a7cc-437358f91e45/error/d93b2a9c-49f7-436a-9861-54320b8a77ae/0"))
  (is (in? (get data "@type") "Artifact"))
  (is (in? (get data "@type") "prov:Entity"))
  (is (in? (get data "@type") "tavernaprov:Error"))
  (is (= (get data "depth") 0))
  (is (= (get data "involvedInRun") "http://ns.taverna.org.uk/2011/run/745c1f72-d57b-45ee-a7cc-437358f91e45/"))
  (is (= (get-in data ["@context" "@vocab"]) "http://purl.org/wf4ever/wfprov#"))
  (is (= (get-in data ["@context" "tavernaprov"]) "http://ns.taverna.org.uk/2012/tavernaprov/")))


(defn test-workflow [workflow]
  (is (not (nil? workflow)))
  (is (= (get workflow "name") "HelloWorld"))
  (is (= (get workflow "@id") "workflow/HelloWorld/"))
  (is (= (get workflow "@type") "Workflow")))

(defn test-input-workflow-port [port]
  (is (not (nil? port)))
  (is (= (get port "name") "name"))
  (is (= (get port "@id") "workflow/HelloWorld/in/name"))
  (is (= (get port "@type") "InputWorkflowPort")))

(defn test-output-workflow-port [port]
  (is (not (nil? port)))
  (is (= (get port "name") "greeting"))
  (is (= (get port "@id") "workflow/HelloWorld/out/greeting"))
  (is (= (get port "@type") "OutputWorkflowPort")))

(defn test-processor [processor]
  (is (not (nil? processor)))
  (is (= (get processor "name") "hello"))
  (is (= (get processor "@id") "workflow/HelloWorld/processor/hello/"))
  (is (= (get processor "@type") "Processor")))

(defn test-input-processor-port [port]
  (is (not (nil? port)))
  (is (= (get port "name") "name"))
  (is (= (get port "@id") "workflow/HelloWorld/processor/hello/in/name"))
  (is (= (get port "@type") "InputProcessorPort")))


(defn test-output-processor-port [port]
  (is (not (nil? port)))
  (is (= (get port "name") "greeting"))
  (is (= (get port "@id") "workflow/HelloWorld/processor/hello/out/greeting"))
  (is (= (get port "@type") "OutputProcessorPort")))

(defn test-iteration-strategy-stack [strategy]
  (is (not (nil? strategy)))
  (is (= (get strategy "@id") "workflow/HelloWorld/processor/hello/iterationstrategy/"))
  (is (= (get strategy "@type") "IterationStrategyStack")))

(defn test-datalink [datalink]
  (is (not (nil? datalink)))
  (is (= (get datalink "@id") "workflow/HelloWorld/datalink?from=processor/hello/out/greeting&to=out/hello"))
  (is (= (get datalink "@type") "DataLink"))
  (is (= (get-in datalink ["receiveFrom" "@id"]) "workflow/HelloWorld/processor/hello/out/greeting"))
  (is (= (get-in datalink ["sendTo" "@id"]) "workflow/HelloWorld/out/hello")))

(deftest test-app
  (testing "main route"
    (let [response (app (request :get "/"))]
      (is (= (:status response) 200))
      (is (.contains (:body response) "scufl2-info"))))

  (testing "workflow bundle"
    (let [response (app (request :get "/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json))))

  (testing "workflow bundle not-found"
    (let [response (app (request :get "/workflowBundle/745c1f72-d57b-45ee-a7cc-437358f91e45/other"))]
      (is (= (:status response) 404))))

  (testing "workflow bundle uppercase uuid"
    (let [response (app (request :get "/workflowBundle/62EB2413-BFEC-4947-9854-CBABC7ECBC32/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json))))

  (testing "workflow bundle invalid uuid"
    (let [response (app (request :get "/workflowBundle/fred/"))]
      (is (= (:status response) 400))))
  
  (testing "workflow"
    (let [response (app (request :get "/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/workflow/HelloWorld/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json)
        (test-workflow (get json "workflow")))))

  (testing "workflow invalid uuid"
    (let [response (app (request :get "/workflowBundle/fred/workflow/HelloWorld/"))]
      (is (= (:status response) 400))))

  (testing "input workflow port"
    (let [response (app (request :get "/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/workflow/HelloWorld/in/name"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json)
        (test-workflow (get json "workflow"))
        (test-input-workflow-port (get-in json ["workflow" "inputWorkflowPort"])))))

  (testing "output workflow port"
    (let [response (app (request :get "/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/workflow/HelloWorld/out/greeting"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json)
        (test-workflow (get json "workflow"))
        (test-output-workflow-port (get-in json ["workflow" "outputWorkflowPort"])))))

  (testing "processor"
    (let [response (app (request :get "/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/workflow/HelloWorld/processor/hello/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json)
        (test-workflow (get json "workflow"))
        (test-processor (get-in json ["workflow" "processor"])))))

  (testing "input processor port"
    (let [response (app (request :get "/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/workflow/HelloWorld/processor/hello/in/name"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json)
        (test-workflow (get json "workflow"))
        (test-processor (get-in json ["workflow" "processor"]))
        (test-input-processor-port (get-in json ["workflow" "processor" "inputProcessorPort"])))))

  (testing "output processor port"
    (let [response (app (request :get "/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/workflow/HelloWorld/processor/hello/out/greeting"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json)
        (test-workflow (get json "workflow"))
        (test-processor (get-in json ["workflow" "processor"]))
        (test-output-processor-port (get-in json ["workflow" "processor" "outputProcessorPort"])))))

  (testing "iteration strategy"
    (let [response (app (request :get "/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/workflow/HelloWorld/processor/hello/iterationstrategy/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json)
        (test-workflow (get json "workflow"))
        (test-processor (get-in json ["workflow" "processor"]))
        (test-iteration-strategy-stack (get-in json ["workflow" "processor" "iterationStrategyStack"])))))

  (testing "datalink"
    (let [response (app (request :get "/workflowBundle/62eb2413-bfec-4947-9854-cbabc7ecbc32/workflow/HelloWorld/datalink?from=processor/hello/out/greeting&to=out/hello"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-bundle json)
        (test-workflow (get json "workflow"))
        (test-datalink (get-in json ["workflow" "datalink"])))))

  (testing "workflow run"
    (let [response (app (request :get "/run/745c1f72-d57b-45ee-a7cc-437358f91e45/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-run json))))

  (testing "workflow run upper-case UUID"
    (let [response (app (request :get "/run/745C1f72-D57B-45EE-A7CC-437358F91E45/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-workflow-run json))))

  (testing "workflow run invalid uuid"
    (let [response (app (request :get "/run/fred/"))]
      (is (= (:status response) 400))))

  (testing "process run"
    (let [response (app (request :get "/run/745c1f72-d57b-45ee-a7cc-437358f91e45/process/ee12ac67-8cbc-440d-b3c0-b959257d154a/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-process-run json))))

  (testing "process run upper-case UUID"
    (let [response (app (request :get "/run/745C1f72-D57B-45EE-A7CC-437358F91E45/process/EE12ac67-8CBC-440D-B3C0-B959257D154A/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-process-run json))))

  (testing "process run invalid wf uuid"
    (let [response (app (request :get "/run/fred/process/ee12ac67-8cbc-440d-b3c0-b959257d154a/"))]
      (is (= (:status response) 400))))

  (testing "process run invalid proc uuid"
    (let [response (app (request :get "/run/745c1f72-d57b-45ee-a7cc-437358f91e45/process/soup/"))]
      (is (= (:status response) 400))))

  (testing "run not-found"
    (let [response (app (request :get "/run/745c1f72-d57b-45ee-a7cc-437358f91e45/other"))]
      (is (= (:status response) 404))))

  (testing "data reference"
    (let [response (app (request :get "/data/745c1f72-d57b-45ee-a7cc-437358f91e45/ref/d2079164-3cd8-4b58-b6ff-c3bf61e3e04e/"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-data-reference json))))

  (testing "data list noerror depth1"
    (let [response (app (request :get "/data/745c1f72-d57b-45ee-a7cc-437358f91e45/list/486b0d87-74d4-49d5-8dad-fb64bf65ac80/false/1"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-data-list json))))

  (testing "data list error depth2"
    (let [response (app (request :get "/data/745c1f72-d57b-45ee-a7cc-437358f91e45/list/6b6ba3ed-d526-4d26-b16c-92976bf409fb/true/2"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-data-list-error json))))

  (testing "data error depth"
    (let [response (app (request :get "/data/745c1f72-d57b-45ee-a7cc-437358f91e45/error/d93b2a9c-49f7-436a-9861-54320b8a77ae/0"))]
      (is (= (:status response) 200))
      (let [json (parse-string (:body response))]
        (test-data-error json))))

  (testing "not-found route"
    (let [response (app (request :get "/invalid"))]
      (is (= (:status response) 404)))))