Create separate artifacts for screen reader binaries (#9)

Author: eps1lon

.env.example

@@ -0,0 +1 @@
+export SRTL_DEV=true

.github/workflows/ci.yml

@@ -16,6 +16,8 @@ defaults:
 jobs:
   test:
     runs-on: windows-latest
+    env:
+      SRTL_DEV: true
 
     steps:
       - uses: actions/checkout@v2
@@ -30,32 +32,40 @@ jobs:
       - run: yarn test:ci
       - name: "examples/node/test.example.ps1"
         run: |
+          # Required config
           # The path you cloned this repository to
           $REPO_PATH = "${{ github.workspace }}"
+
+          # Optional config
           # The path where NVDA speech output is logged. Need read/write access.
           $LOG_FILE_PATH = "$REPO_PATH\nvda-node.log"
+          # The path where your package manager installed the "screen-reader-testing-library" package.
+          $PACKAGE_PATH = "$REPO_PATH\node_modules\screen-reader-testing-library"
 
           # End of configuration. Changing anything below at your own risk
-          $NVDA_VENDOR = "$REPO_PATH\src\nvda"
-          $NVDA_BIN = "$NVDA_VENDOR\portable\nvda.exe"
-          & $NVDA_BIN --log-file=$LOG_FILE_PATH --config-path=$NVDA_VENDOR\settings
+          $NVDA_BIN = "$PACKAGE_PATH\bin\nvda.ps1"
+          & $NVDA_BIN -logFile $LOG_FILE_PATH 
           node $REPO_PATH\examples\node\index.js $LOG_FILE_PATH
-          & $NVDA_BIN -q
+          & $NVDA_BIN -quit
 
       - name: "examples/jest/test.example.ps1"
         run: |
+          # Required config
           # The path you cloned this repository to
           $REPO_PATH = "${{ github.workspace }}"
+
+          # Optional config
           # The path where NVDA speech output is logged. Need read/write access.
           $LOG_FILE_PATH = "$REPO_PATH\nvda-jest.log"
+          # The path where your package manager installed the "screen-reader-testing-library" package.
+          $PACKAGE_PATH = "$REPO_PATH\node_modules\screen-reader-testing-library"
 
           # End of configuration. Changing anything below at your own risk
-          $NVDA_VENDOR = "$REPO_PATH\src\nvda"
-          $NVDA_BIN = "$NVDA_VENDOR\portable\nvda.exe"
+          $NVDA_BIN = "$PACKAGE_PATH\bin\nvda.ps1"
           $Env:LOG_FILE_PATH = $LOG_FILE_PATH
-          & $NVDA_BIN --log-file=$Env:LOG_FILE_PATH --config-path=$NVDA_VENDOR\settings
+          & $NVDA_BIN -logFilePath $Env:LOG_FILE_PATH
           yarn jest -c $REPO_PATH\examples\jest\jest.config.js
-          & $NVDA_BIN -q
+          & $NVDA_BIN -quit
       - uses: actions/upload-artifact@v2
         if: ${{ always() }}
         with:

.gitignore

@@ -1,4 +1,5 @@
+/.env
 node_modules/
 /nvda.log
 /nvda-old.log
-test.ps1
+/vendor/*.zip

CONTRIBUTING.md

@@ -1,5 +1,14 @@
 # Contributing
 
+Before you install you need to make sure the install script uses the checked-in version of NVDA.
+You have to set the environment variable `SRTL_DEV` to `true` before you install local packages.
+Otherwise it will download the binaries from a the GitHub release for the currently checked out version of this library.
+
+```bash
+$ source .env.example
+$ yarn
+```
+
 ## Common workflows
 
 ### Bump NVDA

examples/jest/README.md

@@ -4,9 +4,9 @@ An example using jest as a test runner.
 
 ## Installation
 
+- Windows with powershell
 - node 14.x
 - install dependencies via `yarn`
-- NVDA `2020.2`
 
 ## Getting started
 

examples/jest/test.example.ps1

@@ -1,12 +1,16 @@
+# Required config
 # The path you cloned this repository to
 $REPO_PATH = "C:\Users\eps1lon\Development\nvda-snapshot-testing"
+
+# Optional config
 # The path where NVDA speech output is logged. Need read/write access.
 $LOG_FILE_PATH = "$REPO_PATH\nvda.log"
+# The path where your package manager installed the "screen-reader-testing-library" package.
+$PACKAGE_PATH = "$REPO_PATH\node_modules\screen-reader-testing-library"
 
 # End of configuration. Changing anything below at your own risk
-$NVDA_VENDOR = "$REPO_PATH\src\nvda"
-$NVDA_BIN = "$NVDA_VENDOR\portable\nvda.exe"
+$NVDA_BIN = "$PACKAGE_PATH\bin\nvda.ps1"
 $Env:LOG_FILE_PATH = $LOG_FILE_PATH
-& $NVDA_BIN --log-file=$Env:LOG_FILE_PATH --config-path=$NVDA_VENDOR\settings
+& $NVDA_BIN -logFilePath $Env:LOG_FILE_PATH
 yarn jest -c $REPO_PATH\examples\jest\jest.config.js
-& $NVDA_BIN -q
+& $NVDA_BIN -quit

examples/node/README.md

@@ -4,9 +4,9 @@ This is the initial prototype for this project.
 
 ## Installation
 
+- Windows with powershell
 - node 14.x
 - install dependencies via `yarn`
-- NVDA `2020.2`
 
 ## Getting started
 

examples/node/test.example.ps1

@@ -1,11 +1,15 @@
+# Required config
 # The path you cloned this repository to
 $REPO_PATH = "C:\Users\eps1lon\Development\nvda-snapshot-testing"
+
+# Optional config
 # The path where NVDA speech output is logged. Need read/write access.
 $LOG_FILE_PATH = "$REPO_PATH\nvda.log"
+# The path where your package manager installed the "screen-reader-testing-library" package.
+$PACKAGE_PATH = "$REPO_PATH\node_modules\screen-reader-testing-library"
 
 # End of configuration. Changing anything below at your own risk
-$NVDA_VENDOR = "$REPO_PATH\src\nvda"
-$NVDA_BIN = "$NVDA_VENDOR\portable\nvda.exe"
-& $NVDA_BIN --log-file=$LOG_FILE_PATH --config-path=$NVDA_VENDOR\settings
+$NVDA_BIN = "$PACKAGE_PATH\bin\nvda.ps1"
+& $NVDA_BIN -logFile $LOG_FILE_PATH 
 node $REPO_PATH\examples\node\index.js $LOG_FILE_PATH
-& $NVDA_BIN -q
+& $NVDA_BIN -quit

src/bin/nvda.ps1

@@ -0,0 +1,15 @@
+param ([switch] $quit, $logFilePath)
+
+$CACHE_DIR = "$HOME\AppData\Local\screen-reader-testing-library"
+$NVDA_VENDOR = "$CACHE_DIR\screen-readers\nvda-2020.3"
+$NVDA_BIN = "$NVDA_VENDOR\portable\nvda.exe"
+
+if ($logFilePath) {
+  & $NVDA_BIN --config-path=$NVDA_VENDOR\settings --log-file=$logFilePath
+}
+elseif ($quit) {
+  & $NVDA_BIN -q
+}
+else {
+  throw "Either pass a -logFilePath or -quit NVDA."
+}