Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
add test for UneededGoFiles
  • Loading branch information
shamil committed Dec 12, 2023
commit fcd55207a1f2fe83316b81944673ca141e54ec92
8 changes: 4 additions & 4 deletions pkg/codegen/golang.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import (
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
)

var unneededGoFiles = codegen.NewStringSet(
var UnneededGoFiles = codegen.NewStringSet(
// The root directory doesn't define any resources:
"doc.go",
"init.go",
Expand Down Expand Up @@ -76,7 +76,7 @@ func GenerateGo(pg *PackageGenerator, name string) (buffers map[string]*bytes.Bu
return nil, fmt.Errorf("could not generate Go package: %w", err)
}

packageRoot, err := getPackageRoot(pkg.Reference())
packageRoot, err := goPackageRoot(pkg.Reference())
if err != nil {
return nil, fmt.Errorf("could not get package root: %w", err)
}
Expand All @@ -89,7 +89,7 @@ func GenerateGo(pg *PackageGenerator, name string) (buffers map[string]*bytes.Bu
newPath, _ := filepath.Rel(name, path)
pkgRelPath := strings.TrimPrefix(path, packageRoot+"/")

if !unneededGoFiles.Has(pkgRelPath) {
if !UnneededGoFiles.Has(pkgRelPath) {
buffers[newPath] = bytes.NewBuffer(code)
}
}
Expand All @@ -98,7 +98,7 @@ func GenerateGo(pg *PackageGenerator, name string) (buffers map[string]*bytes.Bu
}

// Similar to "packageRoot" method from pulumi/pkg/codegen/go/gen.go
func getPackageRoot(pkg schema.PackageReference) (string, error) {
func goPackageRoot(pkg schema.PackageReference) (string, error) {
def, err := pkg.Definition()
if err != nil {
return "", err
Expand Down
55 changes: 55 additions & 0 deletions tests/unneeded_go_files_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package tests

import (
"io"
"strings"
"testing"

"github.com/pulumi/crd2pulumi/pkg/codegen"
)

func TestUnneededGoFiles(t *testing.T) {
mockCRDYaml := `---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
spec:
group: uneeded-go-files-test.pulumi.com
names:
plural: testresources
singular: testresource
kind: TestResource
scope: Namespaced
versions:
- test:
name: test
schema:
openAPIV3Schema:
properties:
testProperty:
type: string`

yamlSources := []io.ReadCloser{
io.NopCloser(strings.NewReader(mockCRDYaml)),
}

// Invoke ReadPackagesFromSource
pg, err := codegen.ReadPackagesFromSource("", yamlSources)
if err != nil {
t.Fatalf("ReadPackagesFromSource failed: %v", err)
}

// Pick a generated file we want to exclude
uneededGoFile := "uneededgofilestest/test/testResource.go"
codegen.UnneededGoFiles.Add(uneededGoFile)

// Generate the code from the mocked CRD
buffers, err := codegen.GenerateGo(pg, "crds")
if err != nil {
t.Fatalf("GenerateGo failed: %v", err)
}

// Assert that buffers do not contain unneeded file
if _, exists := buffers["../kubernetes/"+uneededGoFile]; exists {
t.Errorf("Uneeded GO file was not excluded by GoGenerate, %s", uneededGoFile)
}
}