mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-02 19:17:10 +00:00
pj
11f72a722a
* ci(folio): run gradle on jdk 21 for the metro plugin the metro gradle plugin folio builds with publishes org.gradle.jvm.version 21 and java 21 class files, so every leg failed at the folio build on a 17 runtime. local builds pass on jdk 25, which is why only ci saw it. * fix(build): clean pkg/spec/dist, not the dead spec-api path * chore: point stale spec-api comments at pkg/spec * fix(spec): publish src so an installed package carries the runtime entries * fix(testrun): alias the installed spec package so one module graph loads * fix(spec): export Direction, ScrollAction and LongPressAction from the entry * docs(spec): cut the package readme to a description and doc links * docs: say how the cli and spec package versions relate * fix(verifier): report whether the last action was confirmed applied Both hosts get applied: true when the runner saw the dispatch succeed and applied: null when it could not, so an unconfirmed action stops arriving at the spec as no action at all. * fix(runner): an apply error leaves the action's fate unknown, not undone A deadline that fires after the tap was dispatched leaves the effect committed. Reporting nil made the spec see an effect with no action to cause it, which is how the counting property convicts a healthy app. * fix(release): stage the sidecar jar at the renamed embed path * test(replay-ui): trace fixtures for the vacuity counts one real green run, one run that rendered nothing, one that judges every property at least once. * ci(replay-ui): count the steps each property judged the exit code says no property returned false; it does not say any property was ever evaluated. this reads the trace and reports judged vs declined per property, and fails when the step page never rendered. * test(replay-ui): cover the summary script from make test * ci(replay-ui): summarise through the vacuity script * docs(ci): explain the replay-ui judged/declined counts * fix(verifier): encode element-valued extractors into the trace An ax element exports with its find/findAll host functions attached, and json.Marshal refuses the whole value over them: json: unsupported type: func(goja.FunctionCall) goja.Value. The encoding failed, curr stayed nil, and the goja hosts (ios, android) recorded null for every element-valued extractor in both the per-step diff and the violation witness. Apply the web host's sanitize rule before marshaling, so one rule encodes an element on both hosts. * test(verifier): pin element encoding to one rule on both hosts * test(runner): assert an element reaches trace.jsonl and its witness * feat(spec): give state.lastAction an applied field Three states, not two: no action is a null lastAction, applied: true is an action the runner confirmed, applied: null is one it dispatched and never learned the fate of. * fix(folio): do not attribute an effect to an unconfirmed action submitChangesBalanceByTypedAmount and createdAccountHasNonZeroBalance both convict by pinning an effect on the last action, so both decline unless the runner saw it applied. The fixtures now say which fate they mean. * test(folio): an unconfirmed submit belongs in the window The count is an upper bound on the submits a window holds, so the tap that may have landed counts and committedTransactionsExceedSubmits has nothing to convict on. * test(runner): a tap that lands under a failed apply is not a double submit Drives the real folio counting predicates through the runner against a device that commits the tap and then times out. The double-submit case is the control: without it a green proves only that the property never fired. * test(verifier): pin the three lastAction states on both hosts The web page is handed the same applied field the goja object exposes, so a property cannot read one thing on native and another on web. * docs(spec-language): document the three lastAction states
193 lines
6.7 KiB
Makefile
193 lines
6.7 KiB
Makefile
SHELL := /bin/bash
|
|
|
|
ANDROID_HOME ?= /opt/homebrew/share/android-commandlinetools
|
|
GRADLE := ./gradlew
|
|
GO := go
|
|
BUF := buf
|
|
|
|
GO_PACKAGES := ./...
|
|
SIDECAR_JAR := sidecar/build/libs/sidecar-all.jar
|
|
SIDECAR_EMBED := internal/sidecarassets/assets/sidecar-all.jar
|
|
COMPANION_EMBED := internal/driver/ioscompanion/companionassets/assets/companion-1.1.8.tar.gz
|
|
COMPANION_PREPARE := internal/driver/ioscompanion/companionassets/prepare.sh
|
|
RUNNER_EMBED := internal/driver/ioscompanion/runnerassets/assets/runner-1.0.0.tar.gz
|
|
RUNNER_PREPARE := companion/prepare.sh
|
|
RUNNER_SRC := $(shell find companion/Sources -type f -name '*.swift' 2>/dev/null) companion/project.yml
|
|
SIDECAR_SRC := $(shell find sidecar/src -type f \( -name '*.kt' -o -name '*.kts' \) 2>/dev/null) sidecar/build.gradle.kts build.gradle.kts settings.gradle.kts
|
|
SANDERLING_BIN := bin/sanderling
|
|
|
|
DOCS_SRC := $(shell find docs -type f -name '*.md' -not -path 'docs/_*')
|
|
INDEX_SRC := $(filter %index.md,$(DOCS_SRC))
|
|
PAGE_SRC := $(filter-out %index.md,$(DOCS_SRC))
|
|
INDEX_OUT := $(patsubst docs/%.md,build/site/%.html,$(INDEX_SRC))
|
|
PAGE_OUT := $(patsubst docs/%.md,build/site/%/index.html,$(PAGE_SRC))
|
|
DOCS_OUT := $(INDEX_OUT) $(PAGE_OUT)
|
|
DOCS_TEMPLATE := docs/_template/page.html
|
|
|
|
REPLAY_DIST := internal/replay/dist
|
|
WEB_DIST := replay-ui/dist
|
|
|
|
GOLINES := $(shell $(GO) env GOPATH)/bin/golines
|
|
|
|
.PHONY: bootstrap proto sidecar sidecar-embed sanderling sanderling-web sanderling-android sanderling-ios install test test-go test-browser test-companion test-kotlin test-spec-api test-ci-scripts spec-typecheck web-test web-typecheck web-build web-dev replay-dev docs clean release-cli release-npm-dry fmt fmt-go fmt-kotlin fmt-ts fmt-swift
|
|
|
|
bootstrap:
|
|
$(GO) mod download
|
|
$(BUF) generate
|
|
cd pkg/spec && npm install --silent
|
|
|
|
proto:
|
|
$(BUF) lint
|
|
$(BUF) generate
|
|
|
|
sidecar: $(SIDECAR_JAR)
|
|
|
|
# Stages the JAR where //go:embed expects it. Release tooling calls this rather
|
|
# than copying the JAR itself, so the embed path is spelled out in one place.
|
|
sidecar-embed: $(SIDECAR_EMBED)
|
|
|
|
sanderling: $(SANDERLING_BIN)
|
|
|
|
$(SANDERLING_BIN): $(SIDECAR_EMBED) $(COMPANION_EMBED) $(RUNNER_EMBED) web-build
|
|
mkdir -p bin
|
|
$(GO) build -tags "withsidecar withcompanion" -o $(SANDERLING_BIN) ./cmd/sanderling
|
|
|
|
# Per-platform builds, each taking only the tags that platform needs. `make
|
|
# sanderling` cannot run on Linux at all: preparing the iOS companion asset
|
|
# shells out to a macOS homebrew path. The CI workflows build through these so
|
|
# a job and a developer produce the same binary.
|
|
sanderling-web: web-build
|
|
mkdir -p bin
|
|
$(GO) build -o $(SANDERLING_BIN) ./cmd/sanderling
|
|
|
|
sanderling-android: $(SIDECAR_EMBED) web-build
|
|
mkdir -p bin
|
|
$(GO) build -tags withsidecar -o $(SANDERLING_BIN) ./cmd/sanderling
|
|
|
|
sanderling-ios: $(COMPANION_EMBED) $(RUNNER_EMBED) web-build
|
|
mkdir -p bin
|
|
$(GO) build -tags withcompanion -o $(SANDERLING_BIN) ./cmd/sanderling
|
|
|
|
# Installs `sanderling` into $GOBIN (or $GOPATH/bin) so it's directly on PATH for
|
|
# anyone with a standard Go toolchain setup.
|
|
install: $(SIDECAR_EMBED) $(COMPANION_EMBED) $(RUNNER_EMBED) web-build
|
|
$(GO) install -tags "withsidecar withcompanion" ./cmd/sanderling
|
|
@dest="$$($(GO) env GOBIN)"; [ -n "$$dest" ] || dest="$$($(GO) env GOPATH)/bin"; echo "installed sanderling to $$dest"
|
|
|
|
web-build:
|
|
cd replay-ui && bun install --frozen-lockfile && bun run build
|
|
mkdir -p $(REPLAY_DIST)
|
|
rm -rf $(REPLAY_DIST)/assets
|
|
cp -R $(WEB_DIST)/. $(REPLAY_DIST)/
|
|
|
|
web-dev:
|
|
cd replay-ui && bun run dev
|
|
|
|
replay-dev: $(SIDECAR_EMBED)
|
|
$(GO) run -tags withsidecar ./cmd/sanderling replay --dev
|
|
|
|
web-typecheck:
|
|
cd replay-ui && bun install --frozen-lockfile && bun run typecheck
|
|
|
|
$(SIDECAR_JAR): $(SIDECAR_SRC)
|
|
ANDROID_HOME=$(ANDROID_HOME) $(GRADLE) :sidecar:shadowJar
|
|
|
|
$(SIDECAR_EMBED): $(SIDECAR_JAR)
|
|
mkdir -p $(dir $@)
|
|
cp $< $@
|
|
|
|
$(COMPANION_EMBED): $(COMPANION_PREPARE)
|
|
$(COMPANION_PREPARE)
|
|
|
|
$(RUNNER_EMBED): $(RUNNER_SRC) $(RUNNER_PREPARE)
|
|
$(RUNNER_PREPARE)
|
|
|
|
# Each language enforces an 80-column limit through its own formatter config:
|
|
# Go via golines flags (gofmt has no width option), Kotlin via .editorconfig
|
|
# (ktlint), TypeScript/JS via .prettierrc.json, Swift via .swift-format.
|
|
fmt: fmt-go fmt-kotlin fmt-ts fmt-swift
|
|
|
|
fmt-go:
|
|
$(GOLINES) -m 80 --ignore-generated -w ./internal ./cmd
|
|
|
|
fmt-kotlin:
|
|
ktlint -F "sidecar/src/**/*.kt" "sidecar/src/**/*.kts"
|
|
|
|
fmt-ts:
|
|
cd replay-ui && bunx prettier --write "src/**/*.{ts,tsx}"
|
|
cd examples/folio-web && bunx prettier --write "src/**/*.{ts,tsx}"
|
|
cd pkg/spec && npx --yes prettier --write "src/**/*.ts" "test/**/*.ts"
|
|
|
|
fmt-swift:
|
|
xcrun swift-format format -i -r companion/Sources
|
|
|
|
test: test-go test-kotlin spec-typecheck test-spec-api web-typecheck web-test test-ci-scripts
|
|
|
|
test-go:
|
|
$(GO) test $(GO_PACKAGES)
|
|
|
|
web-test:
|
|
cd replay-ui && bun install --frozen-lockfile && bun test
|
|
|
|
# Drives small web fixtures and the chrome driver through real headless Chrome.
|
|
# Kept out of `test` because it needs a Chrome binary on PATH. -p 1 runs the two
|
|
# packages one after the other: both launch Chrome, and launching two at once
|
|
# has failed with "Launch: context canceled".
|
|
test-browser:
|
|
$(GO) test -p 1 -tags browser ./test/browser/... ./internal/driver/chrome/...
|
|
|
|
# Runs the withcompanion-tagged tests (asset embedding, extraction, checksum
|
|
# reuse) against the real companion and runner bundles. Kept out of `test`
|
|
# because preparing the companion bundle needs the darwin toolchain.
|
|
test-companion: $(COMPANION_EMBED) $(RUNNER_EMBED)
|
|
$(GO) test -tags withcompanion ./internal/driver/ioscompanion/...
|
|
|
|
test-kotlin:
|
|
ANDROID_HOME=$(ANDROID_HOME) $(GRADLE) :sidecar:test
|
|
|
|
# The CI scripts that read a trace and decide whether a green leg is
|
|
# evidence. bash and python3 only, which is all a runner has.
|
|
test-ci-scripts:
|
|
.github/scripts/replay-ui-summary-test.sh
|
|
|
|
test-spec-api:
|
|
cd pkg/spec && npm test --silent
|
|
|
|
spec-typecheck:
|
|
cd pkg/spec && npm run check --silent
|
|
|
|
docs: $(DOCS_OUT) build/site/_assets
|
|
@echo "built $(words $(DOCS_OUT)) pages to build/site"
|
|
|
|
build/site/_assets: docs/_assets
|
|
@mkdir -p build/site
|
|
@rm -rf $@
|
|
@cp -R $< $@
|
|
|
|
define build_page
|
|
@mkdir -p $(dir $@)
|
|
@pandoc $< --from=gfm --to=html5 --standalone \
|
|
--highlight-style=tango --template=$(DOCS_TEMPLATE) -o $@
|
|
@rel=$$(echo $(patsubst build/site/%,%,$@) | awk -F/ '{for(i=1;i<NF;i++)printf "../"}'); \
|
|
sed -i.bak "s|__ROOT__|$$rel|g" $@ && rm $@.bak
|
|
endef
|
|
|
|
$(INDEX_OUT): build/site/%.html: docs/%.md $(DOCS_TEMPLATE)
|
|
$(build_page)
|
|
|
|
$(PAGE_OUT): build/site/%/index.html: docs/%.md $(DOCS_TEMPLATE)
|
|
$(build_page)
|
|
|
|
clean:
|
|
$(GO) clean
|
|
rm -rf bin dist pkg/spec/dist build/site
|
|
$(GRADLE) clean
|
|
|
|
# Local release dry-runs. None of these touch remote registries.
|
|
|
|
release-cli: $(SIDECAR_JAR)
|
|
goreleaser release --snapshot --clean
|
|
|
|
release-npm-dry:
|
|
cd pkg/spec && npm ci && npm run build && npm pack --dry-run
|