Add github workflow to validate samples #104

e-lo · 2023-02-01T17:40:45Z

This PR adds a GitHub workflow for sample validation and adds a script to locally validate schemas and samples as well as lint.

Also:

linting
added requirements for jsonschema
updated documentation

Uses frictionlessdata/repository - which doesn't allow flag `--schema-sync` so will likely need to modify

e-lo · 2023-02-01T19:20:34Z

While it doesn't seem like there is the ability to add --schema-sync flag to the frictionless repository action at this time, they have created an issue for it.

You can at this time add an inquiry to the repository action, which in turn can skip various errors such as extra-label. That said, I don't see a way to make sure that optional fields in the schema aren't flagged...

botanize

Ok, glad they're looking into it. I don't think we should merge this workflow until there's a mechanism to specify --schema-sync, otherwise it will just produce huge reports (1 line per row of the csv!) full of spurious errors.

The alternative is to run frictionless validate --schema-sync directly in the workflow instead of using the frictionless repository workflow.

…flow

...so we can use --schema-sync Also publishes a comment with the validation of sample data. Need sample data really to test effectively.

So you don't need to copy/paste from documentation

…ed issues.

botanize

Hi! Overall this is good, but a few specific issues that need to be dealt with.

move away from deprecated set-output command
deal with dependencies for test script
fix jsonschema-cli validation step

See other comments for suggestions.

Joey

.github/workflows/validate_samples.yml

test

Script will find all executables in /tests and run them. validate_profile script now downloads the json-schema for profiles from URL Also: - update docs - fix script

botanize

Some lingering errors in tests

tests/validate_samples

tests/test_all

set-output --> $GITHUB_ENV external placeholder.com --> octocons + schema-sync

+ nullglob ** --> *

e-lo · 2023-07-12T19:17:05Z

@botanize I think i got all your comments addressed in subsequent commits minus the one suggesting that only do validation on the files that actually changed (we can address that when we have files to do).

botanize

I'd still like to test this on actual sample data, but everything else seems to work, so let's merge.

Add github workflow to validate samples

ebabddc

Uses frictionlessdata/repository - which doesn't allow flag `--schema-sync` so will likely need to modify

e-lo added 🧹 chore 💻 code Pertains to the infrastructure code labels Feb 1, 2023

e-lo requested a review from botanize February 1, 2023 17:40

e-lo self-assigned this Feb 1, 2023

e-lo mentioned this pull request Feb 1, 2023

Pr2 sample data add workflow #101

Closed

botanize reviewed Feb 1, 2023

View reviewed changes

e-lo assigned SorenSpicknall Jun 21, 2023

e-lo added 7 commits July 11, 2023 13:41

remove using frictionless repository

22593cf

Merge remote-tracking branch 'upstream/main' into add-validation-work…

b7bf61e

…flow

lint / update pre-commit config to default to push

2f6d667

lint

e2f5327

Shifts from using frictionless framework to frictionless package

a720ff2

...so we can use --schema-sync Also publishes a comment with the validation of sample data. Need sample data really to test effectively.

Adds local testing/validation script

1500b1c

So you don't need to copy/paste from documentation

Updates documentation for testing since this should fix the highlight…

daf934a

…ed issues.

e-lo requested review from botanize and gabriel-korbato July 11, 2023 22:36

botanize requested changes Jul 12, 2023

View reviewed changes

e-lo added 3 commits July 12, 2023 10:51

eliminate noisy print stmt in main.py

ee00bcc

Move tests to separate scripts in /tests dir

c2cc5a4

Script will find all executables in /tests and run them. validate_profile script now downloads the json-schema for profiles from URL Also: - update docs - fix script

add recommendation to use a virtual environment and include links

3321da5

botanize requested changes Jul 12, 2023

View reviewed changes

tests/validate_samples Outdated Show resolved Hide resolved

tests/test_all Outdated Show resolved Hide resolved

tests/test_all Outdated Show resolved Hide resolved

e-lo added 3 commits July 12, 2023 11:54

Addressed PR review comments:

77e4291

set-output --> $GITHUB_ENV external placeholder.com --> octocons + schema-sync

Fix glob search in validate_samples

1fa7ca2

+ nullglob ** --> *

Fix test progress tracking

778c2aa

e-lo requested a review from botanize July 12, 2023 19:17

botanize approved these changes Jul 12, 2023

View reviewed changes

e-lo merged commit 9624947 into TIDES-transit:main Jul 13, 2023
0 of 2 checks passed

e-lo deleted the add-validation-workflow branch July 13, 2023 20:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add github workflow to validate samples #104

Add github workflow to validate samples #104

e-lo commented Feb 1, 2023 •

edited

Loading

e-lo commented Feb 1, 2023

botanize left a comment

botanize left a comment •

edited by e-lo

Loading

botanize left a comment

e-lo commented Jul 12, 2023

botanize left a comment

Add github workflow to validate samples #104

Add github workflow to validate samples #104

Conversation

e-lo commented Feb 1, 2023 • edited Loading

e-lo commented Feb 1, 2023

botanize left a comment

Choose a reason for hiding this comment

botanize left a comment • edited by e-lo Loading

Choose a reason for hiding this comment

botanize left a comment

Choose a reason for hiding this comment

e-lo commented Jul 12, 2023

botanize left a comment

Choose a reason for hiding this comment

e-lo commented Feb 1, 2023 •

edited

Loading

botanize left a comment •

edited by e-lo

Loading