feedBack/tests/test_diagnostics_redact.py
Bret Mogilefsky af2949677a
rename: slopsmith → feedBack, byron → got-feedBack (#537)
* Update GitHub repo references from feedback* to feedBack*

* rename: slopsmith -> feedBack, byron -> got-feedBack

Renames across the entire codebase:
- slopsmith/Slopsmith/SLOPSMITH/SlopSmith -> feedBack/FeedBack/FEEDBACK/FeedBack
- byron/Byron/Byrongamatos -> got-feedBack/got-feedBack/got-feedBack
- /home/byron/ -> /opt/got-feedBack/
- byron@ougsoft.com -> hi@got-feedBack.org
- github.com/byrongamatos/ -> github.com/got-feedback/
- com.byron. -> com.got-feedback.
- SLOPSMITH_ env vars -> FEEDBACK_ with backward-compat fallback
- Protocol/storage strings migrated with read-old/write-new pattern
- window.slopsmith JS API -> window.feedBack (canonical) + backward-compat alias

Refs: #rename-slopsmith

* rename: complete regen against current main + fix backward-compat alias

Regenerated the slopsmith->feedBack / byron->got-feedBack rename on top of
current main (3 commits had landed since the branch: #572/#554/#574),
resolving the four content conflicts in favour of main's newer content
(autoplay/auto-exit, accuracy-badge, Virtuoso re-home, feedpak badge).

Completion fixes on top of the mechanical rename:
- Re-apply rename to post-branch content the original rename never saw:
  window.slopsmith(.Tour) consumers in lessons.js / notifications.js /
  onboarding-tour.js, and the matching JS + python tests (autoplay_exit,
  progression_*, test_feedpak_extension FEEDBACK_* env vars). The test env
  vars now match server.py (which reads FEEDBACK_SYNC_STARTUP /
  FEEDBACK_SKIP_STARTUP_TASKS), so the sync-startup test exercises the real
  path again.
- Restore the window.slopsmith backward-compat alias dropped during conflict
  resolution, and move the bus aliases to AFTER the _feedBackExisting merge
  block so they reference the fully-assembled object (also fixes the
  loop_api.test.js API-surface regex, which the original PR latently broke).
- Drop the stray empty data/web_library.db (runtime DB lives in CONFIG_DIR)
  and gitignore it.
- Fix stale tone-source test: feed[dB]ack -> fee[dB]ack to match shipped
  source labels.

Verified locally (org CI billing-blocked): JS 819/819 pass; pytest 1669
passed / 1683 collected with 0 import errors; zero residual slopsmith/byron
except the two intentional window.slopsmith aliases.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* rename: implement advertised backward-compat + prune dead community plugins

Address gaps where PR #537's "Backward compatibility" section was advertised
but not implemented, and clean up the community plugin list.

Env vars (FEEDBACK_* canonical, legacy SLOPSMITH_* honoured):
- New lib/env_compat.py (getenv_compat / env_flag_compat) + tests. server.py
  (_env_flag + all FEEDBACK_* reads), diagnostics_hardware, gp2midi and
  tailwind_rebuild now resolve the legacy alias, so existing SLOPSMITH_UI /
  SLOPSMITH_PLUGINS_DIR / etc. deployments keep working.
- Fix the rename collapsing plugins/__init__.py and minigames/routes.py from
  `FEEDBACK_PLUGINS_DIR or SLOPSMITH_PLUGINS_DIR` into a redundant
  `FEEDBACK_ or FEEDBACK_` (the fallback was silently lost).

Storage (app.js update-channel):
- Read feedBack-update-channel, fall back to legacy slopsmith-update-channel,
  and clear the legacy key on write — so a user's update-channel preference
  survives the rename instead of resetting to "stable".

Community plugin list (README): the rename rewrote third-party repo URLs we
don't own. Probed every one; their owners never renamed, so:
- Restore the 13 live community plugins to their real slopsmith-* names.
- Prune 6 that are 404 to the public (topkoa splitscreen/stems, OmikronApex
  tuner, Jafz2001 nam-rig-builder, DeathlySin song-preview, Erikcb91 shuffle).
- Fix a pre-existing Guitar Theory clone-command typo (nam-tone -> guitar-theory).

Verified: env_compat 7/7, JS 819/819, pytest 1690 collected / 0 import errors,
rename-sensitive + startup suites green.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: byrongamatos <xasiklas@gmail.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-23 11:03:01 +02:00

110 lines
3.3 KiB
Python

from pathlib import Path
from diagnostics_redact import Redactor
def test_dlc_path_replaced():
r = Redactor(dlc_dir=Path("/dlc/songs"))
out = r.redact_text("loaded from /dlc/songs/foo.archive")
assert "<DLC_DIR>" in out
assert "/dlc/songs" not in out
assert r.counts["paths_replaced"] == 1
def test_song_filename_redacted_consistently():
r = Redactor()
a = r.redact_text("Loading Test-Artist_Test-Song.archive")
b = r.redact_text("Replaying Test-Artist_Test-Song.archive again")
token_a = a.split("Loading ")[1].strip()
token_b = b.split("Replaying ")[1].split(" ")[0]
assert token_a == token_b
assert token_a.startswith("<song:") and token_a.endswith(">")
assert r.counts["song_names_replaced"] == 2
def test_ipv4_redacted():
r = Redactor()
out = r.redact_text("client 192.168.1.42 connected")
assert "192.168.1.42" not in out
assert "<ip:" in out
assert r.counts["ips_replaced"] == 1
def test_invalid_ipv4_left_alone():
r = Redactor()
out = r.redact_text("version 1.2.3.999 not an ip")
assert "1.2.3.999" in out
assert r.counts["ips_replaced"] == 0
def test_bearer_token_redacted():
r = Redactor()
out = r.redact_text("Authorization: Bearer abc123def456")
assert "abc123def456" not in out
assert "<redacted>" in out
assert r.counts["secrets_replaced"] == 1
def test_qstring_secret_redacted():
r = Redactor()
out = r.redact_text("GET /api?api_key=supersecret&foo=bar")
assert "supersecret" not in out
assert "api_key=<redacted>" in out
assert "foo=bar" in out
def test_home_dir_replaced():
r = Redactor(home_dir=Path("/home/alice"))
out = r.redact_text("config at /home/alice/.config/feedBack")
assert "/home/alice" not in out
assert "<HOME>" in out
def test_different_redactors_produce_different_tokens():
a = Redactor()
b = Redactor()
out_a = a.redact_text("Foo.archive")
out_b = b.redact_text("Foo.archive")
assert out_a != out_b
def test_redact_lines_iterator():
r = Redactor()
lines = ["client 10.0.0.1", "client 10.0.0.1 again"]
out = list(r.redact_lines(lines))
assert out[0] != lines[0]
assert out[0].split("client ")[1] == out[1].split("client ")[1].split(" ")[0]
def test_non_string_passes_through():
r = Redactor()
assert r.redact_text("") == ""
assert r.redact_text(None) is None
def test_url_userinfo_redacted():
"""Credentials embedded as URL userinfo (user:pass@host) must be redacted."""
r = Redactor()
out = r.redact_text("connecting to https://admin:secret@myhost.example.com/api")
assert "admin" not in out
assert "secret" not in out
assert "<redacted>@myhost.example.com" in out
assert r.counts["secrets_replaced"] == 1
def test_url_userinfo_redacted_http():
"""URL userinfo redaction also applies to http:// URLs."""
r = Redactor()
out = r.redact_text("http://user:pass@192.168.1.1:8080/path")
assert "user:pass" not in out
assert "<redacted>@" in out
def test_url_no_userinfo_unchanged():
"""A plain URL without userinfo must not be altered by the userinfo redactor."""
r = Redactor()
url = "https://myhost.example.com/api/stream"
out = r.redact_text(url)
assert out == url
assert r.counts["secrets_replaced"] == 0