-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for BMS machines to the resource detection library (#828)
* Add support for Bare Metal Solution (BMS) machines * Update copyright year to 2024 * Update copyright year for bms_test.go * Update copyright year attempt #2 * Expand BMS abbreviation to Bare Metal Solution
- Loading branch information
1 parent
ae82ed3
commit 2160268
Showing
4 changed files
with
151 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
// Copyright 2024 Google LLC | ||
// | ||
// 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 | ||
// | ||
// https://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 gcp | ||
|
||
const ( | ||
bmsProjectIDEnv = "BMS_PROJECT_ID" | ||
bmsRegionEnv = "BMS_REGION" | ||
bmsInstanceIDEnv = "BMS_INSTANCE_ID" | ||
) | ||
|
||
// onBareMetalSolution checks if the code is running on a Google Cloud Bare Metal Solution (BMS) by verifying | ||
// the presence and non-empty values of BMS_PROJECT_ID, BMS_REGION, and BMS_INSTANCE_ID environment variables. | ||
// For more information on Google Cloud Bare Metal Solution, see: https://cloud.google.com/bare-metal/docs | ||
func (d *Detector) onBareMetalSolution() bool { | ||
projectID, projectIDExists := d.os.LookupEnv(bmsProjectIDEnv) | ||
region, regionExists := d.os.LookupEnv(bmsRegionEnv) | ||
instanceID, instanceIDExists := d.os.LookupEnv(bmsInstanceIDEnv) | ||
return projectIDExists && regionExists && instanceIDExists && projectID != "" && region != "" && instanceID != "" | ||
} | ||
|
||
// BareMetalSolutionInstanceID returns the instance ID from the BMS_INSTANCE_ID environment variable. | ||
func (d *Detector) BareMetalSolutionInstanceID() (string, error) { | ||
if instanceID, found := d.os.LookupEnv(bmsInstanceIDEnv); found { | ||
return instanceID, nil | ||
} | ||
return "", errEnvVarNotFound | ||
} | ||
|
||
// BareMetalSolutionCloudRegion returns the region from the BMS_REGION environment variable. | ||
func (d *Detector) BareMetalSolutionCloudRegion() (string, error) { | ||
if region, found := d.os.LookupEnv(bmsRegionEnv); found { | ||
return region, nil | ||
} | ||
return "", errEnvVarNotFound | ||
} | ||
|
||
// BareMetalSolutionProjectID returns the project ID from the BMS_PROJECT_ID environment variable. | ||
func (d *Detector) BareMetalSolutionProjectID() (string, error) { | ||
if project, found := d.os.LookupEnv(bmsProjectIDEnv); found { | ||
return project, nil | ||
} | ||
return "", errEnvVarNotFound | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
// Copyright 2024 Google LLC | ||
// | ||
// 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 | ||
// | ||
// https://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 gcp | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
func TestBareMetalSolutionInstanceID(t *testing.T) { | ||
d := NewTestDetector(&FakeMetadataProvider{}, &FakeOSProvider{ | ||
Vars: map[string]string{ | ||
bmsInstanceIDEnv: "my-host-123", | ||
}, | ||
}) | ||
instanceID, err := d.BareMetalSolutionInstanceID() | ||
assert.NoError(t, err) | ||
assert.Equal(t, instanceID, "my-host-123") | ||
} | ||
|
||
func TestBareMetalSolutionInstanceIDErr(t *testing.T) { | ||
d := NewTestDetector(&FakeMetadataProvider{}, &FakeOSProvider{ | ||
Vars: map[string]string{}, | ||
}) | ||
instanceID, err := d.BareMetalSolutionInstanceID() | ||
assert.Error(t, err) | ||
assert.Equal(t, instanceID, "") | ||
} | ||
|
||
func TestBareMetalSolutionCloudRegion(t *testing.T) { | ||
d := NewTestDetector(&FakeMetadataProvider{}, &FakeOSProvider{ | ||
Vars: map[string]string{ | ||
bmsRegionEnv: "us-central1", | ||
}, | ||
}) | ||
region, err := d.BareMetalSolutionCloudRegion() | ||
assert.NoError(t, err) | ||
assert.Equal(t, region, "us-central1") | ||
} | ||
|
||
func TestBareMetalSolutionCloudRegionErr(t *testing.T) { | ||
d := NewTestDetector(&FakeMetadataProvider{}, &FakeOSProvider{ | ||
Vars: map[string]string{}, | ||
}) | ||
region, err := d.BareMetalSolutionCloudRegion() | ||
assert.Error(t, err) | ||
assert.Equal(t, region, "") | ||
} | ||
|
||
func TestBareMetalSolutionProjectID(t *testing.T) { | ||
d := NewTestDetector(&FakeMetadataProvider{}, &FakeOSProvider{ | ||
Vars: map[string]string{ | ||
bmsProjectIDEnv: "my-test-project", | ||
}, | ||
}) | ||
projectID, err := d.BareMetalSolutionProjectID() | ||
assert.NoError(t, err) | ||
assert.Equal(t, projectID, "my-test-project") | ||
} | ||
|
||
func TestBareMetalSolutionProjectIDErr(t *testing.T) { | ||
d := NewTestDetector(&FakeMetadataProvider{}, &FakeOSProvider{ | ||
Vars: map[string]string{}, | ||
}) | ||
projectID, err := d.BareMetalSolutionProjectID() | ||
assert.Error(t, err) | ||
assert.Equal(t, projectID, "") | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters