feat: add devcards and react testing library

filipesilva · filipesilva · commit dc74704b5528 · 2019-11-23T22:28:20.000Z
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
 node_modules
 dist
 out
-test*
+test*/
 .shadow-cljs
 .nrepl-port
 yarn-error.log
diff --git a/README.md b/README.md
@@ -67,13 +67,17 @@ my-app
 |  └── favicon.ico
 └── src
    ├── app
+   |  ├── cards
+   |  |  ├── devcards_runner.cljs
+   |  |  ├── helpers.cljs        
+   |  |  └── test_runner.cljs    
    |  ├── core.cljs
-   |  └── core_spec.cljs
+   |  ├── hello.cljs
+   |  └── hello_cards.cljs       
    └── e2e
-      └── core.cljs    
+      └── core.cljs
 ```
 
-No configuration or complicated folder structures, just the files you need to build your app.<br>
 Once the installation is done, you can open your project folder:
 
 ```sh
@@ -94,6 +98,13 @@ You can use existing npm React components directly via a [interop call](http://r
 Builds use [Shadow CLJS](https://github.com/thheller/shadow-cljs) for maximum compatibility with NPM libraries. You'll need a [Java SDK](https://adoptopenjdk.net/) (Version 8+, Hotspot) to use it. <br>
 You can [import npm libraries](https://shadow-cljs.github.io/docs/UsersGuide.html#js-deps) using Shadow CLJS. See the [user manual](https://shadow-cljs.github.io/docs/UsersGuide.html) for more information.
 
+### `npm run cards` or `yarn cards`
+
+Runs the interactive live development enviroment.<br>
+You can use it to design, test, and think about parts of your app in isolation.
+
+This environment uses [Devcards](https://github.com/bhauman/devcards) and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro).
+
 ### `npm test` or `yarn test`, and `npm run e2e` or `yarn e2e`
 
 `test` launches the test runner in the interactive watch mode.<br>
diff --git a/src/create_cljs_app/template.cljs b/src/create_cljs_app/template.cljs
@@ -20,9 +20,10 @@ Will likely need to be replaced with a proper templating library."
    "public/index.html" [{:from "__NAME__" :to name}]
    "src/app/core.cljs" [{:from "__NAME__" :to name}]
    "README.md" [{:from "__START__" :to (:start commands)}
+                {:from "__CARDS__" :to (:cards commands)}
                 {:from "__SERVER__" :to (:server commands)}
-                {:from "__TEST__" :to (:test commands)}
-                {:from "__TEST:ONCE__" :to (:test:once commands)}
+                {:from "__TEST:WATCH__" :to (:test commands)}
+                {:from "__TEST__" :to (:test:once commands)}
                 {:from "__E2E__" :to (:e2e commands)}
                 {:from "__LINT__" :to (:lint commands)}
                 {:from "__FORMAT__" :to (:format commands)}
diff --git a/src/create_cljs_app/utils.cljs b/src/create_cljs_app/utils.cljs
@@ -13,18 +13,20 @@
   [use-yarn]
   (if use-yarn
     {:start "yarn start"
+     :cards "yarn cards"
      :server "yarn server"
      :build "yarn build"
      :test "yarn test"
-     :test:once "yarn test:once"
+     :test:watch "yarn test:watch"
      :e2e "yarn e2e"
      :lint "yarn lint"
      :format "yarn format"}
     {:start "npm start"
+     :cards "npm run cards"
      :server "npm run server"
      :build "npm run build"
      :test "npm test"
-     :test:once "npm run test:once"
+     :test:watch "npm run test:watch"
      :e2e "npm run e2e"
      :lint "npm run lint"
      :format "npm run format"}))
diff --git a/src/e2e/core.cljs b/src/e2e/core.cljs
@@ -39,16 +39,17 @@
         (is (not (fileIncludes "./public/index.html" "__NAME__")))
         (is (not (fileIncludes "./src/app/core.cljs" "__NAME__")))
         (is (not (fileIncludes "./README.md" "__START__")))
+        (is (not (fileIncludes "./README.md" "__CARDS__")))
         (is (not (fileIncludes "./README.md" "__SERVER__")))
         (is (not (fileIncludes "./README.md" "__TEST__")))
-        (is (not (fileIncludes "./README.md" "__TEST:ONCE__")))
+        (is (not (fileIncludes "./README.md" "__TEST:WATCH__")))
         (is (not (fileIncludes "./README.md" "__E2E__")))
         (is (not (fileIncludes "./README.md" "__BUILD__")))
         (is (not (fileIncludes "./README.md" "__LINT__")))
         (is (not (fileIncludes "./README.md" "__FORMAT__"))))
       (testing "Commands"
         (is (= (.-code (silent-exec "yarn sc start")) 0) "Should start background server")
-        (is (= (.-code (silent-exec "yarn test:once")) 0) "Should test")
+        (is (= (.-code (silent-exec "yarn test")) 0) "Should test")
         (is (= (.-code (silent-exec "yarn build")) 0) "Should build")
         (is (existsSync "./public/js/main.js"))
         "Should output public/js/main.js")
diff --git a/template/.clj-kondo/config.edn b/template/.clj-kondo/config.edn
@@ -1 +1,2 @@
-{:lint-as {reagent.core/with-let clojure.core/let}}
+{:lint-as {devcards.core/defcard cljs.core/def
+           devcards.core/deftest cljs.core/def}}
diff --git a/template/README.md b/template/README.md
@@ -6,7 +6,7 @@ In the project directory, you can run:
 
 ### `__START__`
 
-Runs the app in the development mode.<br>
+Runs the app in development mode.<br>
 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 The page will reload if you make edits.
 
@@ -16,10 +16,17 @@ You can use existing npm React components directly via a [interop call](http://r
 Builds use [Shadow CLJS](https://github.com/thheller/shadow-cljs) for maximum compatibility with NPM libraries. You'll need a [Java SDK](https://adoptopenjdk.net/) (Version 8+, Hotspot) to use it. <br>
 You can [import npm libraries](https://shadow-cljs.github.io/docs/UsersGuide.html#js-deps) using Shadow CLJS. See the [user manual](https://shadow-cljs.github.io/docs/UsersGuide.html) for more information.
 
+### `__CARDS__`
+
+Runs the interactive live development enviroment.<br>
+You can use it to design, test, and think about parts of your app in isolation.
+
+This environment uses [Devcards](https://github.com/bhauman/devcards) and [React Testing Library](https://testing-library.com/docs/react-testing-library/intro).
+
 ### `__TEST__` and `__E2E__`
 
-`__TEST__` launches the test runner in the interactive watch mode.<br>
-You can use `__TEST:ONCE__` to run the tests a single time, and `__E2E__` to run end-to-end tests.
+You can use `__TEST__` to run tests a single time, and `__E2E__` to run the end-to-end test app.
+`__TEST:WATCH__` launches tests in interactive watch mode.<br>
 
 See the ClojureScript [testing page](https://clojurescript.org/tools/testing) for more information. E2E tests use [Taiko](https://github.com/getgauge/taiko) to interact with a headless browser.
 
diff --git a/template/package.json b/template/package.json
@@ -6,16 +6,23 @@
     "sc": "shadow-cljs",
     "server": "shadow-cljs stop && shadow-cljs start",
     "start": "shadow-cljs watch app",
+    "cards": "shadow-cljs watch cards",
     "build": "yarn clean && shadow-cljs release app",
-    "test": "shadow-cljs watch test --config-merge \"{:autorun true}\"",
-    "test:once": "shadow-cljs compile test && node out/test.js",
+    "test": "shadow-cljs compile test && node out/test.js",
+    "test:watch": "shadow-cljs watch test --config-merge \"{:autorun true}\"",
     "e2e": "shadow-cljs compile e2e && node out/e2e.js",
     "lint": "clj-kondo --lint src",
     "format": "zprint-clj --hang -i \"./src/**/*.{clj,cljs,cljc,edn}\" -o ./ && zprint-clj -i \"./*.edn\" -o ./",
     "clean": "rimraf public/js"
   },
   "devDependencies": {
+    "@testing-library/dom": "^6.10.1",
+    "@testing-library/react": "^9.3.2",    
     "clj-kondo": "2019.11.23",
+    "highlight.js": "9.15.10",
+    "jsdom": "^15.2.1",
+    "jsdom-global": "^3.0.2",
+    "marked": "^0.7.0",    
     "rimraf": "~3.0.0",
     "serve-handler": "~6.1.2",
     "shadow-cljs": "~2.8.74",
@@ -25,7 +32,7 @@
   },
   "dependencies": {
     "create-react-class": "~15.6.3",
-    "react": "~16.12.0",
-    "react-dom": "~16.12.0"
+    "react": "~16.8.0",
+    "react-dom": "~16.8.0"
   }
 }
diff --git a/template/shadow-cljs.edn b/template/shadow-cljs.edn
@@ -3,13 +3,19 @@
         :modules {:main {:init-fn app.core/main}}
         :output-dir "public/js"
         :target :browser}
+  :cards {:asset-path "/js"
+          :modules {:main {:init-fn app.cards.devcards-runner/main}}
+          :compiler-options {:devcards true}
+          :output-dir "public/js"
+          :target :browser}
+  :test {:main app.cards.test-runner/main
+         :output-to "out/test.js"
+         :target :node-test}
   :e2e {:ns-regexp "e2e.*"
         :output-to "out/e2e.js"
-        :target :node-test}
-  :test {:ns-regexp "app.*-spec$"
-         :output-to "out/test.js"
-         :target :node-test}}
- :dependencies [[reagent "0.8.1"]]
+        :target :node-test}}
+ :dependencies [[reagent "0.8.1"]
+                [devcards "0.2.6"]]
  :dev-http {3000 "public"}
  :nrepl {:port 3333}
  :source-paths ["src"]}
diff --git a/template/src/app/cards/devcards_runner.cljs b/template/src/app/cards/devcards_runner.cljs
@@ -0,0 +1,18 @@
+(ns app.cards.devcards-runner
+  (:require [cljsjs.react]
+            [cljsjs.react.dom]
+            ; devcards needs cljsjs.react and cljsjs.react.dom to be imported
+            ; separately for shadow-cljs to add shims.
+            [devcards.core :refer [start-devcard-ui!]]
+            ; Import all namespaces with cards here to load them.
+            [app.hello-cards]))
+
+(defn ^:export main
+  "Start the devcards UI."
+  []
+  ; Add a special class to the body to signal we're in devcards mode.
+  ; We want to mostly use the same styles as the app, but might need to make
+  ; some exceptions.
+  (js/document.body.classList.add "using-devcards")
+  ; Start the devcards UI.
+  (start-devcard-ui!))
diff --git a/template/src/app/cards/helpers.cljs b/template/src/app/cards/helpers.cljs
@@ -0,0 +1,9 @@
+(ns app.cards.helpers)
+
+(defn testing-container
+  "The container that should be used to render testing-library react components.
+  We want to provide our own container so that the rendered devcards aren't used."
+  []
+  (let [app-div (js/document.createElement "div")]
+    (.setAttribute app-div "id" "testing-lib")
+    (js/document.body.appendChild app-div)))
diff --git a/template/src/app/cards/test_runner.cljs b/template/src/app/cards/test_runner.cljs
@@ -0,0 +1,26 @@
+(ns app.cards.test-runner
+  {:dev/always true}
+  (:require [shadow.test.env :as env]
+            [cljs.test :as ct]
+            [shadow.test :as st]
+            ["jsdom-global" :as jsdom-global]
+            ; Import the devcards-runner ns to get all the tests imported by it.
+            [app.cards.devcards-runner]))
+
+(defmethod ct/report [::ct/default :end-run-tests] [m]
+  (if (ct/successful? m)
+    (js/process.exit 0)
+    (js/process.exit 1)))
+
+(defn run-tests []
+  (-> (env/get-test-data)
+      (env/reset-test-data!))
+  (st/run-all-tests))
+
+(defn main
+  "Run tests in a jsom environment."
+  []
+  ; Set jsdom to mock a dom environment.
+  (jsdom-global)
+  ; Run the tests
+  (run-tests))
diff --git a/template/src/app/core.cljs b/template/src/app/core.cljs
@@ -1,11 +1,9 @@
 (ns app.core
-  (:require [reagent.core :as r]))
-
-(defn app []
-  [:div "__NAME__ is running!"])
+  (:require [reagent.core :as r]
+            [app.hello :refer [hello]]))
 
 (defn ^:dev/after-load start []
-  (r/render [app] (.getElementById js/document "app")))
+  (r/render [hello] (.getElementById js/document "app")))
 
 (defn ^:export main []
   (start))
diff --git a/template/src/app/core_spec.cljs b/template/src/app/core_spec.cljs
diff --git a/template/src/app/hello.cljs b/template/src/app/hello.cljs
@@ -0,0 +1,17 @@
+(ns app.hello
+  (:require [reagent.core :as r]))
+
+(defn click-counter [click-count]
+  [:div
+   "The atom " [:code "click-count"] " has value: "
+   @click-count ". "
+   [:input {:type "button" :value "Click me!"
+            :on-click #(swap! click-count inc)}]])
+
+(def click-count (r/atom 0))
+
+(defn hello []
+  [:<>
+   [:p "Hello, __NAME__ is running!"]
+   [:p "Here's an example of using a component with state:"]
+   [click-counter click-count]])
diff --git a/template/src/app/hello_cards.cljs b/template/src/app/hello_cards.cljs
@@ -0,0 +1,47 @@
+(ns app.hello-cards
+  (:require [reagent.core :as r]
+            [devcards.core :as dc :refer [defcard deftest]]
+            [cljs.test :include-macros true :refer [is]]
+            ["@testing-library/react" :refer [render cleanup fireEvent]]
+            [app.hello :refer [click-counter hello]]
+            [app.cards.helpers :refer [testing-container]]))
+
+(defcard
+  "This is a live interactive development environment using [Devcards](https://github.com/bhauman/devcards).
+   You can use it to design, test, and think about parts of your app in isolation.
+   
+   The two 'cards' below show the two components in this app.")
+
+(defcard hello-card
+  (dc/reagent hello))
+
+(defcard click-counter-card
+  (dc/reagent click-counter)
+  (r/atom 0)
+  {:inspect-data true
+   :frame true
+   :history true})
+
+(defcard
+  "You can also add tests here and see their results. 
+   Below are some tests using [React Testing Library](https://testing-library.com/docs/react-testing-library/intro).
+   
+   Tests will be ran outside the browser when you run the test command.")
+
+(deftest hello-tests-card
+  (let [tr (render (r/as-element [hello]) #js {:container (testing-container)})]
+    (is (.queryByText tr #"Hello") "Should say 'Hello'")
+    (cleanup)))
+
+(deftest click-counter-tests-card
+  (let [atom (r/atom 0)
+        element (r/as-element [click-counter atom])
+        tr (render element #js {:container (testing-container)})]
+    (is (.queryByText tr #"has value: 0") "Should show the initial value as '0'")
+    (.click fireEvent (.queryByText tr #"(?i)click me"))
+    (r/flush)
+    (is (.queryByText tr #"has value: 1") "Should show the value as '1' after click")
+    (.click fireEvent (.queryByText tr #"(?i)click me"))
+    (r/flush)
+    (is (.queryByText tr #"has value: 2") "Should show the value as '2' after two clicks")
+    (cleanup)))

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-{:lint-as {reagent.core/with-let clojure.core/let}}`
	`1`	`+{:lint-as {devcards.core/defcard cljs.core/def`
	`2`	`+ devcards.core/deftest cljs.core/def}}`