defaults_windows_test.go

/*
   Copyright The containerd 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 platforms

import (
	"fmt"
	"reflect"
	"runtime"
	"sort"
	"testing"

	imagespec "github.com/opencontainers/image-spec/specs-go/v1"
	"golang.org/x/sys/windows"
)

func TestDefault(t *testing.T) {
	major, minor, build := windows.RtlGetNtVersionNumbers()
	expected := imagespec.Platform{
		OS:           runtime.GOOS,
		Architecture: runtime.GOARCH,
		OSVersion:    fmt.Sprintf("%d.%d.%d", major, minor, build),
		Variant:      cpuVariant(),
	}
	p := DefaultSpec()
	if !reflect.DeepEqual(p, expected) {
		t.Fatalf("default platform not as expected: %#v != %#v", p, expected)
	}

	s := DefaultString()
	if s != FormatAll(p) {
		t.Fatalf("default specifier should match formatted default spec: %v != %v", s, p)
	}
}

func TestDefaultMatchComparer(t *testing.T) {
	defaultMatcher := Default()

	for _, test := range []struct {
		platform imagespec.Platform
		match    bool
	}{
		{
			platform: DefaultSpec(),
			match:    true,
		},
		{
			platform: imagespec.Platform{
				OS:           "linux",
				Architecture: runtime.GOARCH,
			},
			match: false,
		},
	} {
		if actual := defaultMatcher.Match(test.platform); actual != test.match {
			t.Errorf("expected: %v, actual: %v", test.match, actual)
		}
	}

}

func TestMatchComparerMatch_WCOW(t *testing.T) {
	major, minor, build := windows.RtlGetNtVersionNumbers()
	buildStr := fmt.Sprintf("%d.%d.%d", major, minor, build)
	m := windowsmatcher{
		Platform:        DefaultSpec(),
		osVersionPrefix: buildStr,
		defaultMatcher: &matcher{
			Platform: Normalize(DefaultSpec()),
		},
	}
	for _, test := range []struct {
		platform imagespec.Platform
		match    bool
	}{
		{
			platform: DefaultSpec(),
			match:    true,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				OSVersion:    buildStr + ".1",
			},
			match: true,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				OSVersion:    buildStr + ".2",
			},
			match: true,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				// Use an nonexistent Windows build so we don't get a match. Ws2019's build is 17763/
				OSVersion: "10.0.17762.1",
			},
			match: false,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				// Use an nonexistent Windows build so we don't get a match. Ws2019's build is 17763/
				OSVersion: "10.0.17764.1",
			},
			match: false,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
			},
			match: true,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "linux",
			},
			match: false,
		},
	} {
		if actual := m.Match(test.platform); actual != test.match {
			t.Errorf("should match: %t, %s to %s", test.match, m.Platform, test.platform)
		}
	}
}

// TestMatchComparerMatch_ABICheckWCOW checks windows platform matcher
// behavior for stable ABI and non-stable ABI compliant versions
func TestMatchComparerMatch_ABICheckWCOW(t *testing.T) {
	platformNoVersion := imagespec.Platform{
		Architecture: "amd64",
		OS:           "windows",
	}
	platformWS2019 := imagespec.Platform{
		Architecture: "amd64",
		OS:           "windows",
		OSVersion:    "10.0.17763",
	}
	platformWS2022 := imagespec.Platform{
		Architecture: "amd64",
		OS:           "windows",
		OSVersion:    "10.0.20348",
	}
	platformWindows11 := imagespec.Platform{
		Architecture: "amd64",
		OS:           "windows",
		OSVersion:    "10.0.22621",
	}
	matcherNoVersion := NewMatcher(platformNoVersion).(windowsmatcher)
	matcherWS2019 := windowsmatcher{
		Platform:        platformWS2019,
		osVersionPrefix: platformWS2019.OSVersion,
		defaultMatcher: &matcher{
			Platform: Normalize(platformWS2019),
		},
	}
	matcherWS2022 := windowsmatcher{
		Platform:        platformWS2022,
		osVersionPrefix: platformWS2022.OSVersion,
		defaultMatcher: &matcher{
			Platform: Normalize(platformWS2022),
		},
	}
	matcherWindows11 := windowsmatcher{
		Platform:        platformWindows11,
		osVersionPrefix: platformWindows11.OSVersion,
		defaultMatcher: &matcher{
			Platform: Normalize(platformWindows11),
		},
	}

	for _, test := range []struct {
		hostPlatformMatcher windowsmatcher
		testPlatform        imagespec.Platform
		match               bool
	}{
		{
			hostPlatformMatcher: matcherWS2019,
			testPlatform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				OSVersion:    "10.0.17763",
			},
			match: true,
		},
		{
			hostPlatformMatcher: matcherWS2019,
			testPlatform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				OSVersion:    "10.0.20348",
			},
			match: false,
		},
		{
			hostPlatformMatcher: matcherWS2022,
			testPlatform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				OSVersion:    "10.0.17763",
			},
			match: false,
		},
		{
			hostPlatformMatcher: matcherWS2022,
			testPlatform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				OSVersion:    "10.0.20348",
			},
			match: true,
		},
		{
			hostPlatformMatcher: matcherWindows11,
			testPlatform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				OSVersion:    "10.0.17763",
			},
			match: false,
		},
		{
			hostPlatformMatcher: matcherWindows11,
			testPlatform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				OSVersion:    "10.0.20348",
			},
			match: true,
		},
		{
			hostPlatformMatcher: matcherNoVersion,
			testPlatform:        platformWS2019,
			match:               true,
		},
		{
			hostPlatformMatcher: matcherNoVersion,
			testPlatform:        platformNoVersion,
			match:               true,
		},
		{
			hostPlatformMatcher: matcherNoVersion,
			testPlatform:        platformWindows11,
			match:               true,
		},
	} {
		if actual := test.hostPlatformMatcher.Match(test.testPlatform); actual != test.match {
			t.Errorf("should match: %t, %s to %s", test.match, test.hostPlatformMatcher.Platform, test.testPlatform)
		}
	}
}

func TestMatchComparerMatch_LCOW(t *testing.T) {
	major, minor, build := windows.RtlGetNtVersionNumbers()
	buildStr := fmt.Sprintf("%d.%d.%d", major, minor, build)
	m := windowsmatcher{
		Platform: imagespec.Platform{
			OS:           "linux",
			Architecture: "amd64",
		},
		osVersionPrefix: "",
		defaultMatcher: &matcher{
			Platform: Normalize(imagespec.Platform{
				OS:           "linux",
				Architecture: "amd64",
			},
			),
		},
	}
	for _, test := range []struct {
		platform imagespec.Platform
		match    bool
	}{
		{
			platform: DefaultSpec(),
			match:    false,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
			},
			match: false,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				OSVersion:    buildStr + ".2",
			},
			match: false,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "windows",
				// Use an nonexistent Windows build so we don't get a match. Ws2019's build is 17763/
				OSVersion: "10.0.17762.1",
			},
			match: false,
		},
		{
			platform: imagespec.Platform{
				Architecture: "amd64",
				OS:           "linux",
			},
			match: true,
		},
	} {
		if actual := m.Match(test.platform); actual != test.match {
			t.Errorf("should match: %t, %s to %s", test.match, m.Platform, test.platform)
		}
	}
}

func TestMatchComparerLess(t *testing.T) {
	m := windowsmatcher{
		Platform:        DefaultSpec(),
		osVersionPrefix: "10.0.17763",
		defaultMatcher: &matcher{
			Platform: Normalize(DefaultSpec()),
		},
	}
	platforms := []imagespec.Platform{
		{
			Architecture: "amd64",
			OS:           "windows",
			OSVersion:    "10.0.17764.1",
		},
		{
			Architecture: "amd64",
			OS:           "windows",
		},
		{
			Architecture: "amd64",
			OS:           "windows",
			OSVersion:    "10.0.17763.1",
		},
		{
			Architecture: "amd64",
			OS:           "windows",
			OSVersion:    "10.0.17763.2",
		},
		{
			Architecture: "amd64",
			OS:           "windows",
			OSVersion:    "10.0.17762.1",
		},
	}
	expected := []imagespec.Platform{
		{
			Architecture: "amd64",
			OS:           "windows",
			OSVersion:    "10.0.17763.2",
		},
		{
			Architecture: "amd64",
			OS:           "windows",
			OSVersion:    "10.0.17763.1",
		},
		{
			Architecture: "amd64",
			OS:           "windows",
		},
		{
			Architecture: "amd64",
			OS:           "windows",
			OSVersion:    "10.0.17764.1",
		},
		{
			Architecture: "amd64",
			OS:           "windows",
			OSVersion:    "10.0.17762.1",
		},
	}
	sort.SliceStable(platforms, func(i, j int) bool {
		return m.Less(platforms[i], platforms[j])
	})
	if !reflect.DeepEqual(platforms, expected) {
		t.Errorf("expected: %s\nactual  : %s", expected, platforms)
	}
}