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.

Sign up for GitHub

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

Jump to bottom

Capture unrecognized fields with lint #851

Open

nicholy wants to merge 16 commits into main from spk-lint-update

Collaborator

nicholy commented Aug 25, 2023 •

edited

Loading

PR containing the current progress of updating the Spk lint command to capture typos and unrecognized config fields within the spk spec file. The current approach taken is to modify how the deserialize method works.

Example:

install:
  envionment:
    - priority: 99
  requirements:
    - pkg: python
      # we can use the version of python from the build environment to dynamically
      # define the install requirement
      fromBuildEnv: x.x

Outputs the error:

Failed temp-pkg.spk.yaml:
-----> Unrecognized key: enviroment. (Did you mean: 'environment'?)

nicholy requested review from jrray, rydrman and dcookspi

August 25, 2023 16:58

codecov bot commented Aug 25, 2023 •

edited

Loading

Codecov Report

Attention: 94 lines in your changes are missing coverage. Please review.

Comparison is base (e8cf549) 53.55% compared to head (6684c0e) 53.37%.
Report is 215 commits behind head on main.

❗ Current head 6684c0e differs from pull request most recent head e8f7f43. Consider uploading reports for the commit e8f7f43 to get more accurate results

Files	Patch %	Lines
crates/spk-schema/src/lints.rs	38.00%	31 Missing ⚠️
crates/spk-schema/src/environ.rs	76.40%	21 Missing ⚠️
crates/spk-schema/src/v0/spec.rs	56.41%	17 Missing ⚠️
crates/spk-cli/group4/src/cmd_lint.rs	0.00%	13 Missing ⚠️
crates/spk-schema/src/install_spec.rs	65.71%	12 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #851      +/-   ##
==========================================
- Coverage   53.55%   53.37%   -0.18%     
==========================================
  Files         258      258              
  Lines       20466    20474       +8     
==========================================
- Hits        10960    10928      -32     
- Misses       9506     9546      +40

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

nicholy self-assigned this

nicholy force-pushed the spk-lint-update branch from e8336fc to 1a4aa72 Compare

August 29, 2023 21:37

jrray requested changes

View reviewed changes

Collaborator

jrray left a comment

I think you're on the right track, just some course corrections here to save on duplicate code.

crates/spk-schema/src/install_spec.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/install_spec.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/install_spec.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/v0/spec.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/v0/spec.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/v0/spec.rs Outdated Show resolved Hide resolved

nicholy changed the title ~~Spk lint update to capture typos and uncrecognized config fields in the spec file~~ Draft: Spk lint update to capture typos and uncrecognized config fields in the spec file

jrray reviewed

View reviewed changes

crates/spk-schema/crates/ident/src/request.rs Outdated Show resolved Hide resolved

jrray reviewed

View reviewed changes

crates/spk-schema/crates/ident/src/request.rs Outdated Show resolved Hide resolved

jrray reviewed

View reviewed changes

crates/spk-schema/src/environ.rs Outdated Show resolved Hide resolved

jrray reviewed

View reviewed changes

crates/lint_proc_macro/src/lib.rs Outdated Show resolved Hide resolved

crates/lint_proc_macro/src/lints.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/source_spec.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/source_spec.rs Outdated Show resolved Hide resolved

crates/lint_proc_macro/src/lib.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/environ.rs Outdated Show resolved Hide resolved

nicholy force-pushed the spk-lint-update branch from 781fd74 to 3d6ce60 Compare

October 11, 2023 18:02

nicholy requested a review from jrray

October 12, 2023 18:05

rydrman force-pushed the main branch from 4639935 to d74e956 Compare

November 16, 2023 00:53

nicholy force-pushed the spk-lint-update branch from 0cfe037 to fadaa20 Compare

November 27, 2023 22:56

This was referenced Dec 6, 2023

Adding host_compat setting to package BuildSpec #922

Merged

DRAFT: Add host_compat lints (requires spk-lint-update) #929

Open

jrray requested changes

View reviewed changes

crates/spk-schema/Cargo.toml Outdated Show resolved Hide resolved

crates/spk-schema/src/build_spec.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/lints.rs Show resolved Hide resolved

crates/spk-schema/src/lints.rs Show resolved Hide resolved

crates/spk-schema/src/lints.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/requirements_list.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/spec.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/template.rs Outdated Show resolved Hide resolved

crates/spk-schema/src/v0/spec.rs Outdated Show resolved Hide resolved

nicholy force-pushed the spk-lint-update branch from 12078a4 to 0780595 Compare

January 3, 2024 21:15

nicholy requested a review from jrray

January 3, 2024 21:17

nicholy force-pushed the spk-lint-update branch from 179dace to 41834c9 Compare

January 19, 2024 21:29

nicholy changed the title ~~Draft: Spk lint update to capture typos and uncrecognized config fields in the spec file~~ Spk lint update to capture typos and unrecognized config fields in the spec file

nicholy added enhancement SPI AOI labels

nicholy changed the title ~~Spk lint update to capture typos and unrecognized config fields in the spec file~~ Capture unrecognized fields with lint

nicholy force-pushed the spk-lint-update branch from fa7569e to e8f7f43 Compare

January 22, 2024 18:24

Nichol Yip added 3 commits

August 26, 2024 15:59


          WIP: Updating spec deserialize method to handle lints.

9f5e86a

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Added LintedSpec type to return lint warnings

1b48468

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Implemented lint for the top level of the spec config

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Nichol Yip added 10 commits

August 26, 2024 16:01


          Added lints for InstallSpec

29d710b

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Fixed error message when no similar configs are found.

Added linting for EnvOp

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Removed redudancy and simplified code.

WIP: Generalizing LintedItem struct across all config types.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Added blanket implementation for LintedItem to generalize lints across all configs

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Moved lint logic into separate file.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

WIP: enum for lint messages

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Moved lint error message inside new lint file.

Fixed error message when unknown key is found.

Implemented LintMessage enum for current variantions of lint error types.

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Implemented lint feature for EnvOp

85d4aa5

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Reworked NoOp type for EnvOp to UnrecognizedKey.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

WIP: Adding lint feature to source spec

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Implemented lint feature for source spec

fe9c849

Removed lint from spk-schema/crates/ident

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Implemented linting feature for test spec and meta spec

bcbc053

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Implemented proc macro for linting feature

58278c8

Fixed configs to use Lint proc macro to generate lint messages

WIP: Add Lint proc macro for EnvOp and TestSpec

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Implemented lint feature for EnvOp and TestSpec

2df3f80

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Removed lint-proc-macro and replaced with using struct-field-names-as…

93d4866

…-array crate instead.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Fixed linting errors and removed unused commented code.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Removed dead commented code and fixed du test with the correct sizes.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Fixed issue where no default source spec if found when no source provided

Fixed issue with the default values for the meta struct when no values are provided

Reverted du command tests back as it was related to the issue with the source spec.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Fixed typo in opentimelineio.spk.yaml

Added render logic to linting command that caused some packages to return an error without it.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Added new line at EOF

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Fixed changes from rebase that was not correctly added.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Removed shellexpand call from EnvOp

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Moved crates to top level cargo.toml

Changed linting feature to return an UnknownKey object instead of a generated string

Modified new method for UnknownKey to store values needed to generated lint message

Added enum for lints to support different kinds of lints

Removed commented code

Refactored render method and renamed render_lint -> render_to_string

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Fixed changes from rebase

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Fixed linting errors

Signed-off-by: Nichol Yip <nyip@imageworks.com>

WIP: Properly convert UncheckedBuildSpec -> BuildSpec

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Implmented LintedBuildSpec struct to properly evaluate error if any, in the visitor method instead of the from implementation.

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Removed redundant struct and replaced with using LintedItem instead.

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Fixed changes from rebase

098e062

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Fix conflicts from rebase

e03d04d

nicholy force-pushed the spk-lint-update branch from e8f7f43 to e03d04d Compare

August 27, 2024 00:10

Nichol Yip added 3 commits

August 27, 2024 14:36


          Fix UncheckedBuildSpec deserialize() with newest version

6d0dddb

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Implemented linting for build options

67fa96c

Signed-off-by: Nichol Yip <nyip@imageworks.com>


          Assign linted_opts to unchecked.options once checks has passed.

6aaf500

Signed-off-by: Nichol Yip <nyip@imageworks.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement SPI AOI