-
Notifications
You must be signed in to change notification settings - Fork 315
Fix missing .gitignore in generated extensions and surface local registry gaps in azd x build
#8550
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.
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
Open
Copilot
wants to merge
5
commits into
main
Choose a base branch
from
copilot/add-gitignore-for-go-extension
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+165
−8
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
13fca5a
Initial plan
Copilot 370b0ee
Fix gitignore embedding and add local registry warning to azd x build
Copilot 96db3b1
Apply gofmt to embed directive and verify scaffolding
Copilot 28ca73d
Correct usage doc note to reflect non-fatal warning behavior
Copilot 5b6b7d2
Address feedback
JeffreyCA File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
65 changes: 65 additions & 0 deletions
65
cli/azd/extensions/microsoft.azd.extensions/internal/cmd/build_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package cmd | ||
|
|
||
| import ( | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestLocalRegistryWarning(t *testing.T) { | ||
| const extensionId = "my.custom.extension" | ||
|
|
||
| t.Run("missing registry", func(t *testing.T) { | ||
| dir := t.TempDir() | ||
|
|
||
| warning := localRegistryWarning(dir, extensionId) | ||
|
|
||
| require.Contains(t, warning, "not found") | ||
| require.Contains(t, warning, "azd x publish") | ||
| }) | ||
|
|
||
| t.Run("extension not registered", func(t *testing.T) { | ||
| dir := t.TempDir() | ||
| registryPath := filepath.Join(dir, "registry.json") | ||
| require.NoError(t, os.WriteFile( | ||
| registryPath, | ||
| []byte(`{"extensions":[{"id":"some.other.extension"}]}`), | ||
| 0600, | ||
| )) | ||
|
|
||
| warning := localRegistryWarning(dir, extensionId) | ||
|
|
||
| require.Contains(t, warning, "isn't registered") | ||
| require.Contains(t, warning, extensionId) | ||
| }) | ||
|
|
||
| t.Run("extension registered", func(t *testing.T) { | ||
| dir := t.TempDir() | ||
| registryPath := filepath.Join(dir, "registry.json") | ||
| require.NoError(t, os.WriteFile( | ||
| registryPath, | ||
| []byte(`{"extensions":[{"id":"`+extensionId+`"}]}`), | ||
| 0600, | ||
| )) | ||
|
|
||
| warning := localRegistryWarning(dir, extensionId) | ||
|
|
||
| require.Empty(t, warning) | ||
| }) | ||
|
|
||
| t.Run("invalid registry", func(t *testing.T) { | ||
| dir := t.TempDir() | ||
| registryPath := filepath.Join(dir, "registry.json") | ||
| require.NoError(t, os.WriteFile(registryPath, []byte("not-json"), 0600)) | ||
|
|
||
| warning := localRegistryWarning(dir, extensionId) | ||
|
|
||
| require.True(t, strings.HasPrefix(warning, "Failed to read")) | ||
| }) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
cli/azd/extensions/microsoft.azd.extensions/internal/resources/resources_test.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package resources | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| // TestGitignoreEmbedded verifies that the dotfiles (.gitignore) shipped with each | ||
| // language template are embedded. Without the `all:` prefix on the go:embed | ||
| // directive these files are silently skipped, which previously meant generated | ||
| // extensions had no .gitignore (so build artifacts under bin/ could be committed). | ||
| func TestGitignoreEmbedded(t *testing.T) { | ||
| for _, language := range []string{"go", "dotnet", "javascript", "python"} { | ||
| t.Run(language, func(t *testing.T) { | ||
| contents, err := Languages.ReadFile("languages/" + language + "/.gitignore") | ||
| require.NoError(t, err) | ||
| require.NotEmpty(t, contents) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| // TestGoGitignoreExcludesBin ensures the generated Go extension ignores the build | ||
| // output directory so binaries are not accidentally committed. | ||
| func TestGoGitignoreExcludesBin(t *testing.T) { | ||
| contents, err := Languages.ReadFile("languages/go/.gitignore") | ||
| require.NoError(t, err) | ||
| require.Contains(t, string(contents), "bin/") | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 0.11.1 | ||
| 0.11.2 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.