Skip to content

fix: improve log on provisioner daemon started with pk #15588

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

Merged
merged 19 commits into from
Nov 25, 2024
Merged

fix: improve log on provisioner daemon started with pk #15588

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
995a046
feat(provisioners) - add endpoint to fetch tags associated to a key u…
defelmnq Nov 14, 2024
2ca6c91
rename function
defelmnq Nov 14, 2024
c67d322
linter
defelmnq Nov 14, 2024
911a47d
linter
defelmnq Nov 14, 2024
1a019bb
generate doc
defelmnq Nov 14, 2024
c629f07
changes endpoint to return all pk details
defelmnq Nov 18, 2024
54437f2
generate doc
defelmnq Nov 18, 2024
8eeffb1
work on tests
defelmnq Nov 18, 2024
960084d
Merge remote-tracking branch 'origin/main' into api-endpoint-provisio…
defelmnq Nov 19, 2024
3aa81ed
work on improving tag logs for provisioner start
defelmnq Nov 19, 2024
ebcf687
merge main
defelmnq Nov 20, 2024
0cff661
Work on tags for provisioner daemon
defelmnq Nov 21, 2024
d4472a2
details golint
defelmnq Nov 21, 2024
ee0fef6
change tags variable
defelmnq Nov 25, 2024
703668b
change tags variable
defelmnq Nov 25, 2024
9e0a2d3
Merge remote-tracking branch 'origin/main' into client-provisioners-tags
defelmnq Nov 25, 2024
b5ff465
pre-allocate map
defelmnq Nov 25, 2024
7ea193f
add missing test for failing case
defelmnq Nov 25, 2024
08ab032
improve map allocation
defelmnq Nov 25, 2024
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
generate doc
  • Loading branch information
@defelmnq
defelmnq committed Nov 18, 2024
commit 54437f2e4ebc7ae139ef583e8e4c3159b22e3da4
75 changes: 34 additions & 41 deletions coderd/apidoc/docs.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

67 changes: 30 additions & 37 deletions coderd/apidoc/swagger.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion codersdk/provisionerdaemons.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ func (c *Client) GetProvisionerKey(ctx context.Context, pk string) (ProvisionerK
},
)
if err != nil {
return ProvisionerKey{}, xerrors.Errorf("make request: %w", err)
return ProvisionerKey{}, xerrors.Errorf("request to fetch provisioner key failed: %w", err)
}
defer res.Body.Close()

Expand Down
83 changes: 44 additions & 39 deletions docs/reference/api/enterprise.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion enterprise/coderd/coderd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ func New(ctx context.Context, options *Options) (_ *API, err error) {
Optional: false,
}),
)
r.Get("/{provisionerkey}", api.getProvisionerKey)
r.Get("/{provisionerkey}", api.fetchProvisionerKey)
})
r.Route("/organizations/{organization}/provisionerkeys", func(r chi.Router) {
r.Use(
Expand Down
10 changes: 5 additions & 5 deletions enterprise/coderd/provisionerkeys.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,15 +200,15 @@ func (api *API) deleteProvisionerKey(rw http.ResponseWriter, r *http.Request) {
httpapi.Write(ctx, rw, http.StatusNoContent, nil)
}

// @Summary Get provisioner key details
// @ID get-provisioner-key
// @Security CoderProvisionerDaemonKey
// @Summary Fetch provisioner key details
// @ID fetch-provisioner-key-details
// @Security CoderSessionToken
// @Produce json
// @Tags Enterprise
// @Param provisionerkey path string true "Provisioner Key"
// @Success 200 {object} codersdk.ProvisionerKey
// @Router provisionerkeys/{provisionerkey} [get]
func (*API) getProvisionerKey(rw http.ResponseWriter, r *http.Request) {
// @Router /provisionerkeys/{provisionerkey} [get]
func (*API) fetchProvisionerKey(rw http.ResponseWriter, r *http.Request) {
ctx := r.Context()

pk, ok := httpmw.ProvisionerKeyAuthOptional(r)
Expand Down
10 changes: 6 additions & 4 deletions enterprise/coderd/provisionerkeys_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@ func TestProvisionerKey(t *testing.T) {
t.Run("GetKey", func(t *testing.T) {
t.Parallel()

ctx, cancel := context.WithTimeout(context.Background(), testutil.WaitShort)
t.Cleanup(cancel)
ctx := testutil.Context(t, testutil.WaitShort)

dv := coderdtest.DeploymentValues(t)
client, owner := coderdenttest.New(t, &coderdenttest.Options{
Options: &coderdtest.Options{
Expand All @@ -153,15 +153,17 @@ func TestProvisionerKey(t *testing.T) {
},
})

// nolint:gocritic
key, err := client.CreateProvisionerKey(ctx, owner.OrganizationID, codersdk.CreateProvisionerKeyRequest{
Name: "my-test-key",
Tags: map[string]string{"key1": "value1", "key2": "value2"},
})
require.NoError(t, err)

_, err = client.GetProvisionerKey(ctx, key.Key)
fetchedKey, err := client.GetProvisionerKey(ctx, key.Key)
require.NoError(t, err)
// require.Equal(t, tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})
require.Equal(t, fetchedKey.Name, "my-test-key")
require.Equal(t, fetchedKey.Tags, codersdk.ProvisionerKeyTags{"key1": "value1", "key2": "value2"})

erroneousPK, err := client.GetProvisionerKey(ctx, "abcdefghijklmnopqrstuvwxyz01234567890123456")
require.Empty(t, erroneousPK)
Expand Down
Loading