Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: add a way to regenerate test data #127

Closed
wants to merge 1 commit into from
Closed

test: add a way to regenerate test data #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions plot-test/plot/tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Run a test with `raco test <file-name>`, or run all tests with `raco test .`.

To regenerate test data, set the environment variable `PLOT_TEST_REGEN` to `1`.
E.g., `PLOT_TEST_REGEN=1 raco test .`
41 changes: 23 additions & 18 deletions plot-test/plot/tests/helpers.rkt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,19 @@
(#t
(equal? set1 set2))))

;; Write a new set of draw steps to file. NEW-DRAW-STEPS are the new draw
;; Write a new set of draw steps to output file. NEW-DRAW-STEPS are the new draw
;; steps, as produced by `generate-draw-steps` or `generate-draw-steps-3d` and
;; ORIGINAL-FILE is the original draw step file. The data is compressed and
;; saved in a file name prefixed with "new-".
(define (write-new-draw-steps new-draw-steps original-file)
;; saved in an output file. REGEN? indicates the regeneration mode;
;; when it is false, the output file name is prefixed with "new-".
;; Otherwise, the output file name is not prefixed, which will overwrite
;; the existing original file. The function return a path to the file.
(define (write-new-draw-steps new-draw-steps original-file #:regen? [regen? #f])
(define-values (base name must-be-dir?) (split-path original-file))
(make-directory* base) ; ensure the base path exists
(define data-file (build-path
base
(string-append "new-" (path->string name))))
(string-append (if regen? "" "new-") (path->string name))))
(define data (call-with-output-string (lambda (out) (write new-draw-steps out))))
(call-with-input-string
data
Expand All @@ -124,7 +127,8 @@
data-file
(lambda (out)
(gzip-through-ports in out #f (current-seconds)))
#:exists 'replace))))
#:exists 'replace)))
data-file)

;; Decompress and read draw steps from STEPS-FILE. If the file does not
;; exist, just return an empty list.
Expand All @@ -148,7 +152,8 @@
;; When the function fails, the current set of draw steps as well as an image
;; of the current plot is saved in the same directory as SAVED-STEPS-FILE,
;; with the prefix "new-" they can be compared against the saved data to
;; determine what went wrong.
;; determine what went wrong, unless the environment variable PLOT_TEST_REGEN
;; is set, which will regenerate the existing saved files.
;;
;; The PLOT-FUNCTION is a function that must be supplied by the user to
;; generate the plot. Instead of calling `plot` directly, PLOT-FUNCTION will
Expand Down Expand Up @@ -180,11 +185,9 @@
(define saved (read-draw-steps saved-steps-file))
(define current (plot-function generate-draw-steps))
(unless (same-draw-steps? saved current)
(write-new-draw-steps current saved-steps-file)
(define-values (base name must-be-dir?) (split-path saved-steps-file))
(define data-file (build-path
base
(string-append "new-" (path->string name))))
(define regen? (getenv "PLOT_TEST_REGEN"))
(define data-file (write-new-draw-steps current saved-steps-file
#:regen? regen?))
;; Also generate an image of the current plot
(define image-file (path-replace-extension data-file ".png"))
(plot-function
Expand All @@ -207,18 +210,18 @@
#:x-label x-label #:y-label y-label
#:legend-anchor legend-anchor
#:aspect-ratio aspect-ratio)))
(fail (format "draw steps not the same, new set written to ~a" data-file))))
(cond
[regen? (printf "regenerated ~a" data-file)]
[else (fail (format "draw steps not the same, new set written to ~a" data-file))])))

;; Same as `check-draw-steps` but for 3D plots.
(define (check-draw-steps-3d plot-function saved-steps-file)
(define saved (read-draw-steps saved-steps-file))
(define current (plot-function generate-draw-steps-3d))
(unless (same-draw-steps? saved current)
(write-new-draw-steps current saved-steps-file)
(define-values (base name must-be-dir?) (split-path saved-steps-file))
(define data-file (build-path
base
(string-append "new-" (path->string name))))
(define regen? (getenv "PLOT_TEST_REGEN"))
(define data-file (write-new-draw-steps current saved-steps-file
#:regen? regen?))
;; Also generate an image of the current plot
(define image-file (path-replace-extension data-file ".png"))
(plot-function (lambda (rt
Expand Down Expand Up @@ -251,4 +254,6 @@
#:altitude altitude
#:legend-anchor legend-anchor
#:aspect-ratio aspect-ratio)))
(fail (format "draw steps not the same, new set written to ~a" data-file))))
(cond
[regen? (printf "regenerated ~a" data-file)]
[else (fail (format "draw steps not the same, new set written to ~a" data-file))])))
Loading