Added JSON input validation for CLI commands #1771

andrewnester · 2024-09-13T11:29:13Z

Changes

Added JSON input validation for CLI commands. Now when invalid JSON passed as a payload to CLI commands, CLI performs input normalisation and detects if there are any mismatches such as incorrect types, unknown fields and etc.

This diagnostic information is printed in standard error output and does not block command execution, so the change is backward compatible.

This PR also addresses issue when values which are considered "empty" in Go (such as false, 0, "" and etc.) were ignored and not passed to API request payload.

Fixes #1769 #1764 #1625 #1560

Tests

Added unit tests

andrew.nester@HFW9Y94129 ~ % databricks jobs create --json '{"seeti}'
Error: error decoding JSON at (inline):1:2: unexpected EOF


andrew.nester@HFW9Y94129 ~ % databricks jobs create --json '{"seeti": true}'
Warning: unknown field: seeti
  in (inline):1:9

Error: Job settings must be specified.

libs/flags/json_flag.go

libs/dyn/jsonloader/json.go

pietern · 2024-09-13T11:52:41Z

libs/flags/json_flag.go

@@ -33,7 +35,27 @@ func (j *JsonFlag) Unmarshal(v any) error {
 	if j.raw == nil {
 		return nil
 	}
-	return json.Unmarshal(j.raw, v)
+
+	dv, err := jsonloader.LoadJSON(j.raw)


Could we do the same for the YAML flag?

I believe that's the only reason we still depend on github.com/ghodss/yaml. This package uses the json tags in the types as opposed to yaml tags, which the upstream YAML package uses. Since we use the json tags as well in the dyn package it should be possible to replace it.

Not blocking for this PR, of course.

libs/dyn/convert/to_typed.go

libs/dyn/jsonloader/json_test.go

libs/dyn/jsonloader/locations.go

libs/flags/json_flag.go

libs/flags/json_flag_test.go

Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>

libs/flags/json_flag.go

libs/dyn/convert/to_typed.go

libs/dyn/jsonloader/json.go

libs/dyn/jsonloader/json_test.go

libs/dyn/jsonloader/json.go

libs/cmdio/render.go

libs/dyn/convert/to_typed.go

libs/dyn/jsonloader/json.go

pietern

Thanks, can you TAL at the PR summary before merging?

CLI: * Added JSON input validation for CLI commands ([#1771](#1771)). Bundles: * Support Git worktrees for `sync` ([#1831](#1831)). * Add `bundle summary` to display URLs for deployed resources ([#1731](#1731)). * Added a warning when incorrect permissions used for `/Workspace/Shared` bundle root ([#1821](#1821)). * Show actionable errors for collaborative deployment scenarios ([#1386](#1386)). * Fix path to repository-wide exclude file ([#1837](#1837)). * Fixed typo in converting cluster permissions ([#1826](#1826)). * Ignore metastore permission error during template generation ([#1819](#1819)). * Handle normalization of `dyn.KindTime` into an any type ([#1836](#1836)). * Added support for pip options in environment dependencies ([#1842](#1842)). * Fix race condition when restarting continuous jobs ([#1849](#1849)). * Fix pipeline in default-python template not working for certain workspaces ([#1854](#1854)). * Add "output" flag to the bundle sync command ([#1853](#1853)). Internal: * Move utility functions dealing with IAM to libs/iamutil ([#1820](#1820)). * Remove unused `IS_OWNER` constant ([#1823](#1823)). * Assert SDK version is consistent in the CLI generation process ([#1814](#1814)). * Fixed unmarshalling json input into `interface{}` type ([#1832](#1832)). * Fix `TestAccFsMkdirWhenFileExistsAtPath` in isolated Azure environments ([#1833](#1833)). * Add behavioral tests for examples from the YAML spec ([#1835](#1835)). * Remove Terraform conversion function that's no longer used ([#1840](#1840)). * Encode assumptions about the dashboards API in a test ([#1839](#1839)). * Add script to make testing of code on branches easier ([#1844](#1844)). API Changes: * Added `databricks disable-legacy-dbfs` command group. OpenAPI commit cf9c61453990df0f9453670f2fe68e1b128647a2 (2024-10-14) Dependency updates: * Upgrade TF provider to 1.54.0 ([#1852](#1852)). * Bump github.com/databricks/databricks-sdk-go from 0.48.0 to 0.49.0 ([#1843](#1843)).

CLI: * Added JSON input validation for CLI commands ([#1771](#1771)). * Support Git worktrees for `sync` ([#1831](#1831)). Bundles: * Add `bundle summary` to display URLs for deployed resources ([#1731](#1731)). * Added a warning when incorrect permissions used for `/Workspace/Shared` bundle root ([#1821](#1821)). * Show actionable errors for collaborative deployment scenarios ([#1386](#1386)). * Fix path to repository-wide exclude file ([#1837](#1837)). * Fixed typo in converting cluster permissions ([#1826](#1826)). * Ignore metastore permission error during template generation ([#1819](#1819)). * Handle normalization of `dyn.KindTime` into an any type ([#1836](#1836)). * Added support for pip options in environment dependencies ([#1842](#1842)). * Fix race condition when restarting continuous jobs ([#1849](#1849)). * Fix pipeline in default-python template not working for certain workspaces ([#1854](#1854)). * Add "output" flag to the bundle sync command ([#1853](#1853)). Internal: * Move utility functions dealing with IAM to libs/iamutil ([#1820](#1820)). * Remove unused `IS_OWNER` constant ([#1823](#1823)). * Assert SDK version is consistent in the CLI generation process ([#1814](#1814)). * Fixed unmarshalling json input into `interface{}` type ([#1832](#1832)). * Fix `TestAccFsMkdirWhenFileExistsAtPath` in isolated Azure environments ([#1833](#1833)). * Add behavioral tests for examples from the YAML spec ([#1835](#1835)). * Remove Terraform conversion function that's no longer used ([#1840](#1840)). * Encode assumptions about the dashboards API in a test ([#1839](#1839)). * Add script to make testing of code on branches easier ([#1844](#1844)). API Changes: * Added `databricks disable-legacy-dbfs` command group. OpenAPI commit cf9c61453990df0f9453670f2fe68e1b128647a2 (2024-10-14) Dependency updates: * Upgrade TF provider to 1.54.0 ([#1852](#1852)). * Bump github.com/databricks/databricks-sdk-go from 0.48.0 to 0.49.0 ([#1843](#1843)).

Added JSON input validation for CLI commands

58ab2f2

andrewnester added the do-not-merge label Sep 13, 2024

andrewnester requested a review from pietern September 13, 2024 11:29

pietern reviewed Sep 13, 2024

View reviewed changes

pietern mentioned this pull request Sep 25, 2024

Run test to confirm type mismatch errors and opportunities #1171

Closed

track location correctly

0aca374

andrewnester requested a review from pietern October 3, 2024 14:10

andrewnester changed the title ~~[WIP] Added JSON input validation for CLI commands~~ Added JSON input validation for CLI commands Oct 3, 2024

use marshal.Unmarshal to set ForceSendFields

b0aeee5

andrewnester removed the do-not-merge label Oct 4, 2024

pietern reviewed Oct 4, 2024

View reviewed changes

andrewnester and others added 2 commits October 8, 2024 13:30

Update libs/flags/json_flag.go

dbb3c2b

Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>

use diagnostics instead of error

3ddf6b5

andrewnester requested a review from pietern October 8, 2024 13:37

andrewnester added 4 commits October 8, 2024 15:45

refactor

5f839e3

return error

5a0197e

Merge branch 'main' into feature/payload-mismatch

1280428

fix overrides

7594836

andrewnester mentioned this pull request Oct 10, 2024

Better error when an invalid value is provided for the --json flag #1825

Open

pietern reviewed Oct 10, 2024

View reviewed changes

libs/flags/json_flag.go Show resolved Hide resolved

libs/dyn/convert/to_typed.go Outdated Show resolved Hide resolved

libs/dyn/convert/to_typed.go Show resolved Hide resolved

libs/dyn/jsonloader/json.go Show resolved Hide resolved

libs/dyn/jsonloader/json_test.go Show resolved Hide resolved

andrewnester requested a review from pietern October 11, 2024 10:17

andrewnester added 3 commits October 11, 2024 12:17

fixes

cf2ab73

fix test

35f2d58

use dynassert

d25d95b

pietern reviewed Oct 11, 2024

View reviewed changes

libs/dyn/jsonloader/json.go Outdated Show resolved Hide resolved

fixed key location

d4a3346

andrewnester requested a review from pietern October 11, 2024 12:42

removed path changes

82d6640

andrewnester enabled auto-merge October 11, 2024 13:08

pietern reviewed Oct 11, 2024

View reviewed changes

libs/cmdio/render.go Outdated Show resolved Hide resolved

libs/dyn/convert/to_typed.go Show resolved Hide resolved

libs/dyn/jsonloader/json.go Show resolved Hide resolved

libs/dyn/jsonloader/json.go Show resolved Hide resolved

fixes

71bc701

andrewnester requested a review from pietern October 11, 2024 14:32

pietern disabled auto-merge October 11, 2024 14:35

pietern approved these changes Oct 11, 2024

View reviewed changes

andrewnester added this pull request to the merge queue Oct 11, 2024

Merged via the queue into main with commit f0e2981 Oct 11, 2024
5 checks passed

andrewnester deleted the feature/payload-mismatch branch October 11, 2024 14:46

andrewnester mentioned this pull request Oct 23, 2024

[Release] Release v0.231.0 #1856

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added JSON input validation for CLI commands #1771

Added JSON input validation for CLI commands #1771

andrewnester commented Sep 13, 2024 •

edited

Loading

pietern Sep 13, 2024

pietern left a comment

Added JSON input validation for CLI commands #1771

Added JSON input validation for CLI commands #1771

Conversation

andrewnester commented Sep 13, 2024 • edited Loading

Changes

Tests

pietern Sep 13, 2024

Choose a reason for hiding this comment

pietern left a comment

Choose a reason for hiding this comment

andrewnester commented Sep 13, 2024 •

edited

Loading