Add useful test functions

Author: ericdallo

README.md

@@ -71,6 +71,10 @@ Besides the `lsp-mode` features, `lsp-dart` implements the [custom methods featu
 
 `lsp-dart-run-test-at-point` - Run single test at point. [:warning:*](#features-only-available-for-dart-sdk-version-280-currently-the-dev-branch-or-above)
 
+`lsp-dart-visit-last-test` - Go to last ran test.
+
+`lsp-dart-run-last-test` - Run last ran test.
+
 Running a test interactively: 
 
 ![test](images/run-test.gif)

lsp-dart-test-support.el

@@ -24,6 +24,7 @@
 
 ;;; Code:
 
+(require 'cl-lib)
 (require 'lsp-mode)
 
 (require 'lsp-dart-project)
@@ -33,6 +34,12 @@
 
 ;;; Internal
 
+(cl-defstruct lsp-dart-test
+  (file-name nil)
+  (names nil)
+  (position nil)
+  (kind nil))
+
 (defun lsp-dart-test-support--test-kind-p (kind)
   "Return non-nil if KIND is a test type."
   (or (string= kind "UNIT_TEST_TEST")
@@ -92,20 +99,25 @@ otherwise the dart command."
                                                   escaped-str nil t)))
     escaped-str))
 
-(defun lsp-dart-test-support-run (buffer &optional names kind)
+(defun lsp-dart-test-support-run (test)
   "Run Dart/Flutter test command in a compilation buffer for BUFFER file.
-If NAMES is non nil, it will run only for KIND the test joining the name
-from NAMES."
+If TEST is non nil, it will run only this test."
   (interactive)
   (lsp-dart-test-support--from-project-root
-   (let* ((test-file (file-relative-name (buffer-file-name buffer)
+   (let* ((file-name (lsp-dart-test-file-name test))
+          (buffer (get-file-buffer file-name))
+          (names (lsp-dart-test-names test))
+          (kind (lsp-dart-test-kind test))
+          (test-file (file-relative-name file-name
                                          (lsp-dart-project-get-root)))
           (test-name (lsp-dart-test-support--build-test-name names))
           (group-kind? (string= kind "UNIT_TEST_GROUP"))
           (test-arg (when test-name
                       (concat "--name '^"
                               (lsp-dart-test-support--escape-test-name test-name)
                               (if group-kind? "'" "$'")))))
+     (when names
+       (lsp-workspace-set-metadata "last-ran-test" test))
      (compilation-start (format "%s test %s %s"
                                 (lsp-dart-test-support--build-command buffer)
                                 (or test-arg "")
@@ -122,10 +134,13 @@ TEST-RANGE is the test method range."
           (beg-line (progn (goto-char beg)
                            (line-beginning-position)))
           (spaces (make-string beg-position ?\s))
-          (overlay (make-overlay beg-line end buffer)))
+          (overlay (make-overlay beg-line end buffer))
+          (test (make-lsp-dart-test :file-name (buffer-file-name buffer)
+                                    :names names
+                                    :position beg
+                                    :kind kind)))
     (overlay-put overlay 'lsp-dart-test-code-lens t)
-    (overlay-put overlay 'lsp-dart-test-names names)
-    (overlay-put overlay 'lsp-dart-test-kind kind)
+    (overlay-put overlay 'lsp-dart-test test)
     (overlay-put overlay 'lsp-dart-test-overlay-test-range (lsp--range-to-region test-range))
     (overlay-put overlay 'before-string
                  (concat spaces
@@ -135,7 +150,7 @@ TEST-RANGE is the test method range."
                                      'local-map (-doto (make-sparse-keymap)
                                                  (define-key [mouse-1] (lambda ()
                                                                           (interactive)
-                                                                          (lsp-dart-test-support-run buffer names kind))))
+                                                                          (lsp-dart-test-support-run test))))
                                      'font-lock-face 'lsp-lens-face)))))
 
 (defun lsp-dart-test-support--add-code-lens (buffer items &optional names)
@@ -168,6 +183,28 @@ PARAMS is the notification data from outline."
   "Return non-nil if FILE-NAME is a dart test files."
   (string-match "_test.dart" file-name))
 
+(defun lsp-dart-test-support-run-last-test ()
+  "Visit the last ran test going to the test definition."
+  (if-let ((test (lsp-workspace-get-metadata "last-ran-test")))
+      (lsp-dart-test-support-run test)
+    (lsp-dart-project-log "No last test found.")))
+
+(defun lsp-dart-test-support-visit-last-test ()
+  "Visit the last ran test going to the test definition."
+  (-if-let* ((test (lsp-workspace-get-metadata "last-ran-test"))
+             (file-name (lsp-dart-test-file-name test))
+             (buffer (or (get-file-buffer file-name)
+                         (find-file file-name)))
+             (position (lsp-dart-test-position test)))
+      (if-let ((window (get-buffer-window buffer 'visible)))
+          (progn
+            (select-window window)
+            (goto-char position))
+        (with-current-buffer buffer
+          (switch-to-buffer buffer nil t)
+          (goto-char position)))
+    (lsp-dart-project-log "No last test found.")))
+
 
 (provide 'lsp-dart-test-support)
 ;;; lsp-dart-test-support.el ends here

lsp-dart.el

@@ -421,18 +421,28 @@ all test overlays in the current buffer."
                       ((beg2 . end2) (overlay-get other 'lsp-dart-test-overlay-test-range)))
                 (and (< beg1 beg2)
                      (> end1 end2))) it)
-    (lsp-dart-test-support-run (current-buffer)
-                        (overlay-get it 'lsp-dart-test-names)
-                        (overlay-get it 'lsp-dart-test-kind))))
+    (lsp-dart-test-support-run (overlay-get it 'lsp-dart-test))))
 
 ;;;###autoload
 (defun lsp-dart-run-test-file ()
   "Run dart/Flutter test command only for current buffer."
   (interactive)
   (if (lsp-dart-test-support-test-file-p (buffer-file-name))
-      (lsp-dart-test-support-run (current-buffer))
+      (lsp-dart-test-support-run (->> (current-buffer) buffer-name file-truename (make-lsp-dart-test :file-name)))
     (user-error "Current buffer is not a Dart/Flutter test file")))
 
+;;;###autoload
+(defun lsp-dart-visit-last-test ()
+  "Visit the last ran test going to test definition."
+  (interactive)
+  (lsp-dart-test-support-visit-last-test))
+
+;;;###autoload
+(defun lsp-dart-run-last-test ()
+  "Visit the last ran test going to test definition."
+  (interactive)
+  (lsp-dart-test-support-run-last-test))
+
 
 ;;;###autoload(with-eval-after-load 'lsp-mode (require 'lsp-dart))