├── .github └── repo_meta.yaml ├── .gitignore ├── LICENSE ├── README.md ├── action.yml └── st_smoke_test.py /.github/repo_meta.yaml: -------------------------------------------------------------------------------- 1 | # point_of_contact: the owner of this repository, can be a GitHub user or GitHub team 2 | point_of_contact: sfc-gh-jcarroll 3 | 4 | # production: whether this repository meets the criteria for being "production", see https://snowflakecomputing.atlassian.net/wiki/spaces/CLO/pages/2239988967/Production+Repository+Criteria for criteria 5 | production: true 6 | 7 | # distributed: whether any source code in this repository is distributed directly to customers (e.g. driver and frontend software) 8 | distributed: true 9 | 10 | # modified: whether any open source dependencies in this repository have been modified 11 | modified: false 12 | 13 | # release_branches: list of release branch patterns, exact matches or regex is acceptable 14 | release_branches: 15 | - main 16 | - release.* 17 | 18 | # code_owners_file_present: whether there is a CODEOWNERS file in this repository 19 | code_owners_file_present: false 20 | 21 | # jira_project_issue_type: the jira issuetype used to raise issues related to this repository in the SNOW Jira project 22 | jira_project_issue_type: Bug 23 | 24 | # jira_area: the jira area that raised issues should use 25 | jira_area: Streamlit 26 | 27 | # audit_in_scope: whether this repository is included in scope for audits or certifications (SOX, SOC, ISO, Fedramp etc.) 28 | audit_in_scope: false 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # streamlit-app-action 2 | 3 | Github Action providing simple workflows for validating a Streamlit app. This action will: 4 | 5 | - Run `pytest` for any tests, including [Streamlit AppTests](https://docs.streamlit.io/library/api-reference/app-testing), 6 | that are part of your repo. 7 | - Run a smoke test AppTest that runs each page of your app and verifies no exceptions are thrown on the initial run 8 | - Optionally, run [ruff](https://github.com/astral-sh/ruff) for linting and formatting via 9 | [ruff-action](https://github.com/ChartBoost/ruff-action). 10 | 11 | ## Usage 12 | 13 | Use the action by creating a `.yml` file in the `.github/workflows/` folder of your GitHub repository with contents 14 | like the example below. This specific example will run the ruff linting and smoke testing action each time there's 15 | a push to the `main` branch or a pull request update targeting main. 16 | 17 | You can learn more in the [GitHub Actions documentation](https://docs.github.com/en/actions) and the section on 18 | [GitHub Actions workflows](https://docs.github.com/en/actions/using-workflows/about-workflows). 19 | 20 | ```yml 21 | name: Streamlit app 22 | 23 | on: 24 | push: 25 | branches: [ "main" ] 26 | pull_request: 27 | branches: [ "main" ] 28 | 29 | permissions: 30 | contents: read 31 | 32 | jobs: 33 | streamlit: 34 | runs-on: ubuntu-latest 35 | steps: 36 | - uses: actions/checkout@v4 37 | - uses: actions/setup-python@v5 38 | with: 39 | python-version: '3.11' 40 | - uses: streamlit/streamlit-app-action@v0.0.3 41 | with: 42 | app-path: streamlit_app.py 43 | ruff: true 44 | ``` 45 | 46 | ### Printing a pretty output of test results 47 | 48 | [pytest-results-action](https://github.com/marketplace/actions/pytest-results-actions) is a useful action 49 | to print the output of pytest runs in your GitHub Actions workflow summary view. You can add it as follows: 50 | 51 | ```yml 52 | # ... setup as above ... 53 | - uses: streamlit/streamlit-app-action@v0.0.3 54 | with: 55 | app-path: streamlit_app.py 56 | ruff: true 57 | # Add pytest-args to output junit xml 58 | pytest-args: -v --junit-xml=test-results.xml 59 | - if: always() 60 | uses: pmeier/pytest-results-action@v0.6.0 61 | with: 62 | path: test-results.xml 63 | summary: true 64 | display-options: fEX 65 | ``` 66 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: 'Streamlit App Action' 2 | description: 'Validate a Streamlit app with smoke tests and linting' 3 | branding: 4 | icon: 'book' 5 | color: 'blue' 6 | inputs: 7 | app-path: 8 | description: 'Filepath to the main app file (`streamlit run `)' 9 | required: false 10 | default: 'streamlit_app.py' 11 | ruff: 12 | description: 'Run ruff linting' 13 | required: false 14 | default: 'false' 15 | pytest-args: 16 | description: 'Command line arguments to pass to pytest' 17 | required: false 18 | default: '-v' 19 | skip-smoke: 20 | description: 'Skip the provided smoke test. Useful if your app testing requires advanced setup.' 21 | required: false 22 | default: 'false' 23 | runs: 24 | using: "composite" 25 | steps: 26 | - name: Install dependencies 27 | # Note: This is basically a no-op if you don't use `requirements.txt`. 28 | # In that case, add a step in your workflow to install dependencies 29 | # using your own package manager before calling streamlit-app-action. 30 | shell: bash 31 | run: | 32 | python -m pip install --upgrade pip 33 | pip install pytest 34 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 35 | - if: ${{ inputs.ruff == 'true' }} 36 | name: Lint with ruff 37 | uses: astral-sh/ruff-action@v3 38 | # TODO: Add ability to define example secrets.toml values for smoke test 39 | - name: Test with pytest 40 | shell: bash 41 | run: | 42 | cp $GITHUB_ACTION_PATH/*.py . 43 | python -m pytest ${{ inputs.pytest-args }} 44 | env: 45 | APP_PATH: ${{ inputs.app-path }} 46 | SKIP_SMOKE: ${{ inputs.skip-smoke }} 47 | -------------------------------------------------------------------------------- /st_smoke_test.py: -------------------------------------------------------------------------------- 1 | import os 2 | import unittest 3 | from pathlib import Path 4 | 5 | from streamlit.testing.v1 import AppTest 6 | 7 | APP_PATH = os.getenv("APP_PATH", default="streamlit_app.py") 8 | SKIP_SMOKE = os.getenv("SKIP_SMOKE", "False").lower() in ("true", "1", "t") 9 | 10 | 11 | def get_file_paths() -> list[str]: 12 | """Get a list of file paths for the main page + each page in the pages folder.""" 13 | page_folder = Path(APP_PATH).parent / "pages" 14 | if not page_folder.exists(): 15 | return [APP_PATH] 16 | page_files = page_folder.glob("*.py") 17 | file_paths = [str(file.absolute().resolve()) for file in page_files] 18 | return [APP_PATH] + file_paths 19 | 20 | 21 | def pytest_generate_tests(metafunc): 22 | """ 23 | This is a special function that is called automatically by pytest to generate tests. 24 | https://docs.pytest.org/en/7.1.x/how-to/parametrize.html#pytest-generate-tests 25 | 26 | This generates list of file paths for each page in the pages folder, which will 27 | automatically be used if a test function has an argument called "file_path". 28 | 29 | Each file path will be the absolute path to each file, but the test ids will be 30 | just the file name. This is so that the test output is easier to read. 31 | 32 | st_smoke_test.py::test_smoke_page[streamlit_app.py] PASSED [ 33%] 33 | st_smoke_test.py::test_smoke_page[p1.py] PASSED [ 66%] 34 | st_smoke_test.py::test_smoke_page[p2.py] PASSED [100%] 35 | """ 36 | if "file_path" in metafunc.fixturenames: 37 | metafunc.parametrize( 38 | "file_path", get_file_paths(), ids=lambda x: x.split("/")[-1] 39 | ) 40 | 41 | 42 | @unittest.skipIf(SKIP_SMOKE, "smoke test is disabled by config") 43 | def test_smoke_page(file_path): 44 | """ 45 | This will run a basic test on each page in the pages folder, checking to see that 46 | there are no exceptions raised while the app runs. 47 | """ 48 | at = AppTest.from_file(file_path, default_timeout=100).run() 49 | assert not at.exception 50 | --------------------------------------------------------------------------------