generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Windows: do not use 'uname' for doing OS validation
The idea of the OS validator is to check if the host OS is supported. e.g. 'uname' would return 'Linux' on Linux and something else on OSX, BSD. But 'uname' is a Unix tool, and only available on Windows if third party packages are installed like MSYS. - Split the os_validator*.go files for Unix and Windows. - Align the fetching of OS name and kernel version for Windows with the kubelet which uses the CurrentVersion reg key under HKLM. - In the Windows spec use 'Windows Server' as the required name and match it in 'CurrentVersion.ProductName' as a prefix. - Add OS specific unit tests.
- Loading branch information
Showing
5 changed files
with
134 additions
and
5 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
3 changes: 3 additions & 0 deletions
3
validators/os_validator_test.go → validators/os_validator_unix_test.go
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 |
---|---|---|
@@ -1,3 +1,6 @@ | ||
//go:build !windows | ||
// +build !windows | ||
|
||
/* | ||
Copyright 2016 The Kubernetes Authors. | ||
|
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,62 @@ | ||
//go:build windows | ||
// +build windows | ||
|
||
/* | ||
Copyright 2024 The Kubernetes 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 system | ||
|
||
import ( | ||
"fmt" | ||
"os/exec" | ||
"strings" | ||
) | ||
|
||
var _ Validator = &OSValidator{} | ||
|
||
// OSValidator validates OS. | ||
type OSValidator struct { | ||
Reporter Reporter | ||
} | ||
|
||
// Name is part of the system.Validator interface. | ||
func (o *OSValidator) Name() string { | ||
return "os" | ||
} | ||
|
||
// Validate is part of the system.Validator interface. | ||
func (o *OSValidator) Validate(spec SysSpec) ([]error, []error) { | ||
args := []string{`(Get-ItemProperty -Path 'HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion').ProductName`} | ||
os, err := exec.Command("powershell", args...).Output() | ||
if err != nil { | ||
return nil, []error{fmt.Errorf("failed to get OS name: %w", err)} | ||
} | ||
if err = o.validateOS(strings.TrimSpace(string(os)), spec.OS); err != nil { | ||
return nil, []error{err} | ||
} | ||
return nil, nil | ||
} | ||
|
||
// validateOS would check if the reported string such as 'Windows Server 2019' contains | ||
// the required OS prefix from the spec 'Windows Server'. | ||
func (o *OSValidator) validateOS(os, specOS string) error { | ||
if !strings.HasPrefix(os, specOS) { | ||
o.Reporter.Report("OS", os, bad) | ||
return fmt.Errorf("unsupported operating system: %s", os) | ||
} | ||
o.Reporter.Report("OS", os, good) | ||
return nil | ||
} |
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,59 @@ | ||
//go:build windows | ||
// +build windows | ||
|
||
/* | ||
Copyright 2024 The Kubernetes 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 system | ||
|
||
import ( | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
func TestValidateOS(t *testing.T) { | ||
v := &OSValidator{ | ||
Reporter: DefaultReporter, | ||
} | ||
specOS := "Windows Server" | ||
for _, test := range []struct { | ||
os string | ||
err bool | ||
}{ | ||
{ | ||
os: "Windows Server", | ||
err: false, | ||
}, | ||
{ | ||
os: "Windows 10 Enterprise", | ||
err: true, | ||
}, | ||
{ | ||
os: "Windows", | ||
err: true, | ||
}, | ||
} { | ||
t.Run(test.os, func(t *testing.T) { | ||
err := v.validateOS(test.os, specOS) | ||
if !test.err { | ||
assert.Nil(t, err, "Expect error not to occur with os %q", test.os) | ||
} else { | ||
assert.NotNil(t, err, "Expect error to occur with os %q", test.os) | ||
} | ||
}) | ||
} | ||
} |
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