Skip to content

[public-api] Ensure no objects are rendered by installer without experimental config #9324

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 20, 2022
Merged

[public-api] Ensure no objects are rendered by installer without experimental config #9324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 0 additions & 17 deletions install/installer/pkg/components/public-api-server/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,8 @@
package public_api_server

import (
"github.com/gitpod-io/gitpod/common-go/log"
"github.com/gitpod-io/gitpod/installer/pkg/cluster"
"github.com/gitpod-io/gitpod/installer/pkg/common"
"github.com/gitpod-io/gitpod/installer/pkg/config/v1/experimental"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
Expand All @@ -18,21 +16,6 @@ import (
)

func deployment(ctx *common.RenderContext) ([]runtime.Object, error) {
var experimentalCfg *experimental.Config

_ = ctx.WithExperimental(func(ucfg *experimental.Config) error {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This check has been effectively hoisted higher to the Objects function (the main entry point for rendering anything for public-api). This ensures that future objects are also protected with the same config.

experimentalCfg = ucfg
return nil
})

if experimentalCfg == nil || experimentalCfg.WebApp == nil || experimentalCfg.WebApp.PublicAPI == nil {
// We don't want to render anything for this deployment
return nil, nil
}

publicAPIConfig := experimentalCfg.WebApp.PublicAPI
log.Debug("Detected experimental.WebApp.PublicApi configuration", publicAPIConfig)

labels := common.DefaultLabels(Component)
return []runtime.Object{
&appsv1.Deployment{
Expand Down
40 changes: 34 additions & 6 deletions install/installer/pkg/components/public-api-server/objects.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,38 @@

package public_api_server

import "github.com/gitpod-io/gitpod/installer/pkg/common"

var Objects = common.CompositeRenderFunc(
deployment,
rolebinding,
common.DefaultServiceAccount(Component),
import (
"github.com/gitpod-io/gitpod/common-go/log"
"github.com/gitpod-io/gitpod/installer/pkg/common"
"github.com/gitpod-io/gitpod/installer/pkg/config/v1/experimental"
"k8s.io/apimachinery/pkg/runtime"
)

func Objects(ctx *common.RenderContext) ([]runtime.Object, error) {
cfg := getExperimentalPublicAPIConfig(ctx)
if cfg == nil {
return nil, nil
}

log.Debug("Detected experimental.WebApp.PublicApi configuration", cfg)
return common.CompositeRenderFunc(
deployment,
rolebinding,
common.DefaultServiceAccount(Component),
)(ctx)
}

func getExperimentalPublicAPIConfig(ctx *common.RenderContext) *experimental.PublicAPIConfig {
var experimentalCfg *experimental.Config

_ = ctx.WithExperimental(func(ucfg *experimental.Config) error {
experimentalCfg = ucfg
return nil
})

if experimentalCfg == nil || experimentalCfg.WebApp == nil || experimentalCfg.WebApp.PublicAPI == nil {
return nil
}

return experimentalCfg.WebApp.PublicAPI
}
43 changes: 43 additions & 0 deletions install/installer/pkg/components/public-api-server/objects_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
// Licensed under the MIT License. See License-MIT.txt in the project root for license information.

package public_api_server

import (
"github.com/gitpod-io/gitpod/installer/pkg/common"
"github.com/gitpod-io/gitpod/installer/pkg/config/v1"
"github.com/gitpod-io/gitpod/installer/pkg/config/v1/experimental"
"github.com/gitpod-io/gitpod/installer/pkg/config/versions"
"github.com/stretchr/testify/require"
"testing"
)

func TestObjects_NotRenderedDefault(t *testing.T) {
ctx, err := common.NewRenderContext(config.Config{}, versions.Manifest{}, "test-namespace")
require.NoError(t, err)

objects, err := Objects(ctx)
require.NoError(t, err)
require.Empty(t, objects, "no objects should be rendered with default config")
}

func TestObjects_RenderedWhenExperimentalConfigSet(t *testing.T) {
ctx, err := common.NewRenderContext(config.Config{
Experimental: &experimental.Config{
WebApp: &experimental.WebAppConfig{
PublicAPI: &experimental.PublicAPIConfig{Enabled: true},
},
},
}, versions.Manifest{
Components: versions.Components{
PublicAPIServer: versions.Versioned{
Version: "commit-test-latest",
},
},
}, "test-namespace")
require.NoError(t, err)

objects, err := Objects(ctx)
require.NoError(t, err)
require.NotEmpty(t, objects, "must render objects because experimental config is specified")
}