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

Make provider class mandatory in DB #3132

Merged
merged 2 commits into from
Apr 18, 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
15 changes: 15 additions & 0 deletions database/migrations/000053_provider_class_non_nullable.down.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
-- Copyright 2024 Stacklok, Inc
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.

ALTER TABLE providers ALTER COLUMN class DROP NOT NULL
16 changes: 16 additions & 0 deletions database/migrations/000053_provider_class_non_nullable.up.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
-- Copyright 2024 Stacklok, Inc
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.

-- undo migration #35
ALTER TABLE providers ALTER COLUMN class SET NOT NULL
2 changes: 1 addition & 1 deletion database/mock/store.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/controlplane/handlers_oauth.go
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ func (s *Server) VerifyProviderTokenFrom(ctx context.Context,
}
for _, p := range prov {
// Recently-created, let's use it.
if p.Class.ProviderClass == db.ProviderClassGithubApp && p.CreatedAt.After(in.GetTimestamp().AsTime()) {
if p.Class == db.ProviderClassGithubApp && p.CreatedAt.After(in.GetTimestamp().AsTime()) {
return &pb.VerifyProviderTokenFromResponse{Status: "OK"}, nil
}
}
Expand Down
4 changes: 2 additions & 2 deletions internal/controlplane/handlers_providers.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ func (s *Server) GetProvider(ctx context.Context, req *minderv1.GetProviderReque
AuthFlows: protobufProviderAuthFlowFromDB(ctx, *prov),
Config: cfg,
CredentialsState: providers.GetCredentialStateForProvider(ctx, *prov, s.store, s.cryptoEngine, &s.cfg.Provider),
Class: providers.GetProviderClassString(*prov),
Class: string(prov.Class),
},
}, nil
}
Expand Down Expand Up @@ -129,7 +129,7 @@ func (s *Server) ListProviders(ctx context.Context, req *minderv1.ListProvidersR
AuthFlows: protobufProviderAuthFlowFromDB(ctx, p),
CredentialsState: providers.GetCredentialStateForProvider(ctx, p, s.store, s.cryptoEngine, &s.cfg.Provider),
Config: cfg,
Class: providers.GetProviderClassString(p),
Class: string(p.Class),
})
}

Expand Down
4 changes: 2 additions & 2 deletions internal/controlplane/handlers_repositories.go
Original file line number Diff line number Diff line change
Expand Up @@ -475,10 +475,10 @@ func (s *Server) inferProviderByOwner(ctx context.Context, owner string, project

slices.SortFunc(opts, func(a, b db.Provider) int {
// Sort GitHub OAuth provider after all GitHub App providers
if a.Class.ProviderClass == db.ProviderClassGithub && b.Class.ProviderClass == db.ProviderClassGithubApp {
if a.Class == db.ProviderClassGithub && b.Class == db.ProviderClassGithubApp {
return 1
}
if a.Class.ProviderClass == db.ProviderClassGithubApp && b.Class.ProviderClass == db.ProviderClassGithub {
if a.Class == db.ProviderClassGithubApp && b.Class == db.ProviderClassGithub {
return -1
}
return 0
Expand Down
2 changes: 1 addition & 1 deletion internal/db/models.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions internal/db/providers.sql.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/db/providers_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ func createRandomProvider(t *testing.T, projectID uuid.UUID) Provider {
prov, err := testQueries.CreateProvider(context.Background(), CreateProviderParams{
Name: rand.RandomName(seed),
ProjectID: projectID,
Class: NullProviderClass{ProviderClass: ProviderClassGithub, Valid: true},
Class: ProviderClassGithub,
Implements: []ProviderType{ProviderTypeGithub, ProviderTypeGit},
AuthFlows: []AuthorizationFlow{AuthorizationFlowUserInput},
Definition: json.RawMessage("{}"),
Expand Down
2 changes: 1 addition & 1 deletion internal/db/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/eea/eea_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ func createNeededEntities(ctx context.Context, t *testing.T, testQueries db.Stor
prov, err := testQueries.CreateProvider(ctx, db.CreateProviderParams{
Name: providerName,
ProjectID: proj.ID,
Class: db.NullProviderClass{ProviderClass: db.ProviderClassGithub, Valid: true},
Class: db.ProviderClassGithub,
Implements: []db.ProviderType{db.ProviderTypeRest},
AuthFlows: []db.AuthorizationFlow{db.AuthorizationFlowUserInput},
Definition: json.RawMessage(`{}`),
Expand Down
2 changes: 1 addition & 1 deletion internal/projects/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func ProvisionSelfEnrolledOAuthProject(
_, err = qtx.CreateProvider(ctx, db.CreateProviderParams{
Name: github.Github,
ProjectID: project.ID,
Class: db.NullProviderClass{ProviderClass: db.ProviderClassGithub, Valid: true},
Class: db.ProviderClassGithub,
Implements: github.Implements,
Definition: json.RawMessage(`{"github": {}}`),
AuthFlows: github.AuthorizationFlows,
Expand Down
8 changes: 0 additions & 8 deletions internal/providers/classes.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,6 @@ package providers

import "github.com/stacklok/minder/internal/db"

// GetProviderClassString returns the string representation of the provider class.
func GetProviderClassString(prov db.Provider) string {
if prov.Class.Valid {
return string(prov.Class.ProviderClass)
}
return ""
}

// ListProviderClasses returns a list of provider classes.
func ListProviderClasses() []string {
return []string{
Expand Down
2 changes: 1 addition & 1 deletion internal/providers/github/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -931,7 +931,7 @@ func CanHandleOwner(_ context.Context, prov db.Provider, owner string) bool {
if prov.Name == fmt.Sprintf("%s-%s", db.ProviderClassGithubApp, owner) {
return true
}
if prov.Class.ProviderClass == db.ProviderClassGithub {
if prov.Class == db.ProviderClassGithub {
return true
}
return false
Expand Down
4 changes: 2 additions & 2 deletions internal/providers/github/service/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ func (p *ghProviderService) CreateGitHubOAuthProvider(
createdProvider, err := qtx.CreateProvider(ctx, db.CreateProviderParams{
Name: providerName,
ProjectID: stateData.ProjectID,
Class: db.NullProviderClass{ProviderClass: providerClass, Valid: true},
Class: providerClass,
Implements: providerDef.Traits,
Definition: json.RawMessage(`{"github": {}}`),
AuthFlows: providerDef.AuthorizationFlows,
Expand Down Expand Up @@ -327,7 +327,7 @@ func createGitHubApp(
savedProvider, err := qtx.CreateProvider(ctx, db.CreateProviderParams{
Name: fmt.Sprintf("%s-%s", db.ProviderClassGithubApp, installationOwner.GetLogin()),
ProjectID: projectId,
Class: db.NullProviderClass{ProviderClass: db.ProviderClassGithubApp, Valid: true},
Class: db.ProviderClassGithubApp,
Implements: app.Implements,
Definition: json.RawMessage(`{"github-app": {}}`),
AuthFlows: app.AuthorizationFlows,
Expand Down
4 changes: 2 additions & 2 deletions internal/providers/github/service/service_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ func TestProviderService_CreateGitHubAppProvider(t *testing.T) {
require.Equal(t, dbProv.ProjectID, dbproj.ID)
require.Equal(t, dbProv.AuthFlows, app.AuthorizationFlows)
require.Equal(t, dbProv.Implements, app.Implements)
require.Equal(t, dbProv.Class, db.NullProviderClass{ProviderClass: db.ProviderClassGithubApp, Valid: true})
require.Equal(t, dbProv.Class, db.ProviderClassGithubApp)
require.Contains(t, dbProv.Name, db.ProviderClassGithubApp)
require.Contains(t, dbProv.Name, accountLogin)

Expand Down Expand Up @@ -506,7 +506,7 @@ func TestProviderService_DeleteProvider(t *testing.T) {
db.CreateProviderParams{
Name: rand.RandomName(seed),
ProjectID: dbproj.ID,
Class: db.NullProviderClass{ProviderClass: db.ProviderClassGithubApp, Valid: true},
Class: db.ProviderClassGithubApp,
Implements: []db.ProviderType{db.ProviderTypeGithub, db.ProviderTypeGit},
AuthFlows: []db.AuthorizationFlow{db.AuthorizationFlowUserInput},
Definition: json.RawMessage("{}"),
Expand Down