Skip to content

Commit

Permalink
Merge pull request #130324 from spilchen/backport24.1-130161
Browse files Browse the repository at this point in the history
release-24.1: licenseccl: rename usage to environment
  • Loading branch information
spilchen authored Sep 9, 2024
2 parents f26f4ec + 501a4e9 commit 63e816e
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions pkg/ccl/utilccl/license_check.go
Original file line number Diff line number Diff line change
Expand Up @@ -262,15 +262,15 @@ func GetLicenseType(st *cluster.Settings) (string, error) {
return license.Type.String(), nil
}

// GetLicenseUsage returns the license usage.
func GetLicenseUsage(st *cluster.Settings) (string, error) {
// GetLicenseEnvironment returns the license environment.
func GetLicenseEnvironment(st *cluster.Settings) (string, error) {
license, err := getLicense(st)
if err != nil {
return "", err
} else if license == nil {
return "", nil
}
return license.Usage.String(), nil
return license.Environment.String(), nil
}

// decode attempts to read a base64 encoded License.
Expand Down
26 changes: 13 additions & 13 deletions pkg/ccl/utilccl/license_check_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ func TestSettingAndCheckingLicense(t *testing.T) {
func TestGetLicenseTypePresent(t *testing.T) {
ctx := context.Background()
for _, tc := range []struct {
typ licenseccl.License_Type
expectedType string
usage licenseccl.License_Usage
expectedUsage string
typ licenseccl.License_Type
expectedType string
environment licenseccl.License_Environment
expectedEnvironment string
}{
{licenseccl.License_NonCommercial, "NonCommercial", licenseccl.PreProduction, "pre-production"},
{licenseccl.License_Enterprise, "Enterprise", licenseccl.Production, "production"},
Expand All @@ -82,7 +82,7 @@ func TestGetLicenseTypePresent(t *testing.T) {
lic, _ := (&licenseccl.License{
Type: tc.typ,
ValidUntilUnixSec: 0,
Usage: tc.usage,
Environment: tc.environment,
}).Encode()
if err := setLicense(ctx, updater, lic); err != nil {
t.Fatal(err)
Expand All @@ -94,19 +94,19 @@ func TestGetLicenseTypePresent(t *testing.T) {
if actualType != tc.expectedType {
t.Fatalf("expected license type %s, got %s", tc.expectedType, actualType)
}
actualUsage, err := GetLicenseUsage(st)
actualEnvironment, err := GetLicenseEnvironment(st)
if err != nil {
t.Fatal(err)
}
if actualUsage != tc.expectedUsage {
t.Fatalf("expected license usage %s, got %s", tc.expectedUsage, actualUsage)
if actualEnvironment != tc.expectedEnvironment {
t.Fatalf("expected license environment %s, got %s", tc.expectedEnvironment, actualEnvironment)
}
}
}

func TestUnknownUsageEnum(t *testing.T) {
// This literal was generated with an enum value of 100 for usage, to show
// what happens if we add more usages later and then try to apply one to an
func TestUnknownEnvironmentEnum(t *testing.T) {
// This literal was generated with an enum value of 100 for environment, to show
// what happens if we add more environments later and then try to apply one to an
// older node which does not include it.
l, err := decode(`crl-0-GAIoZA`)
if err != nil {
Expand All @@ -115,8 +115,8 @@ func TestUnknownUsageEnum(t *testing.T) {
if expected, got := "Evaluation", l.Type.String(); got != expected {
t.Fatalf("expected license type %s, got %s", expected, got)
}
if expected, got := "other", l.Usage.String(); got != expected {
t.Fatalf("expected license usage %q, got %q", expected, got)
if expected, got := "other", l.Environment.String(); got != expected {
t.Fatalf("expected license environment %q, got %q", expected, got)
}
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/ccl/utilccl/licenseccl/license.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ func Decode(s string) (*License, error) {
return &lic, nil
}

func (u License_Usage) String() string {
func (u License_Environment) String() string {
switch u {
case Unspecified:
return ""
Expand Down
6 changes: 3 additions & 3 deletions pkg/ccl/utilccl/licenseccl/license.proto
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ message License {
int64 valid_until_unix_sec = 2;

enum Type {
NonCommercial = 0;
NonCommercial = 0 [deprecated = true];
Enterprise = 1;
Evaluation = 2;
Free = 3;
Expand All @@ -28,7 +28,7 @@ message License {

string organization_name = 4;

enum Usage {
enum Environment {
option (gogoproto.goproto_enum_prefix) = false;
option (gogoproto.goproto_enum_stringer) = false;

Expand All @@ -38,7 +38,7 @@ message License {
Development = 3;
}

Usage usage = 5;
Environment environment = 5;

// Two UUIDs uniquely identify this license and the associated organization.
// They are stored as bytes to align with the server's typical usage. We
Expand Down

0 comments on commit 63e816e

Please sign in to comment.