feat(client): add update plugin methods

Author: christophwitzko

pkg/client/client.go

@@ -31,21 +31,38 @@ func New(registryURL string) *Client {
 	return &Client{
 		registryURL: registryURL,
 		httpClient: &http.Client{
-			Timeout: 30 * time.Second,
+			Timeout: 5 * time.Minute,
 		},
 	}
 }
 
-func (c *Client) sendRequest(ctx context.Context, method, endpoint string, body io.Reader) (*http.Response, error) {
-	url, err := url.JoinPath(c.registryURL, endpoint)
+func setAuth(adminAccessToken string) func(r *http.Request) {
+	return func(r *http.Request) {
+		r.Header.Set("Authorization", adminAccessToken)
+	}
+}
+
+func getPluginURL(pluginName string) string {
+	return fmt.Sprintf("plugins/%s", pluginName)
+}
+
+func getPluginReleaseURL(pluginName, version string) string {
+	return fmt.Sprintf("%s/versions/%s", getPluginURL(pluginName), version)
+}
+
+func (c *Client) sendRequest(ctx context.Context, method, endpoint string, body io.Reader, modifyRequestFns ...func(r *http.Request)) (*http.Response, error) {
+	apiEndpoint, err := url.JoinPath(c.registryURL, endpoint)
 	if err != nil {
 		return nil, err
 	}
-	req, err := http.NewRequestWithContext(ctx, method, url, body)
+	req, err := http.NewRequestWithContext(ctx, method, apiEndpoint, body)
 	if err != nil {
 		return nil, err
 	}
 	req.Header.Set("Accept", "application/json; charset=utf-8")
+	for _, f := range modifyRequestFns {
+		f(req)
+	}
 	return c.httpClient.Do(req)
 }
 
@@ -79,8 +96,8 @@ func (c *Client) GetPlugins(ctx context.Context) ([]string, error) {
 	return plugins, nil
 }
 
-func (c *Client) GetPlugin(ctx context.Context, plugin string) (*registry.Plugin, error) {
-	resp, err := c.sendRequest(ctx, http.MethodGet, fmt.Sprintf("plugins/%s", plugin), nil)
+func (c *Client) GetPlugin(ctx context.Context, pluginName string) (*registry.Plugin, error) {
+	resp, err := c.sendRequest(ctx, http.MethodGet, getPluginURL(pluginName), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -92,8 +109,8 @@ func (c *Client) GetPlugin(ctx context.Context, plugin string) (*registry.Plugin
 	return &p, nil
 }
 
-func (c *Client) GetPluginRelease(ctx context.Context, plugin, version string) (*registry.PluginRelease, error) {
-	resp, err := c.sendRequest(ctx, http.MethodGet, fmt.Sprintf("plugins/%s/versions/%s", plugin, version), nil)
+func (c *Client) GetPluginRelease(ctx context.Context, pluginName, version string) (*registry.PluginRelease, error) {
+	resp, err := c.sendRequest(ctx, http.MethodGet, getPluginReleaseURL(pluginName, version), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -122,3 +139,38 @@ func (c *Client) SendBatchRequest(ctx context.Context, batch *registry.BatchRequ
 	}
 	return &br, nil
 }
+
+func (c *Client) UpdatePlugins(ctx context.Context, adminAccessToken string) error {
+	return c.UpdatePluginRelease(ctx, adminAccessToken, "", "")
+}
+
+func (c *Client) UpdatePlugin(ctx context.Context, adminAccessToken, pluginName string) error {
+	return c.UpdatePluginRelease(ctx, adminAccessToken, pluginName, "")
+}
+
+func (c *Client) UpdatePluginRelease(ctx context.Context, adminAccessToken, pluginName, version string) error {
+	var apiURL string
+	switch {
+	case pluginName == "" && version == "":
+		apiURL = "plugins"
+	case pluginName == "" && version != "":
+		return fmt.Errorf("plugin name is required when version is specified")
+	case pluginName != "" && version == "":
+		apiURL = getPluginURL(pluginName)
+	case pluginName != "" && version != "":
+		apiURL = getPluginReleaseURL(pluginName, version)
+	}
+	resp, err := c.sendRequest(ctx, http.MethodPut, apiURL, nil, setAuth(adminAccessToken))
+	if err != nil {
+		return err
+	}
+	var updateResponse map[string]bool
+	err = c.decodeResponse(resp, &updateResponse)
+	if err != nil {
+		return err
+	}
+	if !updateResponse["ok"] {
+		return fmt.Errorf("update plugin %s@%s failed: reason unknown", pluginName, version)
+	}
+	return nil
+}

pkg/client/client_test.go

@@ -81,3 +81,34 @@ func TestSendBatchRequest(t *testing.T) {
 	require.Equal(t, "darwin", batchResponse.OS)
 	require.Equal(t, "amd64", batchResponse.Arch)
 }
+
+func TestUpdatePlugins(t *testing.T) {
+	reqCount := 0
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, http.MethodPut, r.Method)
+		assert.Equal(t, "admin-token", r.Header.Get("Authorization"))
+		switch reqCount {
+		case 0:
+			assert.Equal(t, "/plugins", r.URL.Path)
+		case 1:
+			assert.Equal(t, "/plugins/provider-git", r.URL.Path)
+		case 2:
+			assert.Equal(t, "/plugins/provider-git/versions/2.0.0", r.URL.Path)
+		}
+		require.NoError(t, json.NewEncoder(w).Encode(map[string]bool{"ok": true}))
+		reqCount++
+	}))
+	defer ts.Close()
+	c := New(ts.URL)
+
+	err := c.UpdatePlugins(context.Background(), "admin-token")
+	require.NoError(t, err)
+
+	err = c.UpdatePlugin(context.Background(), "admin-token", "provider-git")
+	require.NoError(t, err)
+
+	err = c.UpdatePluginRelease(context.Background(), "admin-token", "provider-git", "2.0.0")
+	require.NoError(t, err)
+
+	require.Equal(t, 3, reqCount)
+}