This is an automated email from the ASF dual-hosted git repository.
slawrence pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/daffodil-sbt.git
The following commit(s) were added to refs/heads/main by this push:
new ae53bb3 Improve ease of testing
ae53bb3 is described below
commit ae53bb381d684240a6068e7c6d579008cb1d9285
Author: Steve Lawrence <[email protected]>
AuthorDate: Wed Apr 10 09:44:14 2024 -0400
Improve ease of testing
- Modify the SBT test task so that it also evalutes the scripted task to
run all scripted tests. New users don't need to know about the
scripted command to know how to run tests.
- Add documentation to provide more information and a link about the
scripted framework since it is not commonly used outside of plugins
- Modify CI to run `sbt test`. This will trigger scripted tests as well
as other tests if we ever add them.
- Also fix indentation level of headers
Closed #20
---
.github/workflows/main.yml | 4 ++--
README.md | 40 +++++++++++++++++++++++++++++++++++++---
build.sbt | 6 ++++++
3 files changed, 45 insertions(+), 5 deletions(-)
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 59ad081..d1289be 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -93,8 +93,8 @@ jobs:
# Check
############################################################
- - name: Run Scripted Tests
- run: $SBT scripted
+ - name: Run Tests
+ run: $SBT test
# Lint checks that do not require compilation
lint:
diff --git a/README.md b/README.md
index 202763f..3e38a8b 100644
--- a/README.md
+++ b/README.md
@@ -122,7 +122,7 @@ Note that only saved parsers for `daffodilVersion` can be
referenced. For this
reason, `daffodilVersion` must also be defined in `daffodilPackageBinVersions`
if `daffodilTdmlUsesPackageBin` is `true`.
-## Layers and User Defined Functions
+### Layers and User Defined Functions
If your schema project builds a Daffodil layer or user defined function, then
set the `daffodilBuildsLayer` or `daffodilBuildsUDF` setting to true,
@@ -148,7 +148,7 @@ name, for example:
crossPaths := false
```
-## Flat Directory Layout
+### Flat Directory Layout
Instead of using the standard `src/{main,test}/{scala,resources}/` directory
layout that SBT defaults to, a flatter layout can be used for simple schemas,
@@ -164,8 +164,42 @@ root `src/` directory, and all test source and resource
files to be in a root
`test/` directory. Source files are those that end with `*.scala` or `*.java`,
and resource files are anything else.
-# License
+## Testing
+
+This plugin use the [scripted test framework] for testing. Each directory in
+`src/sbt-test/sbt-daffodil/` is a small SBT project the uses this plugin, and
+defines a `test.script` file that lists sbt commandss and file system checks to
+run.
+
+To run all tests, run either of these commands:
+
+```bash
+sbt test
+sbt scripted
+```
+
+To run a single scripted test, run the command:
+
+```bash
+sbt "scripted sbt-daffodil/<test_name>"
+```
+
+Where `<test_name>` is the name of a directory in `src/sbt-test/sbt-daffodil/`.
+
+When a scripted test fails it is sometimes helpful to directly run SBT commands
+within the test directory. To do so, publish the plugin locally, cd to the
+scripted test directory, and run SBT defining the version of the plugin that
+was just published, for example:
+
+```bash
+sbt publishLocal
+cd src/sbt-test/sbt-daffodil/<test_name>
+sbt -Dplugin.version=1.0.0-SNAPSHOT
+```
+
+## License
Apache Daffodil SBT Plugin is licensed under the [Apache License, v2.0].
[Apache License, v2.0]: https://www.apache.org/licenses/LICENSE-2.0
+[scripted test framework]:
https://www.scala-sbt.org/1.x/docs/Testing-sbt-plugins.html
diff --git a/build.sbt b/build.sbt
index 45dd126..7b99e2e 100644
--- a/build.sbt
+++ b/build.sbt
@@ -58,3 +58,9 @@ ratExcludes := Seq(
)
ratFailBinaries := true
+
+Test / test := {
+ // run all scripted tasks as part of testing
+ (Compile / scripted).toTask("").value
+ (Test / test).value
+}
