treewide: introduce osbase package and move things around
All except localregistry moved from metropolis/pkg to osbase,
localregistry moved to metropolis/test as its only used there anyway.
Change-Id: If1a4bf377364bef0ac23169e1b90379c71b06d72
Reviewed-on: https://review.monogon.dev/c/monogon/+/3079
Tested-by: Jenkins CI
Reviewed-by: Serge Bazanski <serge@monogon.tech>
diff --git a/osbase/test/ktest/BUILD.bazel b/osbase/test/ktest/BUILD.bazel
new file mode 100644
index 0000000..16612e5
--- /dev/null
+++ b/osbase/test/ktest/BUILD.bazel
@@ -0,0 +1,62 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library")
+load("//metropolis/node/build/kconfig-patcher:kconfig-patcher.bzl", "kconfig_patch")
+load("//third_party/linux:def.bzl", "linux_image")
+
+go_library(
+ name = "ktest_lib",
+ srcs = ["main.go"],
+ importpath = "source.monogon.dev/osbase/test/ktest",
+ visibility = ["//visibility:private"],
+ deps = ["//osbase/test/launch"],
+)
+
+go_binary(
+ name = "ktest",
+ embed = [":ktest_lib"],
+ pure = "on",
+ visibility = [
+ "//go/net/psample:__pkg__",
+ "//metropolis:__subpackages__",
+ "//osbase:__subpackages__",
+ ],
+)
+
+kconfig_patch(
+ name = "testing-config",
+ src = "//third_party/linux:linux-metropolis.config",
+ out = "testing.config",
+ override_configs = {
+ # Unlock command line
+ "CONFIG_CMDLINE_OVERRIDE": "n",
+ "CONFIG_CMDLINE_BOOL": "n",
+ # Shave off 1 second from boot time
+ "CONFIG_SERIO_I8042": "",
+ "CONFIG_KEYBOARD_ATKBD": "",
+ "CONFIG_RTC_DRV_CMOS": "",
+ # Shave off an additional 18ms (half of the boot time)
+ "CONFIG_DEBUG_WX": "",
+ },
+)
+
+linux_image(
+ name = "linux-testing",
+ image_format = "vmlinux",
+ kernel_config = ":testing-config",
+ # This image is directly used by the ktest macro, thus it needs a pretty
+ # wide visibility.
+ visibility = [
+ "//go/net/psample:__pkg__",
+ "//metropolis:__subpackages__",
+ "//osbase:__subpackages__",
+ ],
+)
+
+filegroup(
+ name = "test-script",
+ srcs = ["run_ktest.sh"],
+ visibility = [
+ "//go/net/psample:__pkg__",
+ "//metropolis:__subpackages__",
+ "//osbase:__subpackages__",
+ ],
+)
diff --git a/osbase/test/ktest/init/BUILD.bazel b/osbase/test/ktest/init/BUILD.bazel
new file mode 100644
index 0000000..56b262c
--- /dev/null
+++ b/osbase/test/ktest/init/BUILD.bazel
@@ -0,0 +1,18 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library")
+
+go_library(
+ name = "init_lib",
+ srcs = ["main.go"],
+ importpath = "source.monogon.dev/osbase/test/ktest/init",
+ visibility = ["//visibility:private"],
+ deps = ["@org_golang_x_sys//unix"],
+)
+
+go_binary(
+ name = "init",
+ embed = [":init_lib"],
+ pure = "on",
+ visibility = [
+ "//visibility:public",
+ ],
+)
diff --git a/osbase/test/ktest/init/main.go b/osbase/test/ktest/init/main.go
new file mode 100644
index 0000000..16ffa29
--- /dev/null
+++ b/osbase/test/ktest/init/main.go
@@ -0,0 +1,85 @@
+// Copyright 2020 The Monogon Project Authors.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+// 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.
+
+// ktestinit is an init designed to run inside a lightweight VM for running
+// tests in there. It performs basic platform initialization like mounting
+// kernel filesystems and launches the test executable at /tester, passes the
+// exit code back out over the control socket to ktest and then terminates the
+// default VM kernel.
+package main
+
+import (
+ "errors"
+ "fmt"
+ "os"
+ "os/exec"
+
+ "golang.org/x/sys/unix"
+)
+
+func mountInit() error {
+ for _, el := range []struct {
+ dir string
+ fs string
+ flags uintptr
+ }{
+ {"/sys", "sysfs", unix.MS_NOEXEC | unix.MS_NOSUID | unix.MS_NODEV},
+ {"/sys/kernel/debug", "debugfs", unix.MS_NOEXEC | unix.MS_NOSUID | unix.MS_NODEV},
+ {"/proc", "proc", unix.MS_NOEXEC | unix.MS_NOSUID | unix.MS_NODEV},
+ {"/dev", "devtmpfs", unix.MS_NOEXEC | unix.MS_NOSUID},
+ {"/dev/pts", "devpts", unix.MS_NOEXEC | unix.MS_NOSUID},
+ {"/tmp", "tmpfs", 0},
+ } {
+ if err := os.Mkdir(el.dir, 0755); err != nil && !os.IsExist(err) {
+ return fmt.Errorf("could not make %s: %w", el.dir, err)
+ }
+ if err := unix.Mount(el.fs, el.dir, el.fs, el.flags, ""); err != nil {
+ return fmt.Errorf("could not mount %s on %s: %w", el.fs, el.dir, err)
+ }
+ }
+ return nil
+}
+
+func main() {
+ if err := mountInit(); err != nil {
+ panic(err)
+ }
+
+ // First virtual serial is always stdout, second is control
+ ioConn, err := os.OpenFile("/dev/vport1p1", os.O_RDWR, 0)
+ if err != nil {
+ fmt.Printf("Failed to open communication device: %v\n", err)
+ return
+ }
+ cmd := exec.Command("/tester", "-test.v")
+ cmd.Stderr = os.Stderr
+ cmd.Stdout = os.Stdout
+ cmd.Env = append(cmd.Env, "IN_KTEST=true")
+ if err := cmd.Run(); err != nil {
+ var exerr *exec.ExitError
+ if errors.As(err, &exerr) {
+ if _, err := ioConn.Write([]byte{uint8(exerr.ExitCode())}); err != nil {
+ panic(err)
+ }
+ }
+ fmt.Printf("Failed to execute tests (tests didn't run): %v", err)
+ } else {
+ ioConn.Write([]byte{0})
+ }
+ ioConn.Close()
+
+ unix.Reboot(unix.LINUX_REBOOT_CMD_RESTART)
+}
diff --git a/osbase/test/ktest/ktest.bzl b/osbase/test/ktest/ktest.bzl
new file mode 100644
index 0000000..a9f5fdd
--- /dev/null
+++ b/osbase/test/ktest/ktest.bzl
@@ -0,0 +1,58 @@
+# Copyright 2020 The Monogon Project Authors.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# 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.
+
+"""
+Ktest provides a macro to run tests under a normal Metropolis node kernel
+"""
+
+load("//metropolis/node/build:def.bzl", "node_initramfs")
+
+def _dict_union(x, y):
+ z = {}
+ z.update(x)
+ z.update(y)
+ return z
+
+def ktest(tester, cmdline = "", files = {}, fsspecs = [], files_cc = {}):
+ node_initramfs(
+ name = "test_initramfs",
+ fsspecs = [
+ "//metropolis/node/build:earlydev.fsspec",
+ ] + fsspecs,
+ files = _dict_union({
+ "//osbase/test/ktest/init": "/init",
+ tester: "/tester",
+ }, files),
+ files_cc = files_cc,
+ testonly = True,
+ )
+
+ native.sh_test(
+ name = "ktest",
+ args = [
+ "$(location //osbase/test/ktest)",
+ "$(location :test_initramfs)",
+ "$(location //osbase/test/ktest:linux-testing)",
+ cmdline,
+ ],
+ size = "small",
+ srcs = ["//osbase/test/ktest:test-script"],
+ data = [
+ "//osbase/test/ktest",
+ ":test_initramfs",
+ "//osbase/test/ktest:linux-testing",
+ ],
+ )
diff --git a/osbase/test/ktest/main.go b/osbase/test/ktest/main.go
new file mode 100644
index 0000000..7d76bc5
--- /dev/null
+++ b/osbase/test/ktest/main.go
@@ -0,0 +1,76 @@
+// Copyright 2020 The Monogon Project Authors.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+// 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.
+
+// ktest is a test launcher for running tests inside a custom kernel and passes
+// the results back out.
+package main
+
+import (
+ "context"
+ "flag"
+ "io"
+ "log"
+ "os"
+ "time"
+
+ "source.monogon.dev/osbase/test/launch"
+)
+
+var (
+ kernelPath = flag.String("kernel-path", "", "Path of the Kernel ELF file")
+ initrdPath = flag.String("initrd-path", "", "Path of the initrd image")
+ cmdline = flag.String("cmdline", "", "Additional kernel command line options")
+)
+
+func main() {
+ flag.Parse()
+
+ hostFeedbackConn, vmFeedbackConn, err := launch.NewSocketPair()
+ if err != nil {
+ log.Fatalf("Failed to create socket pair: %v", err)
+ }
+
+ exitCodeChan := make(chan uint8, 1)
+
+ go func() {
+ defer hostFeedbackConn.Close()
+
+ returnCode := make([]byte, 1)
+ if _, err := io.ReadFull(hostFeedbackConn, returnCode); err != nil {
+ log.Fatalf("Failed to read socket: %v", err)
+ }
+ exitCodeChan <- returnCode[0]
+ }()
+
+ if err := launch.RunMicroVM(context.Background(), &launch.MicroVMOptions{
+ Name: "ktest",
+ KernelPath: *kernelPath,
+ InitramfsPath: *initrdPath,
+ Cmdline: *cmdline,
+ SerialPort: os.Stdout,
+ ExtraChardevs: []*os.File{vmFeedbackConn},
+ DisableHostNetworkInterface: true,
+ }); err != nil {
+ log.Fatalf("Failed to run ktest VM: %v", err)
+ }
+
+ select {
+ case exitCode := <-exitCodeChan:
+ os.Exit(int(exitCode))
+ case <-time.After(1 * time.Second):
+ log.Fatal("Failed to get an error code back (test runtime probably crashed)")
+ }
+}
diff --git a/osbase/test/ktest/run_ktest.sh b/osbase/test/ktest/run_ktest.sh
new file mode 100755
index 0000000..02920a1
--- /dev/null
+++ b/osbase/test/ktest/run_ktest.sh
@@ -0,0 +1,2 @@
+#!/bin/bash
+exec "$1" -initrd-path "$2" -kernel-path "$3" -cmdline "$4"
\ No newline at end of file