Capture unrecognized fields with lint #851

nicholy · 2023-08-25T16:58:54Z

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'?)

codecov · 2023-08-25T17:23:15Z

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.

jrray

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

crates/spk-schema/src/v0/spec.rs

crates/spk-schema/crates/ident/src/request.rs

crates/spk-schema/src/environ.rs

crates/lint_proc_macro/src/lib.rs

crates/lint_proc_macro/src/lints.rs

crates/spk-schema/src/source_spec.rs

crates/lint_proc_macro/src/lib.rs

crates/spk-schema/src/environ.rs

crates/spk-schema/Cargo.toml

crates/spk-schema/src/build_spec.rs

crates/spk-schema/src/lints.rs

crates/spk-schema/src/requirements_list.rs

crates/spk-schema/src/spec.rs

crates/spk-schema/src/template.rs

crates/spk-schema/src/v0/spec.rs

Signed-off-by: Nichol Yip <[email protected]>

Signed-off-by: Nichol Yip <[email protected]> Fixed error message when no similar configs are found. Added linting for EnvOp Signed-off-by: Nichol Yip <[email protected]> Removed redudancy and simplified code. WIP: Generalizing LintedItem struct across all config types. Signed-off-by: Nichol Yip <[email protected]> Added blanket implementation for LintedItem to generalize lints across all configs Signed-off-by: Nichol Yip <[email protected]> Moved lint logic into separate file. Signed-off-by: Nichol Yip <[email protected]> WIP: enum for lint messages Signed-off-by: Nichol Yip <[email protected]> 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 <[email protected]>

Signed-off-by: Nichol Yip <[email protected]>

Signed-off-by: Nichol Yip <[email protected]> WIP: Adding lint feature to source spec Signed-off-by: Nichol Yip <[email protected]>

Removed lint from spk-schema/crates/ident Signed-off-by: Nichol Yip <[email protected]>

Signed-off-by: Nichol Yip <[email protected]>

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 <[email protected]>

Signed-off-by: Nichol Yip <[email protected]>

…-array crate instead. Signed-off-by: Nichol Yip <[email protected]> Fixed linting errors and removed unused commented code. Signed-off-by: Nichol Yip <[email protected]> Removed dead commented code and fixed du test with the correct sizes. Signed-off-by: Nichol Yip <[email protected]> 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 <[email protected]> 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 <[email protected]> Added new line at EOF Signed-off-by: Nichol Yip <[email protected]> Fixed changes from rebase that was not correctly added. Signed-off-by: Nichol Yip <[email protected]> Removed shellexpand call from EnvOp Signed-off-by: Nichol Yip <[email protected]> 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 <[email protected]> Fixed changes from rebase Signed-off-by: Nichol Yip <[email protected]> Fixed linting errors Signed-off-by: Nichol Yip <[email protected]> WIP: Properly convert UncheckedBuildSpec -> BuildSpec Signed-off-by: Nichol Yip <[email protected]> Implmented LintedBuildSpec struct to properly evaluate error if any, in the visitor method instead of the from implementation. Signed-off-by: Nichol Yip <[email protected]> Removed redundant struct and replaced with using LintedItem instead. Signed-off-by: Nichol Yip <[email protected]>

Signed-off-by: Nichol Yip <[email protected]>

…the multiple priority config check. Signed-off-by: Nichol Yip <[email protected]>

crates/spk-cli/group4/src/cmd_lint.rs

crates/spk-schema/src/v0/spec.rs

- Fix how lints are outputted to CLI Signed-off-by: Nichol Yip <[email protected]>

- Update lint command to use LintedSpec type to search for lints Signed-off-by: Nichol Yip <[email protected]>

nicholy requested review from jrray, rydrman and dcookspi August 25, 2023 16:58

nicholy self-assigned this Aug 29, 2023

nicholy force-pushed the spk-lint-update branch from e8336fc to 1a4aa72 Compare August 29, 2023 21:37

jrray requested changes Aug 29, 2023

View reviewed changes

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 Aug 29, 2023

jrray reviewed Sep 12, 2023

View reviewed changes

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

jrray reviewed Sep 12, 2023

View reviewed changes

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

jrray reviewed Sep 12, 2023

View reviewed changes

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

jrray reviewed Oct 4, 2023

View reviewed changes

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 Dec 20, 2023

View reviewed changes

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 Jan 20, 2024

nicholy added enhancement New feature or request SPI AOI Area of interest for SPI labels Jan 20, 2024

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

nicholy force-pushed the spk-lint-update branch from fa7569e to e8f7f43 Compare January 22, 2024 18:24

nicholy force-pushed the spk-lint-update branch from e8f7f43 to e03d04d Compare August 27, 2024 00:10

Nichol Yip added 2 commits November 26, 2024 15:02

WIP: Updating spec deserialize method to handle lints.

de1bd3e

Signed-off-by: Nichol Yip <[email protected]>

Added LintedSpec type to return lint warnings

a779d98

Signed-off-by: Nichol Yip <[email protected]>

Nichol Yip added 14 commits November 26, 2024 15:04

Implemented lint for the top level of the spec config

a00320c

Signed-off-by: Nichol Yip <[email protected]>

Implemented lint feature for EnvOp

6eb0548

Signed-off-by: Nichol Yip <[email protected]>

Reworked NoOp type for EnvOp to UnrecognizedKey.

fec37c1

Signed-off-by: Nichol Yip <[email protected]> WIP: Adding lint feature to source spec Signed-off-by: Nichol Yip <[email protected]>

Implemented lint feature for source spec

d564896

Removed lint from spk-schema/crates/ident Signed-off-by: Nichol Yip <[email protected]>

Implemented linting feature for test spec and meta spec

8616d4d

Signed-off-by: Nichol Yip <[email protected]>

Implemented proc macro for linting feature

d0e0e15

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 <[email protected]>

Implemented lint feature for EnvOp and TestSpec

2a31cc3

Signed-off-by: Nichol Yip <[email protected]>

Fixed changes from rebase

dd1ca7a

Signed-off-by: Nichol Yip <[email protected]>

Fix conflicts from rebase

c27b748

Fix UncheckedBuildSpec deserialize() with newest version

07c0bf5

Signed-off-by: Nichol Yip <[email protected]>

Implemented linting for build options

dd11693

Signed-off-by: Nichol Yip <[email protected]>

Assign linted_opts to unchecked.options once checks has passed.

1d3dd1d

Signed-off-by: Nichol Yip <[email protected]>

nicholy force-pushed the spk-lint-update branch from 6aaf500 to 1d3dd1d Compare December 3, 2024 18:34

add more context in linted message.

77fbd44

Signed-off-by: Nichol Yip <[email protected]>

nicholy force-pushed the spk-lint-update branch 2 times, most recently from b2e7f58 to eae90a7 Compare December 6, 2024 23:26

Fix issue where EnvOpList was not properly deserialized and bypassed …

798bba3

…the multiple priority config check. Signed-off-by: Nichol Yip <[email protected]>

nicholy force-pushed the spk-lint-update branch from eae90a7 to 798bba3 Compare December 6, 2024 23:28

jrray reviewed Dec 10, 2024

View reviewed changes

crates/spk-cli/group4/src/cmd_lint.rs Outdated Show resolved Hide resolved

jrray reviewed Dec 10, 2024

View reviewed changes

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

nicholy force-pushed the spk-lint-update branch 2 times, most recently from 9cd241e to 4476e05 Compare December 11, 2024 22:04

- Implement test cases for spec types that has Lints implemented

65897cd

- Fix how lints are outputted to CLI Signed-off-by: Nichol Yip <[email protected]>

nicholy force-pushed the spk-lint-update branch from 4476e05 to 65897cd Compare December 11, 2024 22:15

- Add new type LintedSpec to return the linted spec object

a2c82cb

- Update lint command to use LintedSpec type to search for lints Signed-off-by: Nichol Yip <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Capture unrecognized fields with lint #851

Capture unrecognized fields with lint #851

nicholy commented Aug 25, 2023 •

edited

Loading

codecov bot commented Aug 25, 2023 •

edited

Loading

jrray left a comment

Capture unrecognized fields with lint #851

Are you sure you want to change the base?

Capture unrecognized fields with lint #851

Conversation

nicholy commented Aug 25, 2023 • edited Loading

codecov bot commented Aug 25, 2023 • edited Loading

Codecov Report

jrray left a comment

Choose a reason for hiding this comment

nicholy commented Aug 25, 2023 •

edited

Loading

codecov bot commented Aug 25, 2023 •

edited

Loading