thin-provisioning-tools/functional-tests/cache-functional-tests.scm

384 lines
14 KiB
Scheme
Raw Normal View History

(library
(cache-functional-tests)
(export register-cache-tests)
(import (chezscheme)
(disk-units)
(functional-tests)
(cache-xml)
(fmt fmt)
(process)
(scenario-string-constants)
(temp-file)
(srfi s8 receive))
(define-tool cache-check)
(define-tool cache-dump)
(define-tool cache-restore)
(define-tool cache-metadata-size)
(define-tool cache-repair)
(define-syntax with-cache-xml
(syntax-rules ()
((_ (v) b1 b2 ...)
(with-temp-file-containing ((v "cache.xml" (fmt #f (generate-xml 512 1024 128))))
b1 b2 ...))))
(define-syntax with-valid-metadata
(syntax-rules ()
((_ (md) b1 b2 ...)
(with-temp-file-sized ((md "cache.bin" (to-bytes (meg 4))))
(with-cache-xml (xml)
(run-ok (cache-restore "-i" xml "-o" md))
b1 b2 ...)))))
;;; It would be nice if the metadata was at least similar to valid data.
(define-syntax with-corrupt-metadata
(syntax-rules ()
((_ (md) b1 b2 ...)
(with-temp-file-sized ((md "cache.bin" (to-bytes (meg 4))))
(system (fmt #f "dd if=/usr/bin/ls of=" md " bs=4096 > /dev/null 2>&1"))
b1 b2 ...))))
(define-syntax with-empty-metadata
(syntax-rules ()
((_ (md) b1 b2 ...)
(with-temp-file-sized ((md "cache.bin" (to-bytes (meg 4))))
b1 b2 ...))))
;; We have to export something that forces all the initialisation expressions
;; to run.
(define (register-cache-tests) #t)
;;;-----------------------------------------------------------
;;; cache_check scenarios
;;;-----------------------------------------------------------
(define-scenario (cache-check v)
2017-08-31 14:39:58 +05:30
"cache_check -V"
(run-ok-rcv (stdout _) (cache-check "-V")
2017-08-31 14:39:58 +05:30
(assert-equal tools-version stdout)))
(define-scenario (cache-check version)
2017-08-31 14:39:58 +05:30
"cache_check --version"
(run-ok-rcv (stdout _) (cache-check "--version")
2017-08-31 14:39:58 +05:30
(assert-equal tools-version stdout)))
(define-scenario (cache-check h)
2017-08-31 14:39:58 +05:30
"cache_check -h"
(run-ok-rcv (stdout _) (cache-check "-h")
2017-08-31 14:39:58 +05:30
(assert-equal cache-check-help stdout)))
(define-scenario (cache-check help)
2017-08-31 14:39:58 +05:30
"cache_check --help"
(run-ok-rcv (stdout _) (cache-check "--help")
2017-08-31 14:39:58 +05:30
(assert-equal cache-check-help stdout)))
(define-scenario (cache-check must-specify-metadata)
2017-08-31 14:39:58 +05:30
"Metadata file must be specified"
(run-fail-rcv (_ stderr) (cache-check)
2017-08-31 14:39:58 +05:30
(assert-equal
(string-append "No input file provided.\n"
cache-check-help)
stderr)))
(define-scenario (cache-check no-such-metadata)
2017-08-31 14:39:58 +05:30
"Metadata file doesn't exist."
(let ((bad-path "/arbitrary/filename"))
(run-fail-rcv (_ stderr) (cache-check bad-path)
2017-08-31 14:39:58 +05:30
(assert-starts-with
(string-append bad-path ": No such file or directory")
stderr))))
(define-scenario (cache-check metadata-file-cannot-be-a-directory)
2017-08-31 14:39:58 +05:30
"Metadata file must not be a directory"
(let ((bad-path "/tmp"))
(run-fail-rcv (_ stderr) (cache-check bad-path)
2017-08-31 14:39:58 +05:30
(assert-starts-with
(string-append bad-path ": Not a block device or regular file")
stderr))))
(define-scenario (cache-check unreadable-metadata)
2017-08-31 14:39:58 +05:30
"Metadata file exists, but is unreadable."
(with-valid-metadata (md)
(run-ok "chmod" "-r" md)
(run-fail-rcv (_ stderr) (cache-check md)
2017-08-31 14:39:58 +05:30
(assert-starts-with "syscall 'open' failed: Permission denied" stderr))))
(define-scenario (cache-check fails-with-corrupt-metadata)
2017-08-31 14:39:58 +05:30
"Fail with corrupt superblock"
(with-corrupt-metadata (md)
(run-fail (cache-check md))))
(define-scenario (cache-check failing-q)
2017-08-31 14:39:58 +05:30
"Fail quietly with -q"
(with-corrupt-metadata (md)
(run-fail-rcv (stdout stderr) (cache-check "-q" md)
2017-08-31 14:39:58 +05:30
(assert-eof stdout)
(assert-eof stderr))))
(define-scenario (cache-check failing-quiet)
2017-08-31 14:39:58 +05:30
"Fail quietly with --quiet"
(with-corrupt-metadata (md)
(run-fail-rcv (stdout stderr) (cache-check "--quiet" md)
2017-08-31 14:39:58 +05:30
(assert-eof stdout)
(assert-eof stderr))))
(define-scenario (cache-check valid-metadata-passes)
2017-08-31 14:39:58 +05:30
"A valid metadata area passes"
(with-valid-metadata (md)
(run-ok (cache-check md))))
(define-scenario (cache-check bad-metadata-version)
2017-08-31 14:39:58 +05:30
"Invalid metadata version fails"
(with-cache-xml (xml)
(with-empty-metadata (md)
(cache-restore "-i" xml "-o" md "--debug-override-metadata-version" "12345")
(run-fail (cache-check md)))))
(define-scenario (cache-check tiny-metadata)
"Prints helpful message in case tiny metadata given"
(with-temp-file-sized ((md "cache.bin" 1024))
(run-fail-rcv (_ stderr) (cache-check md)
(assert-starts-with "Metadata device/file too small. Is this binary metadata?" stderr))))
(define-scenario (cache-check spot-accidental-xml-data)
"Prints helpful message if XML metadata given"
(with-cache-xml (xml)
(system (fmt #f "man bash >> " xml))
(run-fail-rcv (_ stderr) (cache-check xml)
(assert-matches ".*This looks like XML. cache_check only checks the binary metadata format." stderr))))
;;;-----------------------------------------------------------
;;; cache_restore scenarios
;;;-----------------------------------------------------------
(define-scenario (cache-restore v)
"print version (-V flag)"
(run-ok-rcv (stdout _) (cache-restore "-V")
(assert-equal tools-version stdout)))
(define-scenario (cache-restore version)
"print version (--version flags)"
(run-ok-rcv (stdout _) (cache-restore "--version")
(assert-equal tools-version stdout)))
(define-scenario (cache-restore h)
2017-08-31 14:39:58 +05:30
"cache_restore -h"
(run-ok-rcv (stdout _) (cache-restore "-h")
2017-08-31 14:39:58 +05:30
(assert-equal cache-restore-help stdout)))
(define-scenario (cache-restore help)
2017-08-31 14:39:58 +05:30
"cache_restore --help"
(run-ok-rcv (stdout _) (cache-restore "--help")
2017-08-31 14:39:58 +05:30
(assert-equal cache-restore-help stdout)))
(define-scenario (cache-restore no-input-file)
"forget to specify an input file"
(with-empty-metadata (md)
(run-fail-rcv (_ stderr) (cache-restore "-o" md)
2017-08-31 14:39:58 +05:30
(assert-starts-with "No input file provided." stderr))))
(define-scenario (cache-restore missing-input-file)
"the input file can't be found"
(with-empty-metadata (md)
(run-fail-rcv (_ stderr) (cache-restore "-i no-such-file -o" md)
(assert-superblock-all-zeroes md)
2017-08-31 14:39:58 +05:30
(assert-starts-with "Couldn't stat file" stderr))))
(define-scenario (cache-restore garbage-input-file)
"the input file is just zeroes"
(with-empty-metadata (md)
(with-temp-file-sized ((xml "cache.xml" 4096))
(run-fail-rcv (_ stderr) (cache-restore "-i" xml "-o" md)
(assert-superblock-all-zeroes md)))))
2017-08-31 14:39:58 +05:30
(define-scenario (cache-restore missing-output-file)
"the output file can't be found"
(with-cache-xml (xml)
(run-fail-rcv (_ stderr) (cache-restore "-i" xml)
2017-08-31 14:39:58 +05:30
(assert-starts-with "No output file provided." stderr))))
(define-scenario (cache-restore tiny-output-file)
"Fails if the output file is too small."
(with-temp-file-sized ((md "cache.bin" (* 1024 4)))
(with-cache-xml (xml)
(run-fail-rcv (_ stderr) (cache-restore "-i" xml "-o" md)
2017-08-31 14:39:58 +05:30
(assert-starts-with cache-restore-outfile-too-small-text stderr)))))
(define-scenario (cache-restore successfully-restores)
"Restore succeeds."
(with-empty-metadata (md)
(with-cache-xml (xml)
(run-ok (cache-restore "-i" xml "-o" md)))))
2017-08-31 14:39:58 +05:30
(define-scenario (cache-restore q)
"cache_restore accepts -q"
(with-empty-metadata (md)
(with-cache-xml (xml)
(run-ok-rcv (stdout stderr) (cache-restore "-i" xml "-o" md "-q")
2017-08-31 14:39:58 +05:30
(assert-eof stdout)
(assert-eof stderr)))))
(define-scenario (cache-restore quiet)
"cache_restore accepts --quiet"
(with-empty-metadata (md)
(with-cache-xml (xml)
(run-ok-rcv (stdout stderr) (cache-restore "-i" xml "-o" md "--quiet")
2017-08-31 14:39:58 +05:30
(assert-eof stdout)
(assert-eof stderr)))))
(define-scenario (cache-restore override-metadata-version)
"we can set any metadata version"
(with-empty-metadata (md)
(with-cache-xml (xml)
(run-ok
(cache-restore "-i" xml "-o" md "--debug-override-metadata-version 10298")))))
2017-08-31 14:39:58 +05:30
(define-scenario (cache-restore omit-clean-shutdown)
"accepts --omit-clean-shutdown"
(with-empty-metadata (md)
(with-cache-xml (xml)
(run-ok
(cache-restore "-i" xml "-o" md "--omit-clean-shutdown")))))
;;;-----------------------------------------------------------
;;; cache_dump scenarios
;;;-----------------------------------------------------------
(define-scenario (cache-dump v)
"print version (-V flag)"
(run-ok-rcv (stdout _) (cache-dump "-V")
(assert-equal tools-version stdout)))
(define-scenario (cache-dump version)
"print version (--version flags)"
(run-ok-rcv (stdout _) (cache-dump "--version")
(assert-equal tools-version stdout)))
(define-scenario (cache-dump h)
2017-08-31 14:39:58 +05:30
"cache_dump -h"
(run-ok-rcv (stdout _) (cache-dump "-h")
2017-08-31 14:39:58 +05:30
(assert-equal cache-dump-help stdout)))
(define-scenario (cache-dump help)
2017-08-31 14:39:58 +05:30
"cache_dump --help"
(run-ok-rcv (stdout _) (cache-dump "--help")
2017-08-31 14:39:58 +05:30
(assert-equal cache-dump-help stdout)))
(define-scenario (cache-dump missing-input-file)
"Fails with missing input file."
(run-fail-rcv (stdout stderr) (cache-dump)
(assert-starts-with "No input file provided." stderr)))
(define-scenario (cache-dump small-input-file)
"Fails with small input file"
(with-temp-file-sized ((md "cache.bin" 512))
(run-fail
(cache-dump md))))
(define-scenario (cache-dump restore-is-noop)
2017-08-31 14:39:58 +05:30
"cache_dump followed by cache_restore is a noop."
(with-valid-metadata (md)
(run-ok-rcv (d1-stdout _) (cache-dump md)
2017-08-31 14:39:58 +05:30
(with-temp-file-containing ((xml "cache.xml" d1-stdout))
(run-ok (cache-restore "-i" xml "-o" md))
(run-ok-rcv (d2-stdout _) (cache-dump md)
2017-08-31 14:39:58 +05:30
(assert-equal d1-stdout d2-stdout))))))
;;;-----------------------------------------------------------
;;; cache_metadata_size scenarios
;;;-----------------------------------------------------------
(define-scenario (cache-metadata-size v)
2017-08-31 14:39:58 +05:30
"cache_metadata_size -V"
(run-ok-rcv (stdout _) (cache-metadata-size "-V")
2017-08-31 14:39:58 +05:30
(assert-equal tools-version stdout)))
(define-scenario (cache-metadata-size version)
2017-08-31 14:39:58 +05:30
"cache_metadata_size --version"
(run-ok-rcv (stdout _) (cache-metadata-size "--version")
2017-08-31 14:39:58 +05:30
(assert-equal tools-version stdout)))
(define-scenario (cache-metadata-size h)
2017-08-31 14:39:58 +05:30
"cache_metadata_size -h"
(run-ok-rcv (stdout _) (cache-metadata-size "-h")
2017-08-31 14:39:58 +05:30
(assert-equal cache-metadata-size-help stdout)))
(define-scenario (cache-metadata-size help)
2017-08-31 14:39:58 +05:30
"cache_metadata_size --help"
(run-ok-rcv (stdout _) (cache-metadata-size "--help")
2017-08-31 14:39:58 +05:30
(assert-equal cache-metadata-size-help stdout)))
(define-scenario (cache-metadata-size no-args)
2017-08-31 14:39:58 +05:30
"No arguments specified causes fail"
(run-fail-rcv (_ stderr) (cache-metadata-size)
2017-08-31 14:39:58 +05:30
(assert-equal "Please specify either --device-size and --block-size, or --nr-blocks."
stderr)))
(define-scenario (cache-metadata-size device-size-only)
2017-08-31 14:39:58 +05:30
"Just --device-size causes fail"
(run-fail-rcv (_ stderr) (cache-metadata-size "--device-size" (to-bytes (meg 100)))
2017-08-31 14:39:58 +05:30
(assert-equal "If you specify --device-size you must also give --block-size."
stderr)))
(define-scenario (cache-metadata-size block-size-only)
2017-08-31 14:39:58 +05:30
"Just --block-size causes fail"
(run-fail-rcv (_ stderr) (cache-metadata-size "--block-size" 128)
2017-08-31 14:39:58 +05:30
(assert-equal "If you specify --block-size you must also give --device-size."
stderr)))
(define-scenario (cache-metadata-size conradictory-info-fails)
2017-08-31 14:39:58 +05:30
"Contradictory info causes fail"
(run-fail-rcv (_ stderr) (cache-metadata-size "--device-size 102400 --block-size 1000 --nr-blocks 6")
2017-08-31 14:39:58 +05:30
(assert-equal "Contradictory arguments given, --nr-blocks doesn't match the --device-size and --block-size."
stderr)))
(define-scenario (cache-metadata-size all-args-agree)
2017-08-31 14:39:58 +05:30
"All args agreeing succeeds"
(run-ok-rcv (stdout stderr) (cache-metadata-size "--device-size" 102400 "--block-size" 100 "--nr-blocks" 1024)
2017-08-31 14:39:58 +05:30
(assert-equal "8248 sectors" stdout)
(assert-eof stderr)))
(define-scenario (cache-metadata-size nr-blocks-alone)
2017-08-31 14:39:58 +05:30
"Just --nr-blocks succeeds"
(run-ok-rcv (stdout stderr) (cache-metadata-size "--nr-blocks" 1024)
2017-08-31 14:39:58 +05:30
(assert-equal "8248 sectors" stdout)
(assert-eof stderr)))
(define-scenario (cache-metadata-size dev-size-and-block-size-succeeds)
2017-08-31 14:39:58 +05:30
"Specifying --device-size with --block-size succeeds"
(run-ok-rcv (stdout stderr) (cache-metadata-size "--device-size" 102400 "--block-size" 100)
2017-08-31 14:39:58 +05:30
(assert-equal "8248 sectors" stdout)
(assert-eof stderr)))
(define-scenario (cache-metadata-size big-config)
2017-08-31 14:39:58 +05:30
"A big configuration succeeds"
(run-ok-rcv (stdout stderr) (cache-metadata-size "--nr-blocks 67108864")
2017-08-31 14:39:58 +05:30
(assert-equal "3678208 sectors" stdout)
(assert-eof stderr)))
;;;-----------------------------------------------------------
;;; cache_repair scenarios
;;;-----------------------------------------------------------
(define-scenario (cache-repair missing-input-file)
"the input file can't be found"
(with-empty-metadata (md)
(run-fail-rcv (_ stderr) (cache-repair "-i no-such-file -o" md)
(assert-superblock-all-zeroes md)
(assert-starts-with "Couldn't stat path" stderr))))
(define-scenario (cache-repair garbage-input-file)
"the input file is just zeroes"
(with-empty-metadata (md1)
(with-corrupt-metadata (md2)
(run-fail-rcv (_ stderr) (cache-repair "-i" md1 "-o" md2)
(assert-superblock-all-zeroes md2)))))
(define-scenario (cache-repair missing-output-file)
"the output file can't be found"
(with-cache-xml (xml)
(run-fail-rcv (_ stderr) (cache-repair "-i" xml)
(assert-starts-with "No output file provided." stderr))))
)