Improve state file testing (#2190)

* Include 'build-disk' action traces in initial state yaml * Include integration tests for the 'state' subcommand * Add state check for installer tests Signed-off-by: David Cassany <dcassany@suse.com>
rancher · Sep 18, 2024 · 064546f · 064546f
1 parent e3878ea
commit 064546f
Show file tree

Hide file tree

Showing 6 changed files with 76 additions and 13 deletions.
diff --git a/pkg/action/build-disk.go b/pkg/action/build-disk.go
@@ -713,9 +713,10 @@ func (b *BuildDiskAction) createBuildDiskStateYaml(stateRoot, recoveryRoot strin
 	snapshots := map[int]*types.SystemState{}
 	if !b.spec.Expandable {
 		snapshots[b.snapshot.ID] = &types.SystemState{
-			Source: b.spec.System,
-			Digest: b.spec.System.GetDigest(),
-			Active: true,
+			Source:     b.spec.System,
+			Digest:     b.spec.System.GetDigest(),
+			Active:     true,
+			FromAction: constants.ActionBuildDisk,
 		}
 	}
 
@@ -730,10 +731,11 @@ func (b *BuildDiskAction) createBuildDiskStateYaml(stateRoot, recoveryRoot strin
 			constants.RecoveryPartName: {
 				FSLabel: b.spec.Partitions.Recovery.FilesystemLabel,
 				RecoveryImage: &types.SystemState{
-					Source: b.spec.RecoverySystem.Source,
-					Digest: b.spec.RecoverySystem.Source.GetDigest(),
-					Label:  b.spec.RecoverySystem.Label,
-					FS:     b.spec.RecoverySystem.FS,
+					Source:     b.spec.RecoverySystem.Source,
+					Digest:     b.spec.RecoverySystem.Source.GetDigest(),
+					Label:      b.spec.RecoverySystem.Label,
+					FS:         b.spec.RecoverySystem.FS,
+					FromAction: constants.ActionBuildDisk,
 				},
 			},
 		},

diff --git a/pkg/constants/constants.go b/pkg/constants/constants.go
@@ -199,6 +199,7 @@ const (
 	ActionUpgrade         = "upgrade"
 	ActionUpgradeRecovery = "upgrade-recovery"
 	ActionReset           = "reset"
+	ActionBuildDisk       = "build-disk"
 )
 
 // GetDefaultSystemEcludes returns a list of transient paths

diff --git a/tests/installer/installer_efi_test.go b/tests/installer/installer_efi_test.go
@@ -1,7 +1,7 @@
 package cos_test
 
 import (
-	"fmt"
+	"gopkg.in/yaml.v3"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -38,7 +38,6 @@ var _ = Describe("Elemental Installer EFI tests", func() {
 					By("Running the elemental install with a layout file")
 					Expect(err).To(BeNil())
 					out, err := s.Command(s.ElementalCmd("install", "--squash-no-compression", "/dev/vda"))
-					fmt.Printf(out)
 					Expect(err).To(BeNil())
 					Expect(out).To(ContainSubstring("Mounting disk partitions"))
 					Expect(out).To(ContainSubstring("Partitioning device..."))
@@ -76,6 +75,15 @@ var _ = Describe("Elemental Installer EFI tests", func() {
 					} {
 						CheckPartitionValues(disk, part)
 					}
+					By("check state file includes expected actions for the first snapshot and recovery image")
+					stateStr, err := s.Command(s.ElementalCmd("state"))
+					Expect(err).NotTo(HaveOccurred())
+
+					state := map[string]interface{}{}
+					Expect(yaml.Unmarshal([]byte(stateStr), state)).
+						To(Succeed())
+					Expect(state["state"].(map[string]interface{})["snapshots"].(map[interface{}]interface{})[1].(map[string]interface{})["fromAction"]).
+						To(Equal("install"))
 				})
 			})
 		})

diff --git a/tests/recovery/recovery_test.go b/tests/recovery/recovery_test.go
@@ -19,6 +19,8 @@ package elemental_test
 import (
 	"fmt"
 
+	"gopkg.in/yaml.v3"
+
 	sut "github.com/rancher/elemental-toolkit/v2/tests/vm"
 
 	comm "github.com/rancher/elemental-toolkit/v2/tests/common"
@@ -88,14 +90,20 @@ var _ = Describe("Elemental Recovery upgrade tests", func() {
 				Expect(err).ToNot(HaveOccurred())
 				Expect(out).Should(ContainSubstring("Recovery upgrade completed"))
 
-				// TODO: Check state.yaml changed
+				By("check state file incluldes the 'upgrade-recovery' action on the recovery image")
+				stateStr, err := s.Command(s.ElementalCmd("state"))
+				Expect(err).NotTo(HaveOccurred())
+
+				state := map[string]interface{}{}
+				Expect(yaml.Unmarshal([]byte(stateStr), state)).
+					To(Succeed())
+				Expect(state["recovery"].(map[string]interface{})["recovery"].(map[string]interface{})["fromAction"]).
+					To(Equal("upgrade-recovery"))
 
 				By("booting into recovery to check the OS version")
 				err = s.ChangeBootOnce(sut.Recovery)
 				Expect(err).ToNot(HaveOccurred())
 
-				// TODO: verify state.yaml matches expectations
-
 				s.Reboot()
 				s.EventuallyBootedFrom(sut.Recovery)
 

diff --git a/tests/upgrade/upgrade_test.go b/tests/upgrade/upgrade_test.go
@@ -19,6 +19,8 @@ package elemental_test
 import (
 	"fmt"
 
+	"gopkg.in/yaml.v3"
+
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
@@ -71,6 +73,16 @@ var _ = Describe("Elemental Feature tests", func() {
 			_, err = s.Command("cat /after-reset-chroot")
 			Expect(err).To(HaveOccurred())
 
+			By("check state file includes expected actions for the upgraded snapshot")
+			stateStr, err := s.Command(s.ElementalCmd("state"))
+			Expect(err).NotTo(HaveOccurred())
+
+			state := map[string]interface{}{}
+			Expect(yaml.Unmarshal([]byte(stateStr), state)).
+				To(Succeed())
+			Expect(state["state"].(map[string]interface{})["snapshots"].(map[interface{}]interface{})[2].(map[string]interface{})["fromAction"]).
+				To(Equal("upgrade"))
+
 			By("booting into recovery to check it is still functional")
 			Expect(s.ChangeBootOnce(sut.Recovery)).To(Succeed())
 
@@ -97,6 +109,16 @@ var _ = Describe("Elemental Feature tests", func() {
 			s.Reboot()
 			s.EventuallyBootedFrom(sut.Recovery)
 
+			By("check state file incluldes the 'upgrade-recovery' action on the recovery image")
+			stateStr, err = s.Command(s.ElementalCmd("state"))
+			Expect(err).NotTo(HaveOccurred())
+
+			state = map[string]interface{}{}
+			Expect(yaml.Unmarshal([]byte(stateStr), state)).
+				To(Succeed())
+			Expect(state["recovery"].(map[string]interface{})["recovery"].(map[string]interface{})["fromAction"]).
+				To(Equal("upgrade-recovery"))
+
 			Expect(currentVersion).To(Equal(s.GetOSRelease("TIMESTAMP")))
 
 			By("all done, back to active")

diff --git a/tests/wait-active/wait_test.go b/tests/wait-active/wait_test.go
@@ -17,15 +17,18 @@ limitations under the License.
 package elemental_test
 
 import (
+	"strings"
 	"time"
 
+	"gopkg.in/yaml.v3"
+
 	sut "github.com/rancher/elemental-toolkit/v2/tests/vm"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 )
 
-var _ = Describe("Elemental booting fallback tests", func() {
+var _ = Describe("Elemental booting an expandable disk image", func() {
 	var s *sut.SUT
 
 	BeforeEach(func() {
@@ -38,6 +41,25 @@ var _ = Describe("Elemental booting fallback tests", func() {
 				out, _ := s.Command("cat /run/cos/active_mode")
 				return out
 			}, 15*time.Minute, 10*time.Second).Should(ContainSubstring("1"))
+
+			// Check the current elemental has 'state' command, upgrade test runs this code
+			// against and old image disk image
+			helpStr, err := s.Command(s.ElementalCmd("help"))
+			Expect(err).NotTo(HaveOccurred())
+			if strings.Contains(helpStr, "Shows the install state") {
+
+				By("check state file includes expected actions for the first snapshot and recovery image")
+				stateStr, err := s.Command(s.ElementalCmd("state"))
+				Expect(err).NotTo(HaveOccurred())
+
+				state := map[string]interface{}{}
+				Expect(yaml.Unmarshal([]byte(stateStr), state)).
+					To(Succeed())
+				Expect(state["state"].(map[string]interface{})["snapshots"].(map[interface{}]interface{})[1].(map[string]interface{})["fromAction"]).
+					To(Equal("reset"))
+				Expect(state["recovery"].(map[string]interface{})["recovery"].(map[string]interface{})["fromAction"]).
+					To(Equal("build-disk"))
+			}
 		})
 	})
 })