add regression tests

.github/workflows/continuous-integration.yaml

@@ -0,0 +1,40 @@
+name: Continuous Integration
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Install Python dependencies
+ run: pip3 install .
+
+ - name: Start Fava
+ working-directory: example
+ run: fava example.beancount &
+
+ - name: Install test dependencies
+ run: cd tests/e2e; npm ci
+
+ - name: Run tests
+ run: |
+ # replace canvas renderer with SVG renderer
+ sed -i 's/echarts.init(elem)/echarts.init(elem, null, { renderer: "svg" })/' fava_dashboards/static/dashboard.js
+ cat fava_dashboards/static/dashboard.js
+
+ cd tests/e2e; npm test -- -t SVG
+ env:
+ LANG: en_US
+
+ - name: Run formatter
+ run: |
+ make format
+ git diff --exit-code

Makefile

@@ -1,5 +1,5 @@
 format:
- prettier -w fava_dashboards/static/*.js fava_dashboards/static/*.css
+ prettier -w fava_dashboards/static/*.js fava_dashboards/static/*.css tests/e2e/*.js
  black fava_dashboards/__init__.py scripts/format_js_in_dashboard.py
  ./scripts/format_js_in_dashboard.py example/dashboards.yaml
  find . -name '*.beancount' -exec bean-format -c 59 -o "{}" "{}" \;

README.md

@@ -2,11 +2,11 @@
 fava-dashboards allows creating custom dashboards in [Fava](https://github.com/beancount/fava).
 
 Example dashboards with random data:
-[![Overview](example/overview.png)](example/overview.png)
-[![Assets](example/assets.png)](example/assets.png)
-[![Income and Expenses](example/income_expenses.png)](example/income_expenses.png)
-[![Travelling](example/travelling.png)](example/travelling.png)
-[![Sankey](example/sankey.png)](example/sankey.png)
+[![Overview](tests/e2e/__image_snapshots__/dashboard_overview.png)](tests/e2e/__image_snapshots__/dashboard_overview.png)
+[![Assets](tests/e2e/__image_snapshots__/dashboard_assets.png)](tests/e2e/__image_snapshots__/dashboard_assets.png)
+[![Income and Expenses](tests/e2e/__image_snapshots__/dashboard_income_and_expenses.png)](tests/e2e/__image_snapshots__/dashboard_income_and_expenses.png)
+[![Travelling](tests/e2e/__image_snapshots__/dashboard_travelling.png)](tests/e2e/__image_snapshots__/dashboard_travelling.png)
+[![Sankey](tests/e2e/__image_snapshots__/dashboard_sankey.png)](tests/e2e/__image_snapshots__/dashboard_sankey.png)
 
 ## Installation
 ```

setup.cfg

@@ -13,6 +13,6 @@ python_requires = >=3.6
 setup_requires =
  setuptools_scm
 install_requires =
- fava>=1.22
+ fava>=1.22,<1.25
  beancount
  pyyaml

tests/e2e/.gitignore

@@ -0,0 +1 @@
+node_modules