trmnlp-test 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ffe95db896ea1660559f274107340be575fe8e2a38b889b5f4e4a33c28aa605
-  data.tar.gz: fab39d295adc996cd8e3eb7e279c80c77d2164f6fd37e699779b3a8b347cccfb
+  metadata.gz: 81bdf6b5992e4c2c35cf556f5d7fc4cd10eec6f69d5785c90a9e4b929ea9cfd8
+  data.tar.gz: 40b128c6952097961a9aa169e0b3ea7c00d4e5492c2f0127acb82304af1b61fc
 SHA512:
-  metadata.gz: ab880b2b0441109463d27911eb72f301ab83cbc28658790ace66fd1ea7855371808310341d386c5b11ffb625b6dde2ea57367e2c4d7236a0b09ebc40463fbd10
-  data.tar.gz: 19d06af41c7831ee922e611cc7363df6739b90b036135a0c3781671e61fca8604401d47476edac5beee91b026afef9d709159fda06a652bcf082f388ed10f90d
+  metadata.gz: cb8579d76f4a7e5ffa88d96aedb25775640d5852a668e2ca5344aa4486e3a75e9e249fcd37be51a27f97cd018183113d0e87e67f6284d5774e140b0dd0c66331
+  data.tar.gz: dacdf85d2739ab2b6848ecb5e54d94c769c7064892416a3e9815cb22fa1b560f74a597095d3c8d81cf4361eb183d109881e53801a0d459bd0769efc40ede7052

data/README.md

@@ -23,6 +23,8 @@ trmnlp-test init               # trmnlp-test.config.js + test/trmnl/plugin.spec.
 trmnlp-test                    # run; Playwright args pass through (-g, --update-snapshots)
 trmnlp-test models | versions  # device models / framework versions
 trmnlp-test update             # pull the image now (otherwise at most once a day)
+trmnlp-test views.spec        # only some tests (a file or a filter); Playwright args pass through
+trmnlp-test run -- --rebaseline  # args after -- reach the specs: require('trmnlp-test').args
 trmnlp-test help | --version   # all commands and options / versions of trmnlp-test, trmnlp, Playwright
 ```
 
@@ -88,6 +90,7 @@ test('menu', async ({ trmnl }) => {
   await expect(screen).toHaveQr('BCD\n002...');             // black on white; { inverted: true | 'any' } for dark codes
   await expect(screen).toMatchScreen();                     // PNG snapshot (--update-snapshots)
   await expect(screen).toFitDeviceImageLimit();
+  await expect(screen).toMatchReference('refs/photo.png', { selector: '.dial', refRect, minIoU: 0.93 });  // diff attached
   const png = await screen.png();                           // pixel(x,y), colors(), inkRatio(rect), inkBounds(), crop()
 });
 
@@ -110,11 +113,13 @@ for (const s of matrix({ device: DEVICES.representative, view: VIEWS, darkMode:
 }
 ```
 
+**Extending:** add matchers with `expect.extend` and fixtures with `test.extend` (Playwright's own mechanisms), and plugin-wide rules with `checks: ['test/trmnl/checks.js']` in the config. Checks run after every render, and `toRenderCleanly` reports their problems. See [docs/SPEC.md](docs/SPEC.md#91-extending).
+
 Other helpers: `trmnl.plugin('other/dir')`, `trmnl.lint()` with `toPassLint({ allow })`, `FRAMEWORK.majors()`, `FRAMEWORK.latestOf('2')`.
 
 ## How it works
 
-See [docs/README.md](docs/README.md) for diagrams of the components, a render, sessions and the file structure.
+See [docs/README.md](docs/README.md) for diagrams and [docs/SPEC.md](docs/SPEC.md) for the full specification.
 
 ## Examples and self-tests
 

data/exe/trmnlp-test

@@ -2,7 +2,8 @@
 # frozen_string_literal: true
 
 # Runs trmnlp-test (a Docker image) against a TRMNL plugin repository.
-#   trmnlp-test [--repo DIR] [--mount DIR]... [run|init|models|versions|refresh|update|shell|version] [playwright args]
+#   trmnlp-test [run|init|models|versions|refresh|update|shell|version|help] [args] [-- spec args]
+# --repo DIR, --mount DIR and --env NAME[=VALUE] are taken from anywhere before `--`.
 require 'etc'
 require 'fileutils'
 require_relative '../lib/trmnlp_test/version'
@@ -11,12 +12,25 @@ require_relative '../lib/trmnlp_test/version'
 image = ENV.fetch('TRMNLP_TEST_IMAGE', "#{TrmnlpTest::IMAGE}:latest")
 repo = Dir.pwd
 mounts = []
-args = ARGV.dup
-while %w[--repo --mount].include?(args.first)
-  flag, dir = args.shift(2)
-  abort "trmnlp-test: #{flag} needs a directory" unless dir
-  path = File.realpath(dir)
-  flag == '--repo' ? repo = path : mounts += ['-v', "#{path}:#{path}"]
+# the container sees TRMNLP_TEST_* and CI; --env NAME[=VALUE] passes more
+env = %w[CI FORCE_COLOR].flat_map { |k| ['-e', k] } + ENV.keys.grep(/\ATRMNLP_TEST_/).flat_map { |k| ['-e', k] }
+args = []
+rest = ARGV.dup
+until rest.empty?
+  arg = rest.shift
+  if arg == '--'
+    args.push(arg, *rest)
+    break
+  elsif %w[--repo --mount --env].include?(arg)
+    value = rest.shift or abort("trmnlp-test: #{arg} needs a value")
+    case arg
+    when '--repo' then repo = File.realpath(value)
+    when '--mount' then (path = File.realpath(value)) && mounts.push('-v', "#{path}:#{path}")
+    else env.push('-e', value)
+    end
+  else
+    args << arg
+  end
 end
 
 USAGE = File.read(File.expand_path('../lib/trmnlp_test/usage.txt', __dir__))
@@ -59,6 +73,5 @@ if args.first == 'shell'
   entry = ['--entrypoint', 'bash']
 end
 tty = $stdout.tty? ? ['-t'] : []
-env = %w[CI TRMNLP_TEST_DEBUG TRMNLP_TEST_WORKERS TRMNLP_TEST_SHOW_DIFFERENCES FORCE_COLOR].flat_map { |k| ['-e', k] }
 exec 'docker', 'run', '--rm', '-i', *tty, '--init', '--ipc=host', '-u', "#{Process.uid}:#{Process.gid}",
      '-v', "#{repo}:#{repo}", '-w', repo, '-v', "#{cache}:/cache", *mounts, *env, *entry, image, *args

data/lib/trmnlp_test/usage.txt

@@ -1,9 +1,10 @@
-Usage: trmnlp-test [options] [command] [args]
+Usage: trmnlp-test [command] [args] [options] [-- spec args]
 
 Tests TRMNL plugins in the trmnlp format, in Docker.
 
 Commands:
-  run [playwright args]   run the tests (default), e.g. -g "dark", --update-snapshots, -j 4
+  run [playwright args]   run the tests (default), e.g. -g "dark", --update-snapshots, -j 4;
+                          a spec file or filter in first place runs those: trmnlp-test views.spec
   init                    create trmnlp-test.config.js and test/trmnl/plugin.spec.js
   models                  list the TRMNL device models and their palettes
   versions                list the TRMNL framework versions
@@ -18,6 +19,9 @@ Options:
   --mount DIR             also mount DIR into the container (repeatable)
   --root DIR              the directory with trmnlp-test.config.js, inside the repository
   --report DIR            where the report goes (default: config "report")
+  --env NAME[=VALUE]      pass an environment variable to the specs (repeatable);
+                          TRMNLP_TEST_* variables always pass
+  -- ARGS                 everything after -- reaches the specs as require('trmnlp-test').args
   -h, --help              show this help
   -v, --version           show versions
 

data/lib/trmnlp_test/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module TrmnlpTest
-  VERSION = '0.1.12'
+  VERSION = '0.1.14'
   IMAGE = 'ghcr.io/excusemi/trmnlp-test'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnlp-test
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - ExcuseMi