Skip to content
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.

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

Add project key to GetAllRepositoriesFiltered #1007

Merged
merged 8 commits into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1081,6 +1081,7 @@ You can get all repositories from Artifactory filtered according to theirs type
params := services.NewRepositoriesFilterParams()
params.RepoType = "remote"
params.PackageType = "maven"
params.ProjectKey = "project-key"
err := servicesManager.GetAllRepositoriesFiltered(params)
```

Expand Down
31 changes: 27 additions & 4 deletions artifactory/services/repositories.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ package services

import (
"encoding/json"
"fmt"
"net/http"
"net/url"

"github.com/jfrog/jfrog-client-go/auth"
"github.com/jfrog/jfrog-client-go/http/jfroghttpclient"
Expand Down Expand Up @@ -46,12 +46,11 @@ func (rs *RepositoriesService) IsExists(repoKey string) (exists bool, err error)

func (rs *RepositoriesService) GetAll() (*[]RepositoryDetails, error) {
log.Info("Getting all repositories ...")
return rs.GetWithFilter(RepositoriesFilterParams{RepoType: "", PackageType: ""})
return rs.GetWithFilter(RepositoriesFilterParams{})
}

func (rs *RepositoriesService) GetWithFilter(params RepositoriesFilterParams) (*[]RepositoryDetails, error) {
url := fmt.Sprintf("%s?type=%s&packageType=%s", apiRepositories, params.RepoType, params.PackageType)
body, err := rs.sendGet(url)
body, err := rs.sendGet(rs.createUrlWithFilter(params))
if err != nil {
return nil, err
}
Expand All @@ -60,6 +59,29 @@ func (rs *RepositoriesService) GetWithFilter(params RepositoriesFilterParams) (*
return repoDetails, errorutils.CheckError(err)
}

// This function is used to create the URL for the repositories API with the given filter params.
// The function expects to get a RepositoriesFilterParams struct that contains the desired filter params.
// The function returns the URL string.
func (rs *RepositoriesService)createUrlWithFilter(params RepositoriesFilterParams) string {
u := url.URL{
Path: apiRepositories,
}

queryParams := url.Values{}
if params.RepoType != "" {
queryParams.Add("type", params.RepoType)
}
if params.PackageType != "" {
queryParams.Add("packageType", params.PackageType)
}
if params.ProjectKey != "" {
queryParams.Add("project", params.ProjectKey)
}

u.RawQuery = queryParams.Encode()
return u.String()
}

func (rs *RepositoriesService) sendGet(api string) ([]byte, error) {
httpClientsDetails := rs.ArtDetails.CreateHttpClientDetails()
resp, body, _, err := rs.client.SendGet(rs.ArtDetails.GetUrl()+api, true, &httpClientsDetails)
Expand Down Expand Up @@ -113,6 +135,7 @@ func (rd RepositoryDetails) GetRepoType() string {
type RepositoriesFilterParams struct {
RepoType string
PackageType string
ProjectKey string
}

func NewRepositoriesFilterParams() RepositoriesFilterParams {
Expand Down
27 changes: 27 additions & 0 deletions artifactory/services/repositories_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package services

import (
"testing"

"github.com/stretchr/testify/assert"
)

func TestCreateUrlWithFilter(t *testing.T) {
rs := RepositoriesService{}
testCases := []struct {
params RepositoriesFilterParams
expected string
}{
{RepositoriesFilterParams{RepoType: "git", PackageType: "npm", ProjectKey: "123"}, "api/repositories?packageType=npm&project=123&type=git"},
{RepositoriesFilterParams{RepoType: "git", PackageType: "npm"}, "api/repositories?packageType=npm&type=git"},
{RepositoriesFilterParams{RepoType: "git"}, "api/repositories?type=git"},
{RepositoriesFilterParams{PackageType: "npm"}, "api/repositories?packageType=npm"},
{RepositoriesFilterParams{ProjectKey: "123"}, "api/repositories?project=123"},
{RepositoriesFilterParams{}, "api/repositories"},
}

for _, testCase := range testCases {
result := rs.createUrlWithFilter(testCase.params)
assert.Equal(t, testCase.expected, result, "For params %+v, expected %s, but got %s", testCase.params, testCase.expected, result)
}
}
Loading