Implement HEAD handler for v2/pkgs/tools/installed (required by frontend) (#844)

* add tests

* implement HEAD method (is used by the frontend).
Without this the server returns 405 when called with HEAD to `v2/pkgs/tools/installed`
This breaks the install of the tools

Author: umbynos

design/pkgs.go

@@ -28,6 +28,13 @@ var _ = Service("tools", func() {
 		})
 	})
 
+	Method("installedhead", func() {
+		HTTP(func() {
+			HEAD("/pkgs/tools/installed")
+			Response(StatusOK)
+		})
+	})
+
 	Method("installed", func() {
 		Result(CollectionOf(Tool))
 		HTTP(func() {

gen/http/cli/arduino_create_agent/cli.go

@@ -61,6 +61,16 @@ paths:
                         $ref: '#/definitions/ToolsInstallResponseBody'
             schemes:
                 - http
+        head:
+            tags:
+                - tools
+            summary: installedhead tools
+            operationId: tools#installedhead
+            responses:
+                "200":
+                    description: OK response.
+            schemes:
+                - http
     /pkgs/tools/installed/{packager}/{name}/{version}:
         delete:
             tags:

gen/http/openapi.json

@@ -53,6 +53,14 @@ paths:
                                 - name: bossac
                                   packager: arduino
                                   version: 1.7.0-arduino3
+        head:
+            tags:
+                - tools
+            summary: installedhead tools
+            operationId: tools#installedhead
+            responses:
+                "200":
+                    description: OK response.
         post:
             tags:
                 - tools

gen/http/openapi.yaml

@@ -168,3 +168,19 @@ func TestInstallToolV2(t *testing.T) {
 		})
 	}
 }
+
+func TestInstalledHead(t *testing.T) {
+	indexURL := "https://downloads.arduino.cc/packages/package_staging_index.json"
+	// Instantiate Index
+	Index := index.Init(indexURL, config.GetDataDir())
+
+	r := gin.New()
+	goa := v2.Server(config.GetDataDir().String(), Index)
+	r.Any("/v2/*path", gin.WrapH(goa))
+	ts := httptest.NewServer(r)
+
+	resp, err := http.Head(ts.URL + "/v2/pkgs/tools/installed")
+	require.NoError(t, err)
+	require.NotEqual(t, resp.StatusCode, http.StatusMethodNotAllowed)
+	require.Equal(t, resp.StatusCode, http.StatusOK)
+}

gen/http/openapi3.json

@@ -64,6 +64,14 @@ func New(index *index.Resource, folder string) *Tools {
 	}
 }
 
+// Installedhead is here only because it was required by the front-end.
+// Probably when we bumped GOA something changed:
+// Before that the frontend was able to perform the HEAD request to `v2/pkgs/tools/installed`.
+// After the bump we have to implement it explicitly. Currently I do not know a better way in achieving the same result.
+func (t *Tools) Installedhead(ctx context.Context) (err error) {
+	return nil
+}
+
 // Available crawles the downloaded package index files and returns a list of tools that can be installed.
 func (t *Tools) Available(ctx context.Context) (res tools.ToolCollection, err error) {
 	body, err := t.index.Read()

gen/http/openapi3.yaml

@@ -185,6 +185,22 @@ func TestEvilFilename(t *testing.T) {
 	}
 }
 
+func TestInstalledHead(t *testing.T) {
+	// Initialize indexes with a temp folder
+	tmp := t.TempDir()
+
+	indexURL := "https://downloads.arduino.cc/packages/package_staging_index.json"
+	// Instantiate Index
+	Index := index.Init(indexURL, config.GetDataDir())
+
+	service := pkgs.New(Index, tmp)
+
+	ctx := context.Background()
+
+	err := service.Installedhead(ctx)
+	require.NoError(t, err)
+}
+
 func strpoint(s string) *string {
 	return &s
 }