trmnlp-test 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfefb51546891c33222e11f7c2ba094168787d9207966a1addbc307462290fd2
-  data.tar.gz: 4323d3400e827f4d88913f1d624ccf7d64bd65e0f15428add123b8c3af01e782
+  metadata.gz: 919b1bf33568827657d00e7b935d0253bfb0e7a9384d9be057cb665c97fa5f96
+  data.tar.gz: 92608945975bad2ed2748a732b24ad2bd2a1cc899c1ebb49fa1ca8329e07dad3
 SHA512:
-  metadata.gz: 2b4b67e735b844dc2510eac564e98a825217516709ef67fd68e78294ffddb40bdc99075045e1390b09dde904e3bc2311b8974ffa1d70bf230f4ab6d36b1996a1
-  data.tar.gz: 6b590003ac56c97e22392b85376d3fcce7bb22d172e25636a02489ac9a0304b8c3d6ed83c7c8b9f5e8a06b2598379607b872e4bdf82085827686f617a78f9a67
+  metadata.gz: c60c6424e6d751d3634da01e3f88b26eeb5090f8c00af4d83014c19aa3f8c195589c070721c9ce9f3978b662f8f91fd10ec51aaee862a076337ac3d3f734bb80
+  data.tar.gz: c02bcabd8a0e2541168db2b4793cab321ab91f3b94b49433e3ebb3f87381578304ebba11125b08cc9fa2d4a7a9b920d59fc58d0d855462c4e46b0b00dd03c73f

data/README.md

@@ -23,6 +23,7 @@ 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 help | --version   # all commands and options / versions of trmnlp-test, trmnlp, Playwright
 ```
 
 `--repo DIR` runs against another directory. `--mount DIR` mounts an extra directory.
@@ -52,7 +53,9 @@ const { test, expect, matrix, VIEWS, DEVICES, FRAMEWORK } = require('trmnlp-test
 
 test('menu', async ({ trmnl }) => {
   const screen = await trmnl.render({
-    device: 'og_plus', view: 'full',          // any model, orientation: 'portrait', palette, darkMode, theme, scale, textScale, fonts, framework
+    device: 'og_plus', view: 'full',          // any model, orientation: 'portrait', palette, theme, scale, textScale, fonts, framework
+    darkMode: true,                           // as the server does it: everything inverted except images ('framework': the v3 class only)
+    server: true,                             // TRMNL's quirks: { qr: 'server' | 'fixed', crlf: true }
     fields: { data_source: 'webhook' },       // custom field values (defaults + .trmnlp.yml + these)
     webhook: { merge_variables: {...} },      // or data: {...} to render given data as is
     mocks: { 'https://api.example.com/*': { temp: 21 } },
@@ -63,6 +66,7 @@ test('menu', async ({ trmnl }) => {
   await expect(screen.locator('[data-row]')).toHaveCount(7); // any Playwright locator assertion
   await expect(screen).toHaveNoOverflow();
   await expect(screen).toHaveNoOverlap('.title', 'img');
+  await expect(screen).toShowText('Espresso');              // visible: not cut off by an ellipsis, clamp or the edge ({ visible: false }: content only)
   await expect(screen).toHaveQr('BCD\n002...');
   await expect(screen).toMatchScreen();                     // PNG snapshot (--update-snapshots)
   await expect(screen).toFitDeviceImageLimit();
@@ -88,6 +92,8 @@ for (const s of matrix({ device: DEVICES.representative, view: VIEWS, darkMode:
 }
 ```
 
+**Where the server differs from trmnlp.** trmnlp-test renders with trmnlp's code, so it shares trmnlp's differences from TRMNL's server. The ones seen on trmnl.com are built in: `server: { qr: 'server' }` (the `qr_code` filter ignores "responsive" and returns the viewBox plus its natural width/height and `style="max-width:100%;height:auto"`) and `{ crlf: true }` (the web editor's preview made the template's newlines CR LF, so a newline typed in the template no longer matches `\n` in data). `{ qr: 'fixed' }` (a size and no viewBox) has not been seen and is there for robustness. `server: true` applies the seen ones. `matrix({ server: SERVER.variants })` renders each on its own. Dark mode follows what the server shows (inverted, images kept) rather than the v3 class, which leaves inline SVG and hard-coded colours as they are; `darkMode: 'framework'` renders the class only.
+
 Other helpers: `trmnl.plugin('other/dir')`, `trmnl.lint()` with `toPassLint({ allow })`, `FRAMEWORK.majors()`, `FRAMEWORK.latestOf('2')`.
 
 ## How it works
@@ -96,5 +102,5 @@ See [docs/README.md](docs/README.md) for diagrams of the components, a render, s
 
 ## Examples and self-tests
 
-- `examples/payment-qr`: the payment QR plugin, current Liquid version and the earlier webhook + serverless version (53 tests).
+- `examples/payment-qr`: the earlier webhook + serverless version of the payment QR plugin (the current version tests itself with trmnlp-test in its own repository).
 - `test/self`: fixture plugins for every strategy and language (86 tests). Run with `bin/trmnlp-test run --root test/self`.

data/exe/trmnlp-test

@@ -19,9 +19,19 @@ while %w[--repo --mount].include?(args.first)
   flag == '--repo' ? repo = path : mounts += ['-v', "#{path}:#{path}"]
 end
 
+USAGE = File.read(File.expand_path('../lib/trmnlp_test/usage.txt', __dir__))
+args[0] = { '-h' => 'help', '--help' => 'help', '-v' => 'version', '--version' => 'version' }.fetch(args[0], args[0]) if args.any?
 case args.first
+when 'help'
+  puts USAGE
+  exit
 when 'version'
-  puts "trmnlp-test #{TrmnlpTest::VERSION} (#{image})"
+  puts "launcher #{TrmnlpTest::VERSION}, image #{image}"
+  if system('docker', 'image', 'inspect', image, out: File::NULL, err: File::NULL)
+    exec 'docker', 'run', '--rm', image, 'version'
+  else
+    puts 'image not pulled yet (trmnlp-test update)'
+  end
   exit
 when 'update'
   exec 'docker', 'pull', image
@@ -34,13 +44,14 @@ FileUtils.mkdir_p(cache)
 
 # a missing image is pulled; a :latest image is refreshed at most once a day
 present = system('docker', 'image', 'inspect', image, out: File::NULL, err: File::NULL)
-stamp = File.join(cache, '.pulled-' + image.gsub(/[^A-Za-z0-9.]+/, '_'))
+# the stamp names the launcher version too: a new launcher pulls at once, it may need a newer image
+stamp = File.join(cache, ".pulled-#{TrmnlpTest::VERSION}-" + image.gsub(/[^A-Za-z0-9.]+/, '_'))
 stale = image.end_with?(':latest') && (!File.exist?(stamp) || Time.now - File.mtime(stamp) > 86_400)
 if !present || (stale && !ENV['TRMNLP_TEST_NO_PULL'])
-  warn "trmnlp-test: pulling #{image}"
-  pulled = system('docker', 'pull', '-q', image, out: File::NULL)
+  warn "trmnlp-test: pulling #{image}" unless present
+  pulled = system('docker', 'pull', '-q', image, out: File::NULL, err: present ? File::NULL : $stderr)
   abort("trmnlp-test: could not pull #{image}") if !pulled && !present
-  FileUtils.touch(stamp) if pulled
+  FileUtils.touch(stamp) # checked today, whether or not the registry had it
 end
 entry = []
 if args.first == 'shell'

data/lib/trmnlp_test/usage.txt

@@ -0,0 +1,30 @@
+Usage: trmnlp-test [options] [command] [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
+  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
+  refresh                 re-download models, palettes and framework versions
+  update                  pull the newest image now (otherwise at most once a day)
+  shell                   open a shell in the image
+  version                 show the versions of trmnlp-test, trmnlp and Playwright
+  help                    show this help (run --help: the Playwright test options)
+
+Options:
+  --repo DIR              the plugin repository (default: the current directory)
+  --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")
+  -h, --help              show this help
+  -v, --version           show versions
+
+Environment:
+  TRMNLP_TEST_WORKERS     parallel workers, a number or "50%" (default: half the CPUs)
+  TRMNLP_TEST_IMAGE       image to run (default: ghcr.io/excusemi/trmnlp-test:latest)
+  TRMNLP_TEST_CACHE_DIR   cache directory (default: ~/.cache/trmnlp-test)
+  TRMNLP_TEST_NO_PULL=1   never pull the image automatically
+
+Docs: https://github.com/ExcuseMi/trmnlp-test

data/lib/trmnlp_test/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module TrmnlpTest
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
   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.2
+  version: 0.1.4
 platform: ruby
 authors:
 - ExcuseMi
@@ -21,6 +21,7 @@ files:
 - LICENSE
 - README.md
 - exe/trmnlp-test
+- lib/trmnlp_test/usage.txt
 - lib/trmnlp_test/version.rb
 homepage: https://github.com/ExcuseMi/trmnlp-test
 licenses: