Adding build constraints

Adding windows build constraints to code to allow tests and benchmarks
to be run on Linux.

Added doc.go to modules (with doc string, where appropriate) to prevent
compiler/linter errors about broken imports.
In some cases (ie, winapi and wclayer), the package already had an
OS-agnostic file of the same name, along with a doc string. A doc.go
file was added to preempt situations where windows-specific code is
added to that file in the future.

Signed-off-by: Hamza El-Saawy <hamzaelsaawy@microsoft.com>

.gitignore

@@ -34,4 +34,6 @@ rootfs-conv/*
 /build/
 
 deps/*
-out/*
+out/*
+
+go.work

Makefile

@@ -32,7 +32,7 @@ clean:
 	rm -rf bin deps rootfs out
 
 test:
-	cd $(SRCROOT) && go test -v ./internal/guest/...
+	cd $(SRCROOT) && $(GO) test -v ./internal/guest/...
 
 rootfs: out/rootfs.vhd
 

cmd/containerd-shim-runhcs-v1/clone.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/delete.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/events.go

@@ -15,17 +15,19 @@ type publisher interface {
 }
 
 type eventPublisher struct {
+	namespace       string
 	remotePublisher *shim.RemoteEventsPublisher
 }
 
-var _ = (publisher)(&eventPublisher{})
+var _ publisher = &eventPublisher{}
 
-func newEventPublisher(address string) (*eventPublisher, error) {
+func newEventPublisher(address, namespace string) (*eventPublisher, error) {
 	p, err := shim.NewPublisher(address)
 	if err != nil {
 		return nil, err
 	}
 	return &eventPublisher{
+		namespace:       namespace,
 		remotePublisher: p,
 	}, nil
 }
@@ -46,5 +48,5 @@ func (e *eventPublisher) publishEvent(ctx context.Context, topic string, event i
 		return nil
 	}
 
-	return e.remotePublisher.Publish(namespaces.WithNamespace(ctx, namespaceFlag), topic, event)
+	return e.remotePublisher.Publish(namespaces.WithNamespace(ctx, e.namespace), topic, event)
 }

cmd/containerd-shim-runhcs-v1/events_test.go

@@ -6,7 +6,7 @@ type fakePublisher struct {
 	events []interface{}
 }
 
-var _ = (publisher)(&fakePublisher{})
+var _ publisher = &fakePublisher{}
 
 func newFakePublisher() *fakePublisher {
 	return &fakePublisher{}

cmd/containerd-shim-runhcs-v1/exec.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/exec_clone.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/exec_hcs.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/exec_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/exec_wcow_podsandbox.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/exec_wcow_podsandbox_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/main.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/pod.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/pod_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/serve.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (
@@ -175,7 +177,7 @@ var serveCommand = cli.Command{
 		}
 
 		ttrpcAddress := os.Getenv(ttrpcAddressEnv)
-		ttrpcEventPublisher, err := newEventPublisher(ttrpcAddress)
+		ttrpcEventPublisher, err := newEventPublisher(ttrpcAddress, namespaceFlag)
 		if err != nil {
 			return err
 		}

cmd/containerd-shim-runhcs-v1/service.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/service_internal.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/service_internal_podshim_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/service_internal_taskshim_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (
@@ -609,7 +611,7 @@ func Test_TaskShim_waitInternal_InitTaskID_2ndExecID_Success(t *testing.T) {
 	}
 }
 
-func Test_TaskShim_statsInternal_InitTaskID_Sucess(t *testing.T) {
+func Test_TaskShim_statsInternal_InitTaskID_Success(t *testing.T) {
 	testNames := []string{"WCOW", "LCOW"}
 	for i, isWCOW := range []bool{true, false} {
 		t.Run(testNames[i], func(t *testing.T) {

cmd/containerd-shim-runhcs-v1/service_internal_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/start.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/task.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/task_hcs.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/task_hcs_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/task_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/containerd-shim-runhcs-v1/task_wcow_podsandbox.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/device-util/main.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/jobobject-util/main.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/computeagent_cache.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (
@@ -38,7 +40,6 @@ func (c *computeAgentCache) getAllAndClear() ([]*computeAgentClient, error) {
 		results = append(results, agent)
 	}
 	return results, nil
-
 }
 
 func (c *computeAgentCache) get(cid string) (*computeAgentClient, error) {

cmd/ncproxy/config.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/hcn.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/hcn_networking_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/main.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/ncproxy.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (
@@ -153,7 +155,6 @@ func (s *grpcService) AddNIC(ctx context.Context, req *ncproxygrpc.AddNICRequest
 		return nil, err
 	}
 	return &ncproxygrpc.AddNICResponse{}, nil
-
 }
 
 func (s *grpcService) ModifyNIC(ctx context.Context, req *ncproxygrpc.ModifyNICRequest) (_ *ncproxygrpc.ModifyNICResponse, err error) {

cmd/ncproxy/ncproxy_networking_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/run.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/server.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/server_test.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/service.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/ncproxy/utilities_test.go

@@ -32,7 +32,6 @@ func networkExists(targetName string, networks []*ncproxygrpc.GetNetworkResponse
 				return true
 			}
 		}
-
 	}
 	return false
 }
@@ -50,7 +49,6 @@ func endpointExists(targetName string, endpoints []*ncproxygrpc.GetEndpointRespo
 				return true
 			}
 		}
-
 	}
 	return false
 }

cmd/runhcs/container.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (
@@ -36,7 +38,7 @@ type persistedState struct {
 	ID string `json:",omitempty"`
 	// Owner is the owner value passed into the runhcs command and may be `""`.
 	Owner string `json:",omitempty"`
-	// SandboxID is the sandbox identifer passed in via OCI specifications. This
+	// SandboxID is the sandbox identifier passed in via OCI specifications. This
 	// can either be the sandbox itself or the sandbox this container should run
 	// in. See `parseSandboxAnnotations`.
 	SandboxID string `json:",omitempty"`
@@ -203,8 +205,8 @@ func launchShim(cmd, pidFile, logFile string, args []string, data interface{}) (
 // different runtimes to represent a sandbox ID, and sandbox type.
 //
 // If found returns the tuple `(sandboxID, isSandbox)` where `isSandbox == true`
-// indicates the identifer is the sandbox itself; `isSandbox == false` indicates
-// the identifer is the sandbox in which to place this container. Otherwise
+// indicates the identifier is the sandbox itself; `isSandbox == false` indicates
+// the identifier is the sandbox in which to place this container. Otherwise
 // returns `("", false)`.
 func parseSandboxAnnotations(a map[string]string) (string, bool) {
 	var t, id string

cmd/runhcs/create-scratch.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/runhcs/create.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/runhcs/delete.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/runhcs/exec.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/runhcs/kill.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/runhcs/list.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/runhcs/main.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (

cmd/runhcs/pause.go

@@ -1,3 +1,5 @@
+//go:build windows
+
 package main
 
 import (