feat: add support for multiple objects in files #12

eddycharly · 2023-05-04T22:04:29Z

This PR adds support for multiple objects in files.

alexzielenski · 2023-05-04T22:06:49Z

could you also add a few cases case to the test suite?

all files success
with only one document has error
all documents have error

testing infra may also need to be modified to parse the error comments correctly

eddycharly · 2023-05-04T22:08:33Z

could you also add a few cases case to the test suite?

Will do

apelisse · 2023-05-04T22:18:15Z

Other wise, I think it looks correct, thanks.

eddycharly · 2023-05-04T22:23:18Z

But I think some test are not passing currently.

alexzielenski · 2023-05-10T18:44:21Z

@eddycharly Is there anything I can do to help unblock this?

eddycharly · 2023-05-10T20:45:55Z

@alexzielenski there's a bug in this implementation and i need to add some tests, will do right now.

eddycharly · 2023-05-10T21:09:33Z

pkg/cmd/validate.go

+			onlyComments := true
+			for _, line := range strings.Split(string(document), "\n") {
+				if strings.TrimSpace(line) == "" {
+					continue
+				} else if !strings.HasPrefix(line, "#") {
+					onlyComments = false
+					break
+				}
+			}
+			if !onlyComments {
+				documents = append(documents, []byte(document))
+			}


@apelisse @alexzielenski does this make sense ? (skip the document if it contains only comments)

I think that mirror's kubectl's behavior. Though I think if the list of documents at the end is empty there should be an error.

On a per file basis ?

on a per-invocation basis. Mirroring kubectl's behavior

kubectl-validate ./emptyfile ./pod.yaml is accepted and validates pod.yaml
kubectl-validate ./emptyfile is an error since there were no documents given to validate
kubectl-validate ./emptyfile ./anotheremptyfile is an error since there were no documents given to validate

ok, this means we have to load all files first then check for potential error and then eventually start processing.
it changes the logic we have today where we process one file at a time.

can we log an issue and address this in another PR ?

eddycharly · 2023-05-10T21:10:51Z

Added more test cases

testcases/manifests/error_multiple_resources_all_invalid.yaml

eddycharly · 2023-05-11T08:50:40Z

pkg/cmd/validate.go

 		fmt.Fprintln(cmd.OutOrStdout(), string(data))
 	}

 	return nil
 }

-func ValidateFile(filePath string, resolver *validatorfactory.ValidatorFactory) error {
+func ValidateFile(filePath string, resolver *validatorfactory.ValidatorFactory) []error {


@alexzielenski is this a good approach to return a slice of errors ?

Yes but I think the skipped documents should leave nil error element so the returned errors matches and ordering and amount of input documents

But the nil error will result in a success Status entry, looks strange as it didn't exercise the validation process at all (a skipped document is one that contains only comments right ?)

That is true. I am concerned about the confusing interface where input documents != output statuses. What do you think of this idea:

Rather than return a slice of errors, return a map of GVKNN (group-verison-kind-namespace-name) to error. This would make it very clear which error is associated with which document. Skipped documents would not need to be included. The human output would remain the same, but the JSON output contains clear machine-readable association between document and error.

I thought about that but it is allowed to have multiple identical GVKNN documents in the same file.

Rats. Tough. I am still learning towards recording empty documents as success. It looks like for the human output we only log the non-nil errors so for people using the tool directly it's not confusing. For JSON output I think it makes most sense to keep Success status for empty docs.

@alexzielenski i updated the PR to preserve empty documents.

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

eddycharly · 2023-05-12T20:32:51Z

@alexzielenski PTAL when you have time.

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

alexzielenski

/lgtm
/approve

thanks for adding this!

k8s-ci-robot · 2023-05-25T18:04:10Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alexzielenski, eddycharly

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [alexzielenski]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

feat: add support for multiple objects in files

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 4, 2023

k8s-ci-robot requested review from alexzielenski and apelisse May 4, 2023 22:04

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 4, 2023

eddycharly force-pushed the multiple-objects branch from 066717e to e6f295a Compare May 10, 2023 20:47

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 10, 2023

eddycharly commented May 10, 2023

View reviewed changes

alexzielenski reviewed May 10, 2023

View reviewed changes

testcases/manifests/error_multiple_resources_all_invalid.yaml Show resolved Hide resolved

eddycharly force-pushed the multiple-objects branch from 1dbbbe1 to 58a18e8 Compare May 11, 2023 08:49

eddycharly commented May 11, 2023

View reviewed changes

eddycharly added 8 commits May 12, 2023 22:00

feat: add support for multiple objects in files

e119045

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

feat: add multiple documents in file support

54ec02a

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

use helpers

b23bcfd

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

rename

389e089

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

fix test

93ba0d7

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

add tests

aadd429

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

support empty objects

3fbf747

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

multiple errors

c769268

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

eddycharly force-pushed the multiple-objects branch from 58a18e8 to c769268 Compare May 12, 2023 20:01

split yaml documents helper

782b72b

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

eddycharly force-pushed the multiple-objects branch from 7521aa4 to 822dbd2 Compare May 12, 2023 20:20

fix test

8f88d9c

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

eddycharly force-pushed the multiple-objects branch from 822dbd2 to 8f88d9c Compare May 12, 2023 20:24

preserve empty documents

98d473e

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>

eddycharly mentioned this pull request May 25, 2023

test: add unit test for local crds client #46

Merged

alexzielenski approved these changes May 25, 2023

View reviewed changes

k8s-ci-robot assigned alexzielenski May 25, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 25, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 25, 2023

k8s-ci-robot merged commit baf053e into kubernetes-sigs:main May 25, 2023

eyarz pushed a commit to eyarz/kubectl-validate that referenced this pull request Jul 5, 2023

Merge pull request kubernetes-sigs#12 from eddycharly/multiple-objects

e1cea90

feat: add support for multiple objects in files

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for multiple objects in files #12

feat: add support for multiple objects in files #12

eddycharly commented May 4, 2023

alexzielenski commented May 4, 2023

eddycharly commented May 4, 2023

apelisse commented May 4, 2023

eddycharly commented May 4, 2023

alexzielenski commented May 10, 2023

eddycharly commented May 10, 2023

eddycharly May 10, 2023 •

edited

Loading

alexzielenski May 11, 2023

eddycharly May 12, 2023

alexzielenski May 12, 2023

eddycharly May 12, 2023

alexzielenski May 12, 2023

eddycharly commented May 10, 2023

eddycharly May 11, 2023

alexzielenski May 11, 2023

eddycharly May 12, 2023

alexzielenski May 12, 2023

eddycharly May 12, 2023

alexzielenski May 12, 2023 •

edited

Loading

eddycharly May 25, 2023

eddycharly commented May 12, 2023

alexzielenski left a comment

k8s-ci-robot commented May 25, 2023

feat: add support for multiple objects in files #12

feat: add support for multiple objects in files #12

Conversation

eddycharly commented May 4, 2023

alexzielenski commented May 4, 2023

eddycharly commented May 4, 2023

apelisse commented May 4, 2023

eddycharly commented May 4, 2023

alexzielenski commented May 10, 2023

eddycharly commented May 10, 2023

eddycharly May 10, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eddycharly commented May 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexzielenski May 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eddycharly commented May 12, 2023

alexzielenski left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 25, 2023

eddycharly May 10, 2023 •

edited

Loading

alexzielenski May 12, 2023 •

edited

Loading