pkg/generator: fold apis/**.go generators into renderPkg() #40

fanminshi · 2018-02-22T20:42:52Z

allows command new to generate all necessary files under pkg/apis/**.
and refactor the code in renderPkg() to make it more readable.
change naming apis -> api

fanminshi · 2018-02-22T20:44:10Z

Manual Test:
$ ./operator-sdk/operator-sdk new play-operator --api-version=play.example.com/v1alpha1 --kind PlayService
Output:

└── play-operator
    ├── cmd
    │   └── play-operator
    │       └── main.go
    ├── config
    ├── deploy
    ├── pkg
    │   ├── apis
    │   │   └── play
    │   │       └── v1alpha1
    │   │           ├── doc.go
    │   │           ├── register.go
    │   │           └── types.go
    │   └── stub
    │       └── handler.go
    └── tmp
        ├── build
        └── codegen

fanminshi · 2018-02-22T20:44:41Z

cc/ @hasbro17 @hongchaodeng

hongchaodeng · 2018-02-22T20:46:15Z

pkg/generator/generator.go

+	return ioutil.WriteFile(filepath.Join(apiDir, types), buf.Bytes(), 0644)
+}
+
+func renderSubDirFiles(stubDir string) error {


SubDir is confusing. Can you rename it better?

sorry my mistake. it should be stubDir

hongchaodeng · 2018-02-22T20:46:52Z

pkg/generator/generator.go

 		return err
 	}
-	if err := ioutil.WriteFile(filepath.Join(sDir, handler), buf.Bytes(), 0644); err != nil {
+	if err := ioutil.WriteFile(filepath.Join(apiDir, doc), buf.Bytes(), 0644); err != nil {


0644

define const

hongchaodeng · 2018-02-22T20:47:24Z

pkg/generator/generator.go

-	if err := os.MkdirAll(filepath.Join(g.projectName, apisDir, apiDirName(g.apiVersion), version(g.apiVersion)), defaultFileMode); err != nil {
+	v := version(g.apiVersion)
+	apiDir := filepath.Join(g.projectName, apisDir, apiDirName(g.apiVersion), v)
+	if err := os.MkdirAll(apiDir, defaultFileMode); err != nil {


defaultFileMode -> defaultFileModeForFolder

I think defaultDirFileMode is more concise.

Sounds good

hongchaodeng · 2018-02-22T20:49:26Z

pkg/generator/generator.go

-	return nil
+
+	buf = &bytes.Buffer{}
+	if err := renderApisRegister(buf, kind, groupName, version); err != nil {


renderAPIDirRegisterFile

Or renderAPIRegisterFile. But change renderAPIDirFiles -> renderAPIFiles

kk, I am going to follow this convention:
if rendering a dir such as renderPkg, no need to add Dir suffix.
If rendering a file such as renderApisRegister, then we want to be more specific as in renderAPIRegisterFile

I will have another pr to refactor other render* functions to follow above convention.

Sounds good

fanminshi · 2018-02-22T21:16:20Z

Latest test output:

play-operator/
├── cmd
│   └── play-operator
│       └── main.go
├── config
├── deploy
├── pkg
│   ├── apis
│   │   └── play
│   │       └── v1alpha1
│   │           ├── doc.go
│   │           ├── register.go
│   │           └── types.go
│   └── stub
│       └── handler.go
└── tmp
    ├── build
    └── codegen

fanminshi · 2018-02-22T21:19:26Z

all fixed! PTAL cc/ @hongchaodeng

hongchaodeng · 2018-02-22T21:21:02Z

LGTM

hasbro17 · 2018-02-22T21:25:09Z

pkg/generator/gen_api_doc.go

 )

-// Doc contains all the customized data needed to generate apis/../doc.go for a new operator
+// Doc contains all the customized data needed to generate apis/<version>/doc.go for a new operator


Just curious but is the comment supposed to be apis/<apiDirName>/<version>/doc.go since the example generated file is at pkg/apis/play/v1alpha1/doc.go.

@hasbro17 good catch! will fix this in a new pr.

Additions: - chore: bump go 1.17, k8s 1.23, and kubebuilder 3.3 (#69) - chore(deps): update to Quarkus SDK extension 3.0.2 and Quarkus 2.6.3 (#70) - chore(deps): update to use Quarkus JOSDK extension 3.0.1 (#67) - Remove useless file (#65) - chore: bump k8s 1.22.2 and kubebuilder 3.2 (#64) - exposed exnpoints for micrometer metrics (#45) - modified the Quarkus operator SDK version and tutorial too (#40) - chore: bump fabric8 5.8.0 & quarkus 2.4.0 (#42) - modified the doc file and removed file after generation (#41) - release: fix release script to understand release branches (#38) Bug Fixes: - Fix for wrongly generated file name (#73) Signed-off-by: jesus m. rodriguez <jesusr@redhat.com>

hongchaodeng reviewed Feb 22, 2018

View reviewed changes

pkg/generator: fold apis/**.go generators into renderPkg()

578b665

pkg/generator: renaming Apis -> API

70e8296

fanminshi merged commit b1e731e into operator-framework:master Feb 22, 2018

hongchaodeng deleted the hook_gen_apis branch February 22, 2018 21:21

hasbro17 reviewed Feb 22, 2018

View reviewed changes

jmrodri mentioned this pull request Feb 4, 2022

chore: bump java-operator-plugins to v0.2.0 #5542

Merged

2 tasks

pkg/generator: fold apis/**.go generators into renderPkg() #40

pkg/generator: fold apis/**.go generators into renderPkg() #40

Uh oh!

Conversation

fanminshi commented Feb 22, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fanminshi commented Feb 22, 2018

Uh oh!

fanminshi commented Feb 22, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fanminshi commented Feb 22, 2018

Uh oh!

fanminshi commented Feb 22, 2018

Uh oh!

hongchaodeng commented Feb 22, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fanminshi commented Feb 22, 2018 •

edited

Loading