Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI for testing pyflask distributable #297

Merged
merged 18 commits into from
Aug 18, 2023
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions .github/workflows/pyflask-build-and-dist-tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: PyFlask build and distributable tests
on:
schedule:
- cron: "0 16 * * *" # Daily at noon EST
pull_request:
workflow_dispatch:

# Cancel previous workflows on the same pull request
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

env:
CACHE_NUMBER: 1 # increase to reset cache manually

jobs:
testing:
name: PyFlask build and distributable tests on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
defaults:
run:
shell: bash -l {0}

strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
include:
- python-version: "3.9"
os: ubuntu-latest
label: environments/environment-Linux.yml
prefix: /usr/share/miniconda3/envs/nwb-guide
shorthand: unix

- python-version: "3.10"
os: macos-latest
label: environments/environment-Mac.yml
prefix: /Users/runner/miniconda3/envs/nwb-guide
shorthand: unix

- python-version: "3.9"
os: windows-latest
label: environments/environment-Windows.yml
prefix: C:\Miniconda3\envs\nwb-guide
shorthand: win

steps:
- uses: actions/checkout@v3
- run: git fetch --prune --unshallow --tags

# see https://github.com/conda-incubator/setup-miniconda#caching-environments
- name: Setup Mambaforge
uses: conda-incubator/setup-miniconda@v2
with:
miniforge-variant: Mambaforge
miniforge-version: latest
activate-environment: nwb-guide
use-mamba: true

- name: Set cache date
id: get-date
run: echo "today=$(/bin/date -u '+%Y%m%d')" >> $GITHUB_OUTPUT
shell: bash

- name: Cache Mamba env
uses: actions/cache@v2
with:
path: ${{ env.CONDA }}/envs
key:
conda-${{ runner.os }}-${{ runner.arch }}-${{steps.get-date.outputs.today }}-${{ hashFiles(matrix.label) }}-${{ env.CACHE_NUMBER }}
env:
CACHE_NUMBER: ${{ CACHE_NUMBER }}
id: cache

- if: steps.cache.outputs.cache-hit != 'true'
name: Update environment
run: mamba env update -n env-electron-python -f ${{ matrix.label }}

- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: "16"

- name: Build PyFlask distribution
run: npm run build:flask:${{ matrix.shorthand }}

- if: matrix.os == "windows-latest"
name: Run test on build executable
run: node tests/testPyinstallerExecutable.js ./build/nwb-guide/nwb-guide.exe

- if: matrix.os != "windows-latest"
name: Run test on build executable
run: node tests/testPyinstallerExecutable.js ./build/nwb-guide/nwb-guide

- name: Run test on distributed executable
run: node tests/testPyinstallerExecutable.js
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was some confusion on my part about this - after double checking the flags to pyinstaller, I see that the default path of your tests is indeed the 'distributable' (./build/flask/nwb-guide/nwb-guide.exe) and not the 'build' (./build/nwb-guide/nwb-guide.exe)

I've simply added the tests on the build, as PyInstaller refers to them, to be exhaustive in case there ever could be any difference between the two

Copy link
Member

@garrettmflynn garrettmflynn Aug 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sure. For some reason, I'd thought you meant that you'd target the dist/mac/NWB GUIDE.app/Contents/Resources/nwb-guide/nwb-guide file that is produced after copying the distributable file to the Electron app.

TBH I'm never touching the 'build' version, which is contained in a folder that primarily contains Pyinstaller logs, so we might just ignore it since it's unused.