Fix scripted tests on Mac: use portable sed -i syntax
#181
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
On Mac OS (which is BSD-based), the following sbt `scripted` tests
would fail:
* sbt-version-policy/example-sbt-ci-release
* sbt-version-policy/example-sbt-dynver
...with an error message like this:
```
sed: 1: "build.sbt": undefined label 'uild.sbt'
sbt.internal.scripted.TestException: {line 8} Command failed
```
The failing line would be like this:
https://github.com/scalacenter/sbt-version-policy/blob/b7fc360d8b55a78e018a45d970a959ffee4d357b/sbt-version-policy/src/sbt-test/sbt-version-policy/example-sbt-ci-release/test#L8C1-L8C103
```
$ exec sed -i 's/versionPolicyIntention := .*/versionPolicyIntention := Compatibility.None/' build.sbt
```
Unfortunately there's variation between the ways the 'optional'
backup-file-extension argument for `sed`'s change-in-place flag (`-i`) is
handled on Linux (GNU) vs Mac (BSD). GNU `sed` allows you to completely
omit the backup-file-extension argument, as in the `sed` line above - so
GitHub CI, running with Linux, passes fine!
However, with BSD `sed`, you have to provide _some_ argument to the `-i`
flag, even if it's just `''` to indicate you want no backup at all.
Consequently, on Mac the above line was interpreted as specifying a
backup-file-extension of `s/versionPolicyIntention .../` (obviously very
wrong), and the parser then treated `build.sbt` as the transformation
program for `sed` - starting with `b`, which is `sed`'s 'branching' command,
and then `uild.sbt` as the label to branch to, thus giving the `undefined label`
error - it's a mess.
The simplest way to get a portable `sed` command that works on both Mac OS and
Linux is to just supply a backup-file-extension argument (eg `.bak`), and then
gitignore the resulting `build.sbt.bak` files.
https://www.thegeekstuff.com/2009/12/unix-sed-tutorial-6-examples-for-sed-branching-operation/
https://unix.stackexchange.com/a/92907/46453
https://stackoverflow.com/a/22084103/438886
With this change, the `sbt scripted` suite passes on Mac OS.
rtyley
changed the title
sed inline syntax for Mac OS & Linuxscripted tests on Mac: use portable sed -i syntax
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.
On Mac OS (which is BSD-based), the following sbt
scriptedtests would fail:...with an error message like this:
The failing test line would be like this:
Unfortunately there's variation between the ways the 'optional' backup-file-extension argument for
sed's change-in-place flag (-i) is handled on Linux (GNU) vs Mac (BSD). GNUsedallows you to completely omit the backup-file-extension argument, as in thesedline above - so GitHub CI, running with Linux, passes fine!However, with BSD
sed, you have to provide some argument to the-iflag, even if it's just''to indicate you want no backup at all. Consequently, on Mac the above line was interpreted as specifying a backup-file-extension ofs/versionPolicyIntention .../(obviously very wrong), and the parser then treatedbuild.sbtas the transformation program forsed- starting withb, which issed's 'branching' command, and thenuild.sbtas the label to branch to, thus giving theundefined labelerror - it's a mess.Fix
The simplest way to get a portable
sedcommand that works on both Mac OS and Linux is to just supply a backup-file-extension argument (eg.bak), and then gitignore the resultingbuild.sbt.bakfiles.https://www.thegeekstuff.com/2009/12/unix-sed-tutorial-6-examples-for-sed-branching-operation/ https://unix.stackexchange.com/a/92907/46453
https://stackoverflow.com/a/22084103/438886
With this change, the
sbt scriptedsuite passes on Mac OS.