test catalogd api returns jsonl format, cleanup

This adds additional unit test cases to make sure
catalogd web api returns data in valid jsonl format
both when serving via /all and /metas endpoints.
Additionally, it:
- removes unused suite_test.go and
- fixes a typo in storage/http_preconditions_check.go

Author: azych

…ernal/storage/http_precoditions_check.go …rnal/storage/http_preconditions_check.gocatalogd/internal/storage/http_precoditions_check.go renamed to catalogd/internal/storage/http_preconditions_check.go catalogd/internal/storage/http_precoditions_check.go renamed to catalogd/internal/storage/http_preconditions_check.go

@@ -1,6 +1,7 @@
 package storage
 
 import (
+	"bytes"
 	"context"
 	"errors"
 	"fmt"
@@ -15,7 +16,10 @@ import (
 	"testing"
 	"testing/fstest"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/operator-framework/operator-registry/alpha/declcfg"
 )
 
 const urlPrefix = "/catalogs/"
@@ -169,15 +173,45 @@ func TestLocalDirStoraget(t *testing.T) {
 }
 
 func TestLocalDirServerHandler(t *testing.T) {
+	testMultiLineData := `{
+		"defaultChannel": "stable-v6.x",
+		"name": "cockroachdb",
+		"schema": "olm.package"
+	  }
+	  {
+		"entries": [
+		  {
+			"name": "cockroachdb.v5.0.3"
+		  },
+		  {
+			"name": "cockroachdb.v5.0.4",
+			"replaces": "cockroachdb.v5.0.3"
+		  }
+		],
+		"name": "stable-5.x",
+		"package": "cockroachdb",
+		"schema": "olm.channel"
+	  }
+	  `
+
 	store := &LocalDirV1{RootDir: t.TempDir(), RootURL: &url.URL{Path: urlPrefix}}
 	testFS := fstest.MapFS{
 		"meta.json": &fstest.MapFile{
 			Data: []byte(`{"foo":"bar"}`),
 		},
 	}
+	testMultiLineFS := fstest.MapFS{
+		"multi-line-data.json": &fstest.MapFile{
+			Data: []byte(testMultiLineData),
+		},
+	}
 	if store.Store(context.Background(), "test-catalog", testFS) != nil {
 		t.Fatal("failed to store test catalog and start server")
 	}
+	if store.Store(context.Background(), "test-multi-line-catalog", testMultiLineFS) != nil {
+		t.Fatal("failed to store test multi-line catalog and start server")
+	}
+
 	testServer := httptest.NewServer(store.StorageServerHandler())
 	defer testServer.Close()
 
@@ -247,6 +281,12 @@ func TestLocalDirServerHandler(t *testing.T) {
 			expectedContent:    `{"foo":"bar"}`,
 			URLPath:            "/catalogs/test-catalog/api/v1/all",
 		},
+		{
+			name:               "Server returns 200 and json-lines formatted data when path '/catalogs/<catalog>/api/v1/all' is queried, when catalog exists",
+			expectedStatusCode: http.StatusOK,
+			expectedContent:    generateJSONLinesOrFail(t, []byte(testMultiLineData)),
+			URLPath:            "/catalogs/test-multi-line-catalog/api/v1/all",
+		},
 	} {
 		t.Run(tc.name, func(t *testing.T) {
 			req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s/%s", testServer.URL, tc.URLPath), nil)
@@ -256,11 +296,14 @@ func TestLocalDirServerHandler(t *testing.T) {
 			require.NoError(t, err)
 
 			require.Equal(t, tc.expectedStatusCode, resp.StatusCode)
+			if resp.StatusCode == http.StatusOK {
+				assert.Equal(t, "application/jsonl", resp.Header.Get("Content-Type"))
+			}
 
-			var actualContent []byte
-			actualContent, err = io.ReadAll(resp.Body)
+			actualContent, err := io.ReadAll(resp.Body)
 			require.NoError(t, err)
-			require.Equal(t, tc.expectedContent, strings.TrimSpace(string(actualContent)))
+
+			require.Equal(t, strings.TrimSpace(tc.expectedContent), strings.TrimSpace(string(actualContent)))
 			require.NoError(t, resp.Body.Close())
 		})
 	}
@@ -322,6 +365,12 @@ func TestQueryEndpoint(t *testing.T) {
 			expectedStatusCode: http.StatusOK,
 			expectedContent:    `{"image":"quaydock.io/namespace/bundle:0.0.3","name":"bundle.v0.0.1","package":"webhook_operator_test","properties":[{"type":"olm.bundle.object","value":{"data":"dW5pbXBvcnRhbnQK"}},{"type":"some.other","value":{"data":"arbitrary-info"}}],"relatedImages":[{"image":"testimage:latest","name":"test"}],"schema":"olm.bundle"}`,
 		},
+		{
+			name:               "valid query with multi-json, json-lines formatted response",
+			queryParams:        "?schema=olm.channel",
+			expectedStatusCode: http.StatusOK,
+			expectedContent:    `{"entries":[{"name":"bundle.v0.0.1"}],"name":"preview_test","package":"webhook_operator_test","schema":"olm.channel"}` + "\n" + `{"entries":[{"name":"multi-bundle.v0.0.1"}],"name":"review_test","package":"multi_operator_test","schema":"olm.channel"}`,
+		},
 		{
 			name:               "query with non-existent schema",
 			queryParams:        "?schema=non_existent_schema",
@@ -354,6 +403,9 @@ func TestQueryEndpoint(t *testing.T) {
 			defer resp.Body.Close()
 
 			require.Equal(t, tc.expectedStatusCode, resp.StatusCode)
+			if resp.StatusCode == http.StatusOK {
+				assert.Equal(t, "application/jsonl", resp.Header.Get("Content-Type"))
+			}
 
 			actualContent, err := io.ReadAll(resp.Body)
 			require.NoError(t, err)
@@ -540,12 +592,45 @@ entries:
 	testPackageName := "webhook_operator_test"
 	testChannelName := "preview_test"
 
+	testMultiPackageName := "multi_operator_test"
+	testMultiChannelName := "review_test"
+	testMultiBundleName := "multi-bundle.v0.0.1"
+
 	testPackage := fmt.Sprintf(testPackageTemplate, testPackageDefaultChannel, testPackageName)
 	testBundle := fmt.Sprintf(testBundleTemplate, testBundleImage, testBundleName, testPackageName, testBundleRelatedImageName, testBundleRelatedImageImage, testBundleObjectData)
 	testChannel := fmt.Sprintf(testChannelTemplate, testPackageName, testChannelName, testBundleName)
+	testMultiChannel := fmt.Sprintf(testChannelTemplate, testMultiPackageName, testMultiChannelName, testMultiBundleName)
 	return &fstest.MapFS{
-		"bundle.yaml":  {Data: []byte(testBundle), Mode: os.ModePerm},
-		"package.yaml": {Data: []byte(testPackage), Mode: os.ModePerm},
-		"channel.yaml": {Data: []byte(testChannel), Mode: os.ModePerm},
+		"bundle.yaml":        {Data: []byte(testBundle), Mode: os.ModePerm},
+		"package.yaml":       {Data: []byte(testPackage), Mode: os.ModePerm},
+		"channel.yaml":       {Data: []byte(testChannel), Mode: os.ModePerm},
+		"multi-channel.yaml": {Data: []byte(testMultiChannel), Mode: os.ModePerm},
 	}
 }
+
+// generateJSONLines takes a byte slice of concatenated JSON objects and returns a JSONlines-formatted string.
+func generateJSONLinesOrFail(t *testing.T, in []byte) string {
+	var out strings.Builder
+	reader := bytes.NewReader(in)
+
+	err := declcfg.WalkMetasReader(reader, func(meta *declcfg.Meta, err error) error {
+		if err != nil {
+			return err
+		}
+
+		if meta != nil && meta.Blob != nil {
+			if meta.Blob[len(meta.Blob)-1] != '\n' {
+				return fmt.Errorf("blob does not end with newline")
+			}
+		}
+
+		_, err = out.Write(meta.Blob)
+		if err != nil {
+			return err
+		}
+		return nil
+	})
+	require.NoError(t, err)
+
+	return out.String()
+}