blob: 03e3e924feafc7f92e0d331629306a8c00abc286 [file] [log] [blame]
// Copyright 2020 The LUCI Authors.
//
// 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.
package config
import (
"context"
"fmt"
"google.golang.org/protobuf/encoding/prototext"
"go.chromium.org/luci/config"
"go.chromium.org/luci/config/cfgclient"
cfgmemory "go.chromium.org/luci/config/impl/memory"
"go.chromium.org/luci/gae/service/datastore"
pb "go.chromium.org/luci/cv/api/config/v2"
)
// TestController eases controlling of project configs in unittests.
//
// In integration tests, prefer setting configs via cfgclient/cfgmemory and
// calling SubmitRefreshTasks and executing all outstanding tasks via tq.
type TestController struct {
// No members. This struct serves as a namespace to discourage accidental use
// in production.
}
// Create creates project config for the first time.
//
// Panics if project config already exists.
func (t TestController) Create(ctx context.Context, project string, cfg *pb.Config) {
t.MustNotExist(ctx, project)
ctx = cfgclient.Use(ctx, cfgmemory.New(map[config.Set]cfgmemory.Files{
config.ProjectSet(project): {ConfigFileName: prototext.Format(cfg)},
}))
err := UpdateProject(ctx, project, func(context.Context) error { return nil })
if err != nil {
panic(err)
}
}
// Update updates project config to, presumed, newer version.
//
// Panics if project config doesn't exist.
func (t TestController) Update(ctx context.Context, project string, cfg *pb.Config) {
t.MustExist(ctx, project)
ctx = cfgclient.Use(ctx, cfgmemory.New(map[config.Set]cfgmemory.Files{
config.ProjectSet(project): {ConfigFileName: prototext.Format(cfg)},
}))
err := UpdateProject(ctx, project, func(context.Context) error { return nil })
if err != nil {
panic(err)
}
}
// Disable disables project.
//
// Panics if project config doesn't exist.
func (t TestController) Disable(ctx context.Context, project string) {
t.MustExist(ctx, project)
err := DisableProject(ctx, project, func(context.Context) error { return nil })
if err != nil {
panic(err)
}
}
// Enable enables project.
//
// Panics if project config doesn't exist.
func (t TestController) Enable(ctx context.Context, project string) {
m := t.MustExist(ctx, project)
if _, err := m.GetConfigGroups(ctx); err != nil {
panic(err)
}
p := ProjectConfig{Project: project}
if err := datastore.Get(ctx, &p); err != nil {
panic(err)
}
p.Enabled = true
p.EVersion++
if err := datastore.Put(ctx, &p); err != nil {
panic(err)
}
}
// Delete deletes the project config.
//
// Panics if project config doesn't exist.
func (t TestController) Delete(ctx context.Context, project string) {
m := t.MustExist(ctx, project)
cfgs, err := m.GetConfigGroups(ctx)
if err != nil {
panic(err)
}
if err := datastore.Delete(ctx, &ProjectConfig{Project: project}, cfgs); err != nil {
panic(err)
}
}
func (_ TestController) MustExist(ctx context.Context, project string) Meta {
switch m, err := GetLatestMeta(ctx, project); {
case err != nil:
panic(err)
case !m.Exists():
panic(fmt.Errorf("project %q doesn't exist", project))
default:
return m
}
}
func (_ TestController) MustNotExist(ctx context.Context, project string) {
switch m, err := GetLatestMeta(ctx, project); {
case err != nil:
panic(err)
case m.Exists():
panic(fmt.Errorf("project %q already exists", project))
}
}