Skip to content
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

add typemeta to kustomization #265

Merged
merged 1 commit into from
Aug 20, 2018
Merged

add typemeta to kustomization #265

merged 1 commit into from
Aug 20, 2018

Conversation

Liujingfang1
Copy link
Contributor

@Liujingfang1 Liujingfang1 commented Aug 16, 2018 •
edited
Loading

Fix #144

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Liujingfang1

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:

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 16, 2018
@Liujingfang1 Liujingfang1 requested review from mengqiy and removed request for justinsb August 16, 2018 23:24
mengqiy
mengqiy reviewed Aug 18, 2018
View reviewed changes
pkg/commands/kustomizationfile.go Outdated
@@ -203,6 +203,9 @@ func isCommentOrBlankLine(line []byte) bool {
// If the field wasn't in the original kustomization.yaml file or wasn't added,
// an empty []byte is returned.
func marshalField(field string, kustomization *types.Kustomization) ([]byte, error) {
if field == "apiVersion" {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a comment explaining why you need to do this? I don't quite understand.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In current marshalField function, the filed is assumed to be in a pattern that the correct field name can be get by strings.Title, such as kind --> Kind. However, apiVersion doesn't follow this pattern. Let me know if the assumption is to strong.

In addition, I found that KIND or Kind are supported by yaml. So I assume we also need to support them when we parse the kustomization.yaml file. That's why I added a (?i) in the regexp.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I refactored the code for finding the matching field. See if it looks better.

monopole
monopole reviewed Aug 20, 2018
View reviewed changes
pkg/commands/kustomizationfile.go Outdated
@@ -35,8 +35,8 @@ import (
)

var (
kustomizationFields = []string{"resources", "bases", "namePrefix", "namespace", "crds", "commonLabels", "commonAnnotations", "patches", "configMapGenerator", "secretGenerator", "vars", "imageTags"}
recognizedFields = regexp.MustCompile("^(" + strings.Join(kustomizationFields, "|") + "):")
kustomizationFields = []string{"apiVersion", "kind", "resources", "bases", "namePrefix", "namespace", "crds", "commonLabels", "commonAnnotations", "patches", "configMapGenerator", "secretGenerator", "vars", "imageTags"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add linebreaks for readability, e.g.

kustomizationFields = []string{
    "resources",
    "bases",

pkg/commands/kustomizationfile.go Outdated
kustomizationFields = []string{"resources", "bases", "namePrefix", "namespace", "crds", "commonLabels", "commonAnnotations", "patches", "configMapGenerator", "secretGenerator", "vars", "imageTags"}
recognizedFields = regexp.MustCompile("^(" + strings.Join(kustomizationFields, "|") + "):")
kustomizationFields = []string{"apiVersion", "kind", "resources", "bases", "namePrefix", "namespace", "crds", "commonLabels", "commonAnnotations", "patches", "configMapGenerator", "secretGenerator", "vars", "imageTags"}
recognizedFields = regexp.MustCompile("^(" + "(?i)" + strings.Join(kustomizationFields, "|") + "):")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a comment explaining (?i)

pkg/commands/kustomizationfile.go Outdated
@@ -203,6 +203,9 @@ func isCommentOrBlankLine(line []byte) bool {
// If the field wasn't in the original kustomization.yaml file or wasn't added,
// an empty []byte is returned.
func marshalField(field string, kustomization *types.Kustomization) ([]byte, error) {
if field == "apiVersion" {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 20, 2018
monopole
monopole approved these changes Aug 20, 2018
View reviewed changes
pkg/commands/kustomizationfile.go Outdated
} else {
matched, field := findMatchedField(line)
if matched {
mf.originalFields = append(mf.originalFields, &commentedField{field: field, comment: bytes.Join(comments, []byte(``))})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add some line feeds and use a helper to increase readbility.

eg

func squash(x [][]byte) []byte {
  return bytes.Join(x, []byte(``))
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds good. Will add it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

pkg/commands/kustomizationfile_test.go
@@ -158,7 +160,7 @@ vars:
kind: Service
name: my-service

bases:
BASES:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so this just tests case insensitivity? nice.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes

monopole
monopole approved these changes Aug 20, 2018
View reviewed changes
Copy link
Contributor

@monopole monopole left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 20, 2018
@monopole monopole merged commit bb8233c into kubernetes-sigs:master Aug 20, 2018
@r2d4 r2d4 mentioned this pull request Aug 30, 2018
Closed
@Liujingfang1 Liujingfang1 deleted the metadata branch September 6, 2018 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mengqiy mengqiy mengqiy left review comments

@monopole monopole monopole approved these changes

Assignees

@monopole monopole

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Liujingfang1 @k8s-ci-robot @mengqiy @monopole