Added feature to take input from stdin #50

lauchokyip · 2023-05-27T03:11:18Z

Fixes #32

This is the approach I can think of, definitely need more feedback to improve the PR. Please let me know if this approach is good. Appreciate it

k8s-ci-robot · 2023-05-27T03:11:26Z

Welcome @lauchokyip!

It looks like this is your first PR to kubernetes-sigs/kubectl-validate 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubectl-validate has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2023-05-27T03:11:28Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: lauchokyip
Once this PR has been reviewed and has the lgtm label, please assign richabanker for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

lauchokyip · 2023-05-27T03:12:50Z

/cc @apelisse

alexzielenski

/ok-to-test
thanks for adding this! this approach looks generally correct to me. few minor comments

alexzielenski · 2023-05-30T17:46:39Z

pkg/cmd/validate.go

-		for _, path := range files {
-			fmt.Fprintf(cmd.OutOrStdout(), "\n\033[1m%v\033[0m...", path)
+		for _, reader := range ioReaders {
+			f := reader.(*os.File)


Is it possible to change the type of ioReaders to []*os.File to avoid this cast

alexzielenski · 2023-05-30T17:47:19Z

pkg/cmd/validate.go

@@ -199,12 +219,13 @@ func (c *commandFlags) Run(cmd *cobra.Command, args []string) error {
 	return nil
 }

-func ValidateFile(filePath string, resolver *validatorfactory.ValidatorFactory) []error {
-	fileBytes, err := os.ReadFile(filePath)
+func ValidateFile(reader io.Reader, resolver *validatorfactory.ValidatorFactory) []error {


I would rather change this function to take a []byte than io.Reader

alexzielenski · 2023-05-30T17:49:09Z

pkg/cmd/validate.go

-	if err != nil {
-		return err
+	var ioReaders []io.Reader
+	if args[0] != "-" {


This forces stdin only to be available if it is the only "path" provided. Does this mirror kubectl's behavior? What happens in kubectl if you provide - and a file?

you mean by doing -f - -f somefile.yaml? I think they should both be read.

And I agree, we should support kubectl validate somefile.yaml - somedir/

@alexzielenski, @apelisse , do you mean something like

cat pod.yaml | kubectl apply -f - -f pod1.yaml?

And I agree, we should suppose kubectl validate somefile.yaml - somedir/

Can the - work for a directory?

Should the command work like? -f will give us a good idea of all the files given

kubectl validate -f file1 -f file2 -f -

Can the - work for a directory?

What does it mean for stdin to be a directory? Not sure I understand that question.

Should the command work like? -f will give us a good idea of all the files given

IMO, this was terrible on kubectl's end. I think they may require/ask for plugins to use that syntax, but that's always been pretty awful.

What does it mean for stdin to be a directory? Not sure I understand that question.

the argument followed right after - should stdin right? but when you have kubectl validate somefile.yaml - somedir/ , will it accept somedir as a valid argument since it's a directory instead of stdin?

Hmmm I am really not sure what would be our end goal here, sounds like when you have plugin, all the flags used by kubectl will be reserved? Will the kubectl;s flag be overwritten by plugin or is it the other way around?

What does it mean for stdin to be a directory? Not sure I understand that question.

the argument followed right after - should stdin right? but when you have kubectl validate somefile.yaml - somedir/ , will it accept somedir as a valid argument since it's a directory instead of stdin?

there seems to be a misunderstanding. - means that it needs to read stdin on top of reading the other arguments given as a parameter. so basically, I would expect kubectl validate somefile.yaml - somedir/ to validate the resources in somefile.yaml, those given through stdin, and all the resources recursively found in somedir/. One question might be, what do we do if we have multiple -? But I think repeated - can safely be ignored.

Thanks for the clarification, appreciate it

alexzielenski

Apologies for the delayed review. I've left some comments.

I would also like to see some tests added for this new feature before we merge

alexzielenski · 2023-07-05T17:37:19Z

pkg/cmd/validate.go

 	if err != nil {
 		return []error{fmt.Errorf("error reading file: %w", err)}
 	}
-	if utils.IsYaml(filePath) {
+	if utils.IsYaml(file.Name()) {


I don't think this works with the stdin os.File name.

alexzielenski · 2023-07-05T17:39:24Z

pkg/cmd/validate.go

+				return err
+			}
+			for _, fileName := range fileNames {
+				f, err := os.Open(fileName)


Storing open file handles like this may result in having open an excessively large number of them(for users who are validating large numbers of files)

alexzielenski · 2023-07-05T17:41:33Z

pkg/cmd/validate.go

-	files, err := utils.FindFiles(args...)
-	if err != nil {
-		return err
+	var files []*os.File


I think it'd be a smaller change to just filter - out from the list of files and note in a variable that we also want to validate stdin.

k8s-ci-robot · 2023-07-28T11:37:08Z

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

apelisse · 2023-08-24T16:03:47Z

@lauchokyip Do you plan on working on this? I don't think it's far from being merged.

k8s-triage-robot · 2024-01-21T04:13:57Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2024-02-20T04:27:18Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle rotten
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2024-03-21T05:11:22Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen
Mark this PR as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

k8s-ci-robot · 2024-03-21T05:11:27Z

@k8s-triage-robot: Closed this PR.

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Reopen this PR with /reopen

Mark this PR as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

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

k8s-ci-robot requested review from alexzielenski and richabanker May 27, 2023 03:11

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

k8s-ci-robot requested a review from apelisse May 27, 2023 03:12

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 28, 2023

alexzielenski reviewed May 30, 2023

View reviewed changes

k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label May 30, 2023

lauchokyip added 4 commits May 30, 2023 19:07

Added feature to take input from stdin

13b0b80

closed files

3c00343

working

0435e7d

address comments

49e213b

lauchokyip force-pushed the readFromStdIn branch from 657e199 to 49e213b Compare May 30, 2023 23:17

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 30, 2023

lauchokyip requested a review from alexzielenski May 30, 2023 23:19

address duplicate

d1bcad8

alexzielenski reviewed Jul 5, 2023

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jul 28, 2023

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 21, 2024

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 20, 2024

k8s-ci-robot closed this Mar 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added feature to take input from stdin #50

Added feature to take input from stdin #50

lauchokyip commented May 27, 2023

k8s-ci-robot commented May 27, 2023

k8s-ci-robot commented May 27, 2023

lauchokyip commented May 27, 2023

alexzielenski left a comment

alexzielenski May 30, 2023

alexzielenski May 30, 2023

alexzielenski May 30, 2023

apelisse May 30, 2023

apelisse May 30, 2023 •

edited

lauchokyip May 30, 2023 •

edited

lauchokyip May 30, 2023 •

edited

lauchokyip May 30, 2023

apelisse May 30, 2023

lauchokyip May 30, 2023 •

edited

apelisse May 30, 2023

lauchokyip May 30, 2023

alexzielenski left a comment

alexzielenski Jul 5, 2023

alexzielenski Jul 5, 2023

alexzielenski Jul 5, 2023

k8s-ci-robot commented Jul 28, 2023

apelisse commented Aug 24, 2023

k8s-triage-robot commented Jan 21, 2024

k8s-triage-robot commented Feb 20, 2024

k8s-triage-robot commented Mar 21, 2024

k8s-ci-robot commented Mar 21, 2024

Added feature to take input from stdin #50

Added feature to take input from stdin #50

Conversation

lauchokyip commented May 27, 2023

k8s-ci-robot commented May 27, 2023

k8s-ci-robot commented May 27, 2023

lauchokyip commented May 27, 2023

alexzielenski left a 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

apelisse May 30, 2023 • edited

Choose a reason for hiding this comment

lauchokyip May 30, 2023 • edited

Choose a reason for hiding this comment

lauchokyip May 30, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lauchokyip May 30, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexzielenski left a 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

k8s-ci-robot commented Jul 28, 2023

apelisse commented Aug 24, 2023

k8s-triage-robot commented Jan 21, 2024

k8s-triage-robot commented Feb 20, 2024

k8s-triage-robot commented Mar 21, 2024

k8s-ci-robot commented Mar 21, 2024

apelisse May 30, 2023 •

edited

lauchokyip May 30, 2023 •

edited

lauchokyip May 30, 2023 •

edited

lauchokyip May 30, 2023 •

edited