weldr: Add API v1 support to source listing

This is the first patch in a series to add APIv1 support to the
/projects/source routes. The change involves using the store.Sources key
in a different way (as an id instead of as a duplicate of the struct's
Name field) but does not actually involve changing the Sources json in
the store.

In the V0 API the name of the source was used as the identifier, and
there was no short id. In V1 the source is identified by the API using
a short id, and the Name is just a field in the struct to describe the
source. This will become more obvious with the /projects/source/info
response.

This commit changes the following:

Changes store.ListSources to ListSourcesByName and explicitly pulls the
name from the source struct instead of the key. v0 will use this
function call.

Adds store.ListSourcesById which returns the source key as the
identifier. This is used by v1.

Adds a new weldr.SourcesListV1 response type, even though it is exactly
the same as the V1 response in this specific case. I thought it would be
better to have one called V1 than to reuse the V0 struct and possibly
confuse people.

The /projects/source/list API now lists the sources by name for v0 and id for v1.

A test has been added. You will notice it still uses v0 to push and
delete the sources. These will be updated when the new version of the
functions are added in subsequent commits.

internal/client/source.go

@@ -25,6 +25,20 @@ func ListSourcesV0(socket *http.Client) ([]string, *APIResponse, error) {
 	return list.Sources, nil, nil
 }
 
+// ListSourcesV1 returns a list of source ids
+func ListSourcesV1(socket *http.Client) ([]string, *APIResponse, error) {
+	body, resp, err := GetRaw(socket, "GET", "/api/v1/projects/source/list")
+	if resp != nil || err != nil {
+		return nil, resp, err
+	}
+	var list weldr.SourceListV1
+	err = json.Unmarshal(body, &list)
+	if err != nil {
+		return nil, nil, err
+	}
+	return list.Sources, nil, nil
+}
+
 // GetSourceInfoV0 returns detailed information on the named sources
 func GetSourceInfoV0(socket *http.Client, sourceNames string) (map[string]weldr.SourceConfigV0, *APIResponse, error) {
 	body, resp, err := GetRaw(socket, "GET", "/api/v0/projects/source/info/"+sourceNames)

internal/client/source_test.go

@@ -128,7 +128,7 @@ func TestPOSTWrongTOMLSourceV0(t *testing.T) {
 	require.False(t, resp.Status, "did not return an error")
 }
 
-// list sources
+// list sources using the v0 API
 func TestListSourcesV0(t *testing.T) {
 	sources := []string{`{
 		"name": "package-repo-1",
@@ -174,6 +174,54 @@ func TestListSourcesV0(t *testing.T) {
 	require.Contains(t, list, "package-repo-2")
 }
 
+// list sources using the v1 API
+func TestListSourcesV1(t *testing.T) {
+	sources := []string{`{
+		"name": "package-repo-1",
+		"url": "file://REPO-PATH",
+		"type": "yum-baseurl",
+		"proxy": "https://proxy-url/",
+		"check_ssl": true,
+		"check_gpg": true,
+		"gpgkey_urls": ["https://url/path/to/gpg-key"]
+	}`,
+		`{
+		"name": "package-repo-2",
+		"url": "file://REPO-PATH",
+		"type": "yum-baseurl",
+		"proxy": "https://proxy-url/",
+		"check_ssl": true,
+		"check_gpg": true,
+		"gpgkey_urls": ["https://url/path/to/gpg-key"]
+	}`}
+
+	// TODO update for PostJSONSourceV1
+	for i := range sources {
+		source := strings.Replace(sources[i], "REPO-PATH", testState.repoDir, 1)
+		resp, err := PostJSONSourceV0(testState.socket, source)
+		require.NoError(t, err, "POST source failed with a client error")
+		require.True(t, resp.Status, "POST source failed: %#v", resp)
+	}
+
+	// TODO update for DeleteJSONSourceV1
+	// Remove the test sources, ignoring any errors
+	defer func() {
+		for _, n := range []string{"package-repo-1", "package-repo-2"} {
+			resp, err := DeleteSourceV0(testState.socket, n)
+			require.NoError(t, err, "DELETE source failed with a client error")
+			require.True(t, resp.Status, "DELETE source failed: %#v", resp)
+		}
+	}()
+
+	// Get the list of sources
+	list, api, err := ListSourcesV1(testState.socket)
+	require.NoError(t, err, "GET source failed with a client error")
+	require.Nil(t, api, "ListSources failed: %#v", api)
+	require.True(t, len(list) > 1, "Not enough sources returned")
+	require.Contains(t, list, "package-repo-1")
+	require.Contains(t, list, "package-repo-2")
+}
+
 // Get the source info
 func TestGetSourceInfoV0(t *testing.T) {
 	source := `

internal/store/store.go

@@ -423,7 +423,23 @@ func (s *Store) DeleteSource(name string) {
 	})
 }
 
-func (s *Store) ListSources() []string {
+// ListSourcesByName returns the repo source names
+// Name is different than Id, it can be a full description of the repo
+func (s *Store) ListSourcesByName() []string {
+	s.mu.RLock()
+	defer s.mu.RUnlock()
+	names := make([]string, 0, len(s.sources))
+	for _, source := range s.sources {
+		names = append(names, source.Name)
+	}
+	sort.Strings(names)
+
+	return names
+}
+
+// ListSourcesById returns the repo source id
+// Id is a short identifier for the repo, not a full name description
+func (s *Store) ListSourcesById() []string {
 	s.mu.RLock()
 	defer s.mu.RUnlock()
 	names := make([]string, 0, len(s.sources))

internal/weldr/api.go

@@ -348,7 +348,14 @@ func (api *API) sourceListHandler(writer http.ResponseWriter, request *http.Requ
 		Sources []string `json:"sources"`
 	}
 
-	names := api.store.ListSources()
+	// The v0 API used the repo Name, a descriptive string, as the key
+	// In the v1 API this was changed to separate the Name and the Id (a short identifier)
+	var names []string
+	if isRequestVersionAtLeast(params, 1) {
+		names = api.store.ListSourcesById()
+	} else {
+		names = api.store.ListSourcesByName()
+	}
 
 	for _, repo := range api.repos {
 		names = append(names, repo.Name)

internal/weldr/json.go

@@ -85,6 +85,11 @@ type SourceListV0 struct {
 	Sources []string `json:"sources"`
 }
 
+// SourceListV1 is the response to /source/list request
+type SourceListV1 struct {
+	Sources []string `json:"sources"`
+}
+
 // SourceInfoV0 is the response to a /source/info request
 type SourceInfoV0 struct {
 	Sources map[string]SourceConfigV0 `json:"sources"`