Add support for using goss to target Windows #39

jsturtevant · 2020-12-17T21:56:49Z

This provisioner is used to provide goss testing in the image-builder project. I recently added Windows support to image-builder and would like to run the goss test against it during provision in the same manner as the other images. Goss also now has alpha support for Windows.

I've updated the code here to support Windows and added a few tests.

Here is the output of it running against a windows VM. It is using a custom goss url while I wait for the fix in goss goss-org/goss#666

==> vhd-windows-2019: Provisioning with Goss
==> vhd-windows-2019: Configured to run on Windows
    vhd-windows-2019: Creating directory: /tmp/goss
    vhd-windows-2019:
    vhd-windows-2019:
    vhd-windows-2019:     Directory: C:\tmp
    vhd-windows-2019:
    vhd-windows-2019:
    vhd-windows-2019: Mode                LastWriteTime         Length Name
    vhd-windows-2019: ----                -------------         ------ ----
    vhd-windows-2019: d-----       12/17/2020   6:37 PM                goss
    vhd-windows-2019:
    vhd-windows-2019:
    vhd-windows-2019: Installing Goss from, https://k8swin.blob.core.windows.net/k8s-windows/goss/goss-alpha-windows-amd64.exe
    vhd-windows-2019: Downloading Goss to /tmp/goss-windows-amd64.exe
==> vhd-windows-2019:   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
==> vhd-windows-2019:                                  Dload  Upload   Total   Spent    Left  Speed
==> vhd-windows-2019: 100 11.5M  100 11.5M    0     0  11.5M      0  0:00:01 --:--:--  0:00:01 26.4M
==> vhd-windows-2019: 'chmod' is not recognized as an internal or external command,
==> vhd-windows-2019: operable program or batch file.
==> vhd-windows-2019: Uploading goss tests...
    vhd-windows-2019: Uploading vars file packer/goss/goss-vars.yaml
    vhd-windows-2019: Inline variables are --vars-inline {"ARCH":"amd64","OS":"windows","PROVIDER":"azure","containerd_version":"1.4.3","kubernetes_cni_source_type":"","kubernetes_cni_version":"","kubernetes_source_type":"pkg","kubernetes_version":"v1.17.11"}
    vhd-windows-2019: Env variables are set "GOSS_USE_ALPHA=1" &&
    vhd-windows-2019: Uploading Dir packer/goss
    vhd-windows-2019: Creating directory: /tmp/goss/goss
    vhd-windows-2019:
    vhd-windows-2019:
    vhd-windows-2019:     Directory: C:\tmp\goss
    vhd-windows-2019:
    vhd-windows-2019:
    vhd-windows-2019: Mode                LastWriteTime         Length Name
    vhd-windows-2019: ----                -------------         ------ ----
    vhd-windows-2019: d-----       12/17/2020   6:37 PM                goss
    vhd-windows-2019:
    vhd-windows-2019:
==> vhd-windows-2019: 
==> vhd-windows-2019: 
==> vhd-windows-2019: 
==> vhd-windows-2019: Running goss tests...
==> vhd-windows-2019: Running GOSS render command: cd /tmp/goss && set "GOSS_USE_ALPHA=1" &&  /tmp/goss-windows-amd64.exe --gossfile goss/goss.yaml --vars /tmp/goss/goss-vars.yaml --vars-inline {"ARCH":"amd64","OS":"windows","PROVIDER":"azure","containerd_version":"1.4.3","kubernetes_cni_source_type":"","kubernetes_cni_version":"","kubernetes_source_type":"pkg","kubernetes_version":"v1.17.11"} render > /tmp/goss-spec.yaml
==> vhd-windows-2019: Goss render ran successfully
==> vhd-windows-2019: Running GOSS render debug command: cd /tmp/goss && set "GOSS_USE_ALPHA=1" &&  /tmp/goss-windows-amd64.exe --gossfile goss/goss.yaml --vars /tmp/goss/goss-vars.yaml --vars-inline {"ARCH":"amd64","OS":"windows","PROVIDER":"azure","containerd_version":"1.4.3","kubernetes_cni_source_type":"","kubernetes_cni_version":"","kubernetes_source_type":"pkg","kubernetes_version":"v1.17.11"} render -d > /tmp/debug-goss-spec.yaml
==> vhd-windows-2019: Goss render debug ran successfully
==> vhd-windows-2019: Running GOSS validate command: cd /tmp/goss &&  set "GOSS_USE_ALPHA=1" &&  /tmp/goss-windows-amd64.exe --gossfile goss/goss.yaml --vars /tmp/goss/goss-vars.yaml --vars-inline {"ARCH":"amd64","OS":"windows","PROVIDER":"azure","containerd_version":"1.4.3","kubernetes_cni_source_type":"","kubernetes_cni_version":"","kubernetes_source_type":"pkg","kubernetes_version":"v1.17.11"} validate --retry-timeout 0s --sleep 1s -f json -o pretty
    vhd-windows-2019: {
    vhd-windows-2019:     "results": [
    vhd-windows-2019:         {
    vhd-windows-2019:             "duration": 1587645100,
    vhd-windows-2019:             "err": null,
    vhd-windows-2019:             "expected": [
    vhd-windows-2019:                 "0"
    vhd-windows-2019:             ],
    vhd-windows-2019:             "found": [
    vhd-windows-2019:                 "0"
    vhd-windows-2019:             ],
    vhd-windows-2019:             "human": "",
    vhd-windows-2019:             "meta": null,
    vhd-windows-2019:             "property": "exit-status",
    vhd-windows-2019:             "resource-id": "kubectl.exe version --short --client=true -o json | powershell -Command \"($input | convertfrom-json).clientVersion.gitVersion\"",
    vhd-windows-2019:             "resource-type": "Command",
    vhd-windows-2019:             "result": 0,
    vhd-windows-2019:             "successful": true,
    vhd-windows-2019:             "summary-line": "Command: kubectl.exe version --short --client=true -o json | powershell -Command \"($input | convertfrom-json).clientVersion.gitVersion\": exit-status: matches expectation: [0]",
    vhd-windows-2019:             "test-type": 0,
    vhd-windows-2019:             "title": ""
    vhd-windows-2019:         },
    vhd-windows-2019:         {
    vhd-windows-2019:             "duration": 1587645100,
    vhd-windows-2019:             "err": null,
    vhd-windows-2019:             "expected": [
    vhd-windows-2019:                 "0"
    vhd-windows-2019:             ],
    vhd-windows-2019:             "found": [
    vhd-windows-2019:                 "0"
    vhd-windows-2019:             ],
    vhd-windows-2019:             "human": "",
    vhd-windows-2019:             "meta": null,
    vhd-windows-2019:             "property": "exit-status",
    vhd-windows-2019:             "resource-id": "kubeadm.exe version -o json | powershell -Command \"($input | convertfrom-json).clientVersion.gitVersion\"",
    vhd-windows-2019:             "resource-type": "Command",
    vhd-windows-2019:             "result": 0,
    vhd-windows-2019:             "successful": true,
    vhd-windows-2019:             "summary-line": "Command: kubeadm.exe version -o json | powershell -Command \"($input | convertfrom-json).clientVersion.gitVersion\": exit-status: matches expectation: [0]",
    vhd-windows-2019:             "test-type": 0,
    vhd-windows-2019:             "title": ""
    vhd-windows-2019:         },
    vhd-windows-2019:         {
    vhd-windows-2019:             "duration": 1822111700,
    vhd-windows-2019:             "err": null,
    vhd-windows-2019:             "expected": [
    vhd-windows-2019:                 "0"
    vhd-windows-2019:             ],
    vhd-windows-2019:             "found": [
    vhd-windows-2019:                 "0"
    vhd-windows-2019:             ],
    vhd-windows-2019:             "human": "",
    vhd-windows-2019:             "meta": null,
    vhd-windows-2019:             "property": "exit-status",
    vhd-windows-2019:             "resource-id": "kubelet.exe --version | powershell -command \"$input\".Split(\" \")[1]",
    vhd-windows-2019:             "resource-type": "Command",
    vhd-windows-2019:             "result": 0,
    vhd-windows-2019:             "successful": true,
    vhd-windows-2019:             "summary-line": "Command: kubelet.exe --version | powershell -command \"$input\".Split(\" \")[1]: exit-status: matches expectation: [0]",
    vhd-windows-2019:             "test-type": 0,
    vhd-windows-2019:             "title": ""
    vhd-windows-2019:         }
    vhd-windows-2019:     ],
    vhd-windows-2019:     "summary": {
    vhd-windows-2019:         "failed-count": 0,
    vhd-windows-2019:         "summary-line": "Count: 3, Failed: 0, Duration: 1.822s",
    vhd-windows-2019:         "test-count": 3,
    vhd-windows-2019:         "total-duration": 1822111700
    vhd-windows-2019:     }
    vhd-windows-2019: }
==> vhd-windows-2019: Goss validate ran successfully
==> vhd-windows-2019: 
==> vhd-windows-2019: 
==> vhd-windows-2019: 
==> vhd-windows-2019: Downloading spec file and debug info
    vhd-windows-2019: Downloading Goss specs from, /tmp/goss-spec.yaml and /tmp/debug-goss-spec.yaml to current dir

jsturtevant · 2021-01-21T21:48:44Z

@fishnix would you be able to help?

fishnix · 2021-01-21T22:34:14Z

Hi @jsturtevant, thanks for the PR! I'll find some cycles to review.

fishnix

Thanks again for submitting this PR. I had a few comments/suggestions. I was going to ask you to change the variable name to target_os until I noticed we've been entirely inconsistent with those properties 🤦 targetOs works. Cheers!

fishnix · 2021-01-25T15:08:29Z

packer-provisioner-goss.go

@@ -33,6 +40,7 @@ type GossConfig struct {
 	Password     string
 	SkipInstall  bool
 	Inspect      bool
+	TargetOs     OsType `string:"targetOs"`


this struct tag shouldn't be necessary

fishnix · 2021-01-25T15:09:30Z

packer-provisioner-goss.go

+const (
+	Linux   = OsType("Linux")
+	Windows = OsType("Windows")
+)


I think I understand why you did this, but I'm inclined to simplify this and just use a string and get rid of the const. It will simplify the code below as well. Thoughts?

Which logic? I think we still need all the checks in place as well as the ToLower to ensure the url is written properly. I could replace the OsType type and make it just a string?

fishnix · 2021-01-25T15:16:12Z

packer-provisioner-goss.go

+			arch := file[2]
+			if p.isGossAlpha() {
+				// includes .exe for windows
+				arch = file[3]


the comment confused me at first (I thought maybe this was only to support windows with the.exe - please strike it or clarify that the format of the alpha file is different.

fishnix · 2021-01-25T15:16:44Z

packer-provisioner-goss.go

+	if p.config.TargetOs != Linux && p.config.TargetOs != Windows {
+		errs = packer.MultiErrorAppend(errs,
+			fmt.Errorf("Os must be %s or %s", Linux, Windows))
+	}


jsturtevant · 2021-01-29T19:11:40Z

Thanks for finding the time to review! I addressed the comments. If I pushed a github action for building and running the tests on PR would you be interested?

jsturtevant · 2021-01-29T19:24:51Z

output from a build:

==> vhd-windows-2019: Provisioning with Goss                                                                                                                                                                                                                
==> vhd-windows-2019: Configured to run on Windows 

//truncated

    vhd-windows-2019:     "summary": {
    vhd-windows-2019:         "failed-count": 0,
    vhd-windows-2019:         "summary-line": "Count: 3, Failed: 0, Duration: 2.648s",
    vhd-windows-2019:         "test-count": 3,
    vhd-windows-2019:         "total-duration": 2648382900
    vhd-windows-2019:     }
    vhd-windows-2019: }
==> vhd-windows-2019: Goss validate ran successfully

jsturtevant · 2021-02-16T23:42:25Z

@fishnix Thanks for the initial review. I addressed most comments would you take a look again? Thanks!

fishnix · 2021-02-23T21:06:39Z

@jsturtevant thanks for the fixes! 🙇 I'm sorry I haven't had a chance to review this. I will as soon as I can. Cheers!

Add support for using goss to target Windows

5c19abc

fishnix suggested changes Jan 25, 2021

View reviewed changes

address comments

3b125eb

fishnix merged commit 0705d97 into YaleUniversity:master Feb 25, 2021

jsturtevant mentioned this pull request Mar 3, 2021

Add Windows support for goss kubernetes-sigs/image-builder#532

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for using goss to target Windows #39

Add support for using goss to target Windows #39

jsturtevant commented Dec 17, 2020

jsturtevant commented Jan 21, 2021

fishnix commented Jan 21, 2021

fishnix left a comment

fishnix Jan 25, 2021

fishnix Jan 25, 2021

jsturtevant Jan 29, 2021

fishnix Jan 25, 2021

fishnix Jan 25, 2021

jsturtevant commented Jan 29, 2021

jsturtevant commented Jan 29, 2021

jsturtevant commented Feb 16, 2021

fishnix commented Feb 23, 2021

Add support for using goss to target Windows #39

Add support for using goss to target Windows #39

Conversation

jsturtevant commented Dec 17, 2020

jsturtevant commented Jan 21, 2021

fishnix commented Jan 21, 2021

fishnix left a comment

Choose a reason for hiding this comment

fishnix Jan 25, 2021

Choose a reason for hiding this comment

fishnix Jan 25, 2021

Choose a reason for hiding this comment

jsturtevant Jan 29, 2021

Choose a reason for hiding this comment

fishnix Jan 25, 2021

Choose a reason for hiding this comment

fishnix Jan 25, 2021

Choose a reason for hiding this comment

jsturtevant commented Jan 29, 2021

jsturtevant commented Jan 29, 2021

jsturtevant commented Feb 16, 2021

fishnix commented Feb 23, 2021