Skip to content

MIPS/exp.ae-test

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ae-test

⚠ DEPRECATED — DO NOT RELY ON THIS TOOL. Atlas Explorer releases are no longer published to gyrfalcon-ui GitHub Releases. They are now published as pre-releases on the VSCode Extension Marketplace instead. Everything in this repo (init, fetch, etc.) fetches from gyrfalcon-ui releases via gh release, so it can no longer retrieve current AE builds. This script is unmaintained and may be removed; use the Marketplace pre-release channel to test new AE builds instead.

A Windows-only Git Bash script, ae-test manages test environments for manual visual testing of Atlas Explorer (AE).

AE is a Linux-only extension. On Windows, it only runs in WSL; all extension management targets the WSL vscode-server. Your real extensions & settings are untouched while a session runs, and everything is restored when you clean up.

Requirements

Windows (run in Git Bash):

  • Git for Windows: provides Git Bash
  • code: VSCode on PATH (standard, not Insiders)
  • wsl: Windows Subsystem for Linux 2

WSL (inside your default distribution):

  • gh: GitHub CLI, authenticated (gh auth login) with access to the private MIPS/gyrfalcon-ui repo (MIPS org membership)
  • jq: sudo apt install jq
  • unzip: sudo apt install unzip

GitHub operations & VSIX validation run in WSL because the GF Laptop side is harder to install additional shell tools on.

NOTE: All wsl commands only target the default WSL distribution. If a specific distro is desired to be used with this script, either change which one is the default, or request that the feature be added.

Test Scenarios

Three scenarios, each simulating a different user context. Only one is active at a time.

ae-test-win.sh select backup

Temporarily restores your original AE extension environment.


Scenario AE installed User settings What it simulates
new No Your real settings First-time AE install into an existing VSCode setup
backup Yes (your original version) Your real settings User with the original AE version still installed
blank No Empty (factory defaults) Brand-new VSCode with no prior configuration

The title bar shows [AE Test: new], [AE Test: backup], or [AE Test: blank] while a scenario is active.

One-time Setup

Clone this repository in Git Bash:

git clone <repo-url>
cd ae-test

Authenticate the GitHub CLI in WSL:

wsl gh auth login

Verify you have read access to the private AE repo:

gyrfalcon-ui is a private repo. Confirm access before your first run:

wsl gh repo view MIPS/gyrfalcon-ui

If this prints repo details, you're set. If it errors, request org access (MIPS) and/or make sure you have read access to the repo on GitHub.

Testing Workflow

Every session follows the same cycle: init → test → cleanup.

VSCode must be closed before running any command.

Start the session:

./ae-test-win.sh init

Downloads the latest AE release, backs up your current installation, and activates the new scenario immediately.

Switch scenarios:

./ae-test-win.sh select backup   # restore your original AE for comparison
./ae-test-win.sh select blank    # factory-fresh VSCode: no extensions or settings
./ae-test-win.sh select new      # back to the new-user scenario

End the session:

./ae-test-win.sh cleanup

Restores your original AE installation and removes all test state.

Command Reference

ae-test-win.sh init Downloads the latest AE release, backs up your current installation, and activates the new scenario. Run once before each session.

ae-test-win.sh select new [--reset] Activates the new-user scenario (no AE installed). --reset discards what VSCode wrote during the previous run and starts the scenario fresh.

ae-test-win.sh select backup Restores your original VSCode setup. Stays in test mode; run select new to resume testing. Doesn't support --reset.

ae-test-win.sh select blank [--reset] Clears all extensions and user settings (factory-fresh VSCode). --reset undoes what VSCode wrote during the blank session, then re-blanks.

ae-test-win.sh fetch Downloads the latest AE release VSIX and emits where it is stored. Doesn't require init and is safe to run at any time.

ae-test-win.sh cleanup Restores your real profile and removes all test directories & VSIX files.

Global flags:

Flag Behavior
-v Debug output to stderr
-vv Full trace (set -x, implies -v)
--help, -h Show usage

To capture debug output separately: ./ae-test-win.sh -v 2>debug.log

Troubleshooting

Error: Test environment already initialized A previous session wasn't cleaned up. Run ./ae-test-win.sh cleanup first.

Error: Leftover WSL backup from a previous session detected An earlier init was interrupted. Run ./ae-test-win.sh cleanup to clear it, then retry.

Error: VSCode is currently running Close all VSCode windows first.

Error: This script must be run in Git Bash on Windows, not WSL or native Linux bash You launched it from a WSL terminal or a plain Linux/macOS shell. Open Git Bash (installed with Git for Windows) and run it from there.

Error: Not authenticated with GitHub in WSL Run wsl gh auth login and follow the prompts.

Nothing happens / AE never appears after init or select Check that the WSL distro VSCode's Remote-WSL is connected to is your default distro (wsl -l -v; the default is marked). This script always targets the default distro; if it differs from the one VSCode uses, the extension changes happen in the wrong place. Fix with wsl -s <Distro>.

fetch fails with multiple VSIX files The release added platform-specific variants. The script lists the files and exits. Check the release page, then retry.

Something else / not listed here Re-run the same command with -v (debug output) or -vv (full set -x trace) to see what the script is doing step by step:

./ae-test-win.sh -vv <command> 2>&1 | tee -a log.txt

Include log.txt when asking for help or filing an issue: it's the fastest way to pin down anything not covered above.


See CONTRIBUTING.md for how the script works internally.

About

An experimental bash script for testing various Atlas Explorer installation states

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages