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

Support Registry Module Search and Filter parameters #850

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
31 changes: 31 additions & 0 deletions helper_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1694,6 +1694,37 @@ func createRegistryModuleWithVersion(t *testing.T, client *Client, org *Organiza
}
}

func createRegistryModuleWithProvider(t *testing.T, client *Client, org *Organization) (*RegistryModule, func()) {
var orgCleanup func()

if org == nil {
org, orgCleanup = createOrganization(t, client)
}

ctx := context.Background()

options := RegistryModuleCreateOptions{
Name: String("name"),
Provider: String("testprovider"),
}
rm, err := client.RegistryModules.Create(ctx, org.Name, options)
if err != nil {
t.Fatal(err)
}

return rm, func() {
if err := client.RegistryModules.Delete(ctx, org.Name, rm.Name); err != nil {
t.Errorf("Error destroying registry module! WARNING: Dangling resources\n"+
"may exist! The full error is shown below.\n\n"+
"Registry Module: %s\nError: %s", rm.Name, err)
}

if orgCleanup != nil {
orgCleanup()
}
}
}

func createRunTask(t *testing.T, client *Client, org *Organization) (*RunTask, func()) {
var orgCleanup func()

Expand Down
10 changes: 10 additions & 0 deletions registry_module.go
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,16 @@ type RegistryModuleVersionStatuses struct {
// RegistryModuleListOptions represents the options for listing registry modules.
type RegistryModuleListOptions struct {
ListOptions

// Optional: A search query string. Modules are searchable by name, namespace, provider fields.
Search string `url:"q,omitempty"`

// Optional: If specified, restricts results to those with the matching field name value. Valid values are registry_name, provider, and organization_name.
RegistryName RegistryName `url:"filter[registry_name],omitempty"`

Provider string `url:"filter[provider],omitempty"`

OrganizationName string `url:"filter[organization_name],omitempty"`
}

// RegistryModuleCreateOptions is used when creating a registry module without a VCS repo
Expand Down
35 changes: 34 additions & 1 deletion registry_module_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,17 @@ func TestRegistryModulesList(t *testing.T) {
defer registryModuleTest1Cleanup()
registryModuleTest2, registryModuleTest2Cleanup := createRegistryModule(t, client, orgTest, PrivateRegistry)
defer registryModuleTest2Cleanup()
registryModuleTest3, registryModuleTest3Cleanup := createRegistryModuleWithProvider(t, client, orgTest)
defer registryModuleTest3Cleanup()

t.Run("with no list options", func(t *testing.T) {
modl, err := client.RegistryModules.List(ctx, orgTest.Name, &RegistryModuleListOptions{})
require.NoError(t, err)
assert.Contains(t, modl.Items, registryModuleTest1)
assert.Contains(t, modl.Items, registryModuleTest2)
assert.Contains(t, modl.Items, registryModuleTest3)
assert.Equal(t, 1, modl.CurrentPage)
assert.Equal(t, 2, modl.TotalCount)
assert.Equal(t, 3, modl.TotalCount)
})

t.Run("with list options", func(t *testing.T) {
Expand All @@ -62,6 +65,36 @@ func TestRegistryModulesList(t *testing.T) {
assert.NotEmpty(t, modl.Items)
assert.Equal(t, 1, modl.CurrentPage)
})

t.Run("with search query", func(t *testing.T) {
modl, err := client.RegistryModules.List(ctx, orgTest.Name, &RegistryModuleListOptions{
Search: registryModuleTest1.Name,
})
require.NoError(t, err)
assert.NotEmpty(t, modl.Items)
assert.Contains(t, modl.Items, registryModuleTest1)
assert.Equal(t, 1, modl.TotalCount)
})

t.Run("with filter[provider]", func(t *testing.T) {
modl, err := client.RegistryModules.List(ctx, orgTest.Name, &RegistryModuleListOptions{
Provider: registryModuleTest3.Provider,
})
require.NoError(t, err)
assert.NotEmpty(t, modl.Items)
assert.Contains(t, modl.Items, registryModuleTest3)
assert.Equal(t, 1, modl.TotalCount)
})

t.Run("with filter[registry_name]", func(t *testing.T) {
modl, err := client.RegistryModules.List(ctx, orgTest.Name, &RegistryModuleListOptions{
RegistryName: PrivateRegistry,
})
require.NoError(t, err)
assert.NotEmpty(t, modl.Items)
assert.Contains(t, modl.Items, registryModuleTest1)
assert.Equal(t, 3, modl.TotalCount)
})
}

func TestRegistryModulesCreate(t *testing.T) {
Expand Down
Loading