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

Add check for API rule validation and fix type for Memcached test data #2113

Merged
merged 4 commits into from
Nov 4, 2019
+19 −2
Merged

Add check for API rule validation and fix type for Memcached test data #2113

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7ee4bd
add api rules validation
camilamacedo86 Oct 29, 2019
2c214dd
doc: note improvement review
camilamacedo86 Oct 31, 2019
0aea3b9
add TODO a requested in the review
camilamacedo86 Oct 31, 2019
4ddb69f
Update doc/user-guide.md
camilamacedo86 Nov 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,14 @@ type MemcachedSpec struct {
Size int32 `json:"size"`
}
type MemcachedStatus struct {
// Nodes are the names of the memcached pods
// Nodes are the names of the memcached pods
// +listType=set
Nodes []string `json:"nodes"`
}
```

**NOTE** To know more about `+listType=set` see : https://godoc.org/k8s.io/kube-openapi/pkg/idl
Copy link
Member

Choose a reason for hiding this comment

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

WDYT about making this note the similar to the one I suggested here?

NOTE: Comment directives, such as +listType=set, are necessary in certain situations to avoid API rule violations when generating OpenAPI files. See https://godoc.org/k8s.io/kube-openapi/pkg/idl to learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Much better :-)


After modifying the `*_types.go` file always run the following command to update the generated code for that resource type:

```sh
Expand Down
12 changes: 11 additions & 1 deletion hack/tests/scaffolding/scaffold-memcached.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ func main() {
filepath.Join(localSDKPath, "test/e2e/_incluster-test-code/main_test.go"): "test/e2e/main_test.go",
filepath.Join(localSDKPath, "test/e2e/_incluster-test-code/memcached_test.go"): "test/e2e/memcached_test.go",
}

for src, dst := range tmplFiles {
if err := os.MkdirAll(filepath.Dir(dst), fileutil.DefaultDirFileMode); err != nil {
log.Fatalf("Could not create template destination directory: %s", err)
Expand All @@ -139,6 +140,7 @@ func main() {
if err != nil {
log.Fatalf("Could not read pkg/apis/cache/v1alpha1/memcached_types.go: %v", err)
}

memcachedTypesFileLines := bytes.Split(memcachedTypesFile, []byte("\n"))
for lineNum, line := range memcachedTypesFileLines {
if strings.Contains(string(line), "type MemcachedSpec struct {") {
Expand All @@ -147,13 +149,16 @@ func main() {
break
}
}

for lineNum, line := range memcachedTypesFileLines {
if strings.Contains(string(line), "type MemcachedStatus struct {") {
memcachedTypesFileLinesIntermediate := append(memcachedTypesFileLines[:lineNum+1], []byte("\tNodes []string `json:\"nodes\"`"))
memcachedTypesFileLinesIntermediate := append(memcachedTypesFileLines[:lineNum+1], []byte("\t// +listType=set"))
memcachedTypesFileLinesIntermediate = append(memcachedTypesFileLinesIntermediate, []byte("\tNodes []string `json:\"nodes\"`"))
memcachedTypesFileLines = append(memcachedTypesFileLinesIntermediate, memcachedTypesFileLines[lineNum+3:]...)
break
}
}

if err := os.Remove("pkg/apis/cache/v1alpha1/memcached_types.go"); err != nil {
log.Fatalf("Failed to remove old memcached_type.go file: (%v)", err)
}
Expand All @@ -174,6 +179,11 @@ func main() {
log.Fatalf("Error: %v\nCommand Output: %s\n", err, string(cmdOut))
}

log.Print("Checking API rule violations")
if strings.Contains(string(cmdOut), "API rule violation") {
log.Fatalf("Error: %v\nCommand Output: %s\n", "API rule violations :", string(cmdOut))
}

log.Print("Pulling new dependencies with go mod")
cmdOut, err = exec.Command("go", "build", "./...").CombinedOutput()
if err != nil {
Expand Down