Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metaschema XSLT Inspector #73

Conversation

wendellpiez
Copy link
Collaborator

Committer Notes

Working towards #72

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you squashed any non-relevant commits and commit messages? [instructions]
  • Do all automated CI/CD checks pass?

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all website and readme documentation affected by the changes you made? Changes to the website can be made in the website/content directory of your branch.

@wendellpiez
Copy link
Collaborator Author

See wiki page here: https://github.com/usnistgov/metaschema-xslt/wiki/InspectorXSLT

Discussion board to come (watch for link).

@wendellpiez wendellpiez marked this pull request as ready for review November 20, 2023 21:33
@wendellpiez wendellpiez requested a review from a team as a code owner November 20, 2023 21:33
@wendellpiez wendellpiez changed the base branch from develop to feature-InspectorXSLT November 21, 2023 21:02
Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initial feedback, but more to follow with an approval later today or tomorrow when I experiment with it more and make sure I don't find any major problems. Looks good so far. I know we discussed README organization and separation. I would think it is better to make it in a different repo to not confuse consumers of this repo, but you are the maintainer. Not my repo! :-)

src/schema-gen/InspectorXSLT/TESTING.md Outdated Show resolved Hide resolved
src/schema-gen/InspectorXSLT/testing/readme.md Outdated Show resolved Hide resolved
@wendellpiez
Copy link
Collaborator Author

Closes #72

@wendellpiez
Copy link
Collaborator Author

@aj-stein-nist aj-stein-nist changed the base branch from feature-InspectorXSLT to develop January 30, 2024 22:22
@aj-stein-nist aj-stein-nist force-pushed the issue72-XSLT-inspectorA branch 2 times, most recently from 049e94b to f773efd Compare February 2, 2024 15:30
This change integrates the Makefile-based testing harness for each of
the submodules.

For the InspectorXSLT submodule in the schema-gen directory, integrate
the shell script that orchestrates Maven's installation of dependencies
and execution of XML Calabash to run XProc files. The XProc pipeline
files will run the XSpec tests in batch mode.
Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wendellpiez, I am re-reviewing and approving at the time of this message to signal I am happy with the current version of the CI additions, now with more STDOUT and STDERR logging to move us forward. If you want me to re-review after you add relevant documentation, feel free to do so, but I already reviewed the other XSLT, XSpec, XProc, and shell script changes here as needed to advance this work.

@wendellpiez
Copy link
Collaborator Author

@aj-stein-nist please feel free to re-review changes -- mainly in TESTING.md documentation (not perfect yet but better), plus also a couple of tweaks elsewhere.

The remaining desideratum for this Issue is to have CI on a PR report failure not only for broken runs but also for successful runs reporting test failures. I have vacillated but I think this is more or less essential.

A cheap/dirty way to do this is by inspecting the outputs for key (regex) match patterns.

And there could be better options. (Maybe our testing could produce a format that Github Actions could use?) Happy for any thoughts.

@wendellpiez
Copy link
Collaborator Author

In the current 'integration tests' (smoke tests) we have failures successfully reported by at least one XSpec -

https://github.com/usnistgov/metaschema-xslt/actions/runs/7791678616/job/21248238501?pr=73#step:5:144

We have the option of making either script or XSLT runtime error out, but it makes sense to catch this gracefully, non? (Unless an actual reporting-XML concept takes hold.)

@wendellpiez wendellpiez changed the base branch from develop to feature-InspectorXSLT February 6, 2024 18:01
@wendellpiez wendellpiez merged commit d8c759d into usnistgov:feature-InspectorXSLT Feb 6, 2024
1 check passed
aj-stein-nist added a commit that referenced this pull request Feb 16, 2024
* Metaschema XSLT Inspector (#73)

Several months of work building InspectorXSLT using test-driven-development.
Also includes considerable work on XSpec support including XProc and Saxon runtimes, scripts and CI/CD support.

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>

* Update XSPEC-BATCH.xsl

On-the-fly modification of JUnit XML results

* Adjustments to XSpec reporting under CI (#99)

* Fine adjustments in prep for 'nearly good enough' XSpec support under ci/cd (in feature branch)

* Adjustments for legibility

* Another touchup

* Buffs in view of CI/CD and local/CL use cases for testing under make including new error-on-fail option

* Added to script documentation

* Still polishing help msg

* Now with some more nicer XProc and scripting supporting ongoing maintenance / dev

* adjustments to test runtime

* Further refinements to testing & scripts

* Rationalizing including file name regularization

* Further configuration enhancements

* More help in docs

* Further testing/tuning/tweaking test runtimes and docs

* Further alignment

* New 'quiet' XSpec batching script, plus adjustment

* New 'make' feature for testing InspectorXSLT

* More Makefile edits / cleanup

* Further docs and readme improvements

* Removed obsolete Schematron implementation, no longer of interest

* More polishing

* Further small but useful improvements and cleanup

* Added another utility script

* Continuing to touch up

* Add permissions for EnricoMi/publish-unit-test-result-action

Using the guidance from the action's instructions:

https://github.com/EnricoMi/publish-unit-test-result-action?tab=readme-ov-file#support-fork-repositories-and-dependabot-branches

* Add artifact event pull for EnricoMi/publish-unit-test-result-action

Using the guidance from the action's instructions:

https://github.com/EnricoMi/publish-unit-test-result-action?tab=readme-ov-file#support-fork-repositories-and-dependabot-branches

* Ensure XSpec test results comment always made on PR

* [WIP] Dedupe event trigger and inline JUnit XML processing in CI workflow

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
wendellpiez added a commit to wendellpiez/metaschema-xslt that referenced this pull request Jun 6, 2024
Several months of work building InspectorXSLT using test-driven-development.
Also includes considerable work on XSpec support including XProc and Saxon runtimes, scripts and CI/CD support.

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
wendellpiez added a commit to wendellpiez/metaschema-xslt that referenced this pull request Jun 7, 2024
…gov#73)

Several months of work building InspectorXSLT using test-driven-development.
Also includes considerable work on XSpec support including XProc and Saxon runtimes, scripts and CI/CD support.

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants