Set up automated bash tests with bats #1721
Merged
+227
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@jdeanwallace sorry for the PR/review flood… I’m not blocked by any of them, so no pressure from my side, especially if you want to play around a bit with bats. |
jotaen4tinypilot
changed the title
…ons/2-tests # Conflicts: # .dockerignore
Automated comment from CodeApprove ➜👀 @jotaen4tinypilot it's your turn, please take a look |
jdeanwallace
approved these changes
Jan 16, 2024
There was a problem hiding this comment.
Automated comment from CodeApprove ➜
✔️ Approved
Nice, bats looks pretty cool.
👀 @jotaen4tinypilot it's your turn please take a look
mtlynch
changed the title
jotaen4tinypilot
added a commit
that referenced
this pull request
Jan 17, 2024
Related #1710. This PR adds a unified script to remove TinyPilot marker sections from files. We will [use this script in a subsequent PR](#1722) to simplify the corresponding instances in the [unset-static-ip](https://github.com/tiny-pilot/tinypilot/blob/2e211199a21a2a6c285c5d1d2ff60eff6afa77d4/debian-pkg/opt/tinypilot-privileged/scripts/unset-static-ip#L64-L81) and [change-hostname](https://github.com/tiny-pilot/tinypilot/blob/8e99d5a666df12d851b14dd4276e8b95ab958493/debian-pkg/opt/tinypilot-privileged/scripts/change-hostname#L62-L79) privileged scripts. ## Notes - Unless someone feels strongly about the [originally mentioned `remove-tinypilot-lines` script name](https://github.com/tiny-pilot/tinypilot/issues/1710#:~:text=opt/tinypilot/scripts/-,remove%2Dtinypilot%2Dlines,-%3C%20example.conf) (or any other name), I thought that `strip-marker-sections` sounded most expressive. - I added a comment to the `lib/markers.sh` file, to explain the marker idea in a bit more detail. - There will be automated bash tests for this in [a subsequent PR](#1721). <a data-ca-tag href="https://codeapprove.com/pr/tiny-pilot/tinypilot/1720"><img src="https://codeapprove.com/external/github-tag-allbg.png" alt="Review on CodeApprove" /></a> --------- Co-authored-by: Jan Heuermann <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1714.
Related #1710.
Stacked onto #1720.
This PR sets up bash tests with bats, and adds a first test suite for the
strip-marker-sectionsscript.Notes
.batstest file next to the script under test. The directive in.dockerignoreremoves it from the bundle /.debfile.build_bashdev script is called “build” for consistency withbuild_pythonandbuild_javascript, even though we technically don’t build something. I’ve created Consolidate naming and responsibility of dev scripts #1716 for us to potentially reconsider this overall.build_bash, it somehow felt reasonable to me to search all places that are likely to contain.batsfiles, even though we currently only have them in/opt/tinypilot-privileged/scripts/. I don’t feel strongly about this, though./bin/bash, so it fails to execute any of our bash scripts that have a#!/bin/bashshebang (which is effectively all of them). We instead would either have to change all our shebangs to the (most portable)#!/usr/bin/env bashshebang, or we just install bats manually like done here (in the Circle conf).