[cpackget] must strip meta data from version #268 (#275)

additional bugfixes + tests

LICENSE.txt

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   (C) 2021-2023 Linaro, 2023 Arm Ltd.
+   (C) 2021-2023 Linaro, 2024 Arm Ltd.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

cmd/installer/pack.go

@@ -210,7 +210,7 @@ func (p *PackType) purge() error {
 
 	fileNamePattern := p.Vendor + "\\." + p.Name
 	if len(p.Version) > 0 {
-		fileNamePattern += "\\." + p.Version
+		fileNamePattern += "\\." + p.GetVersionNoMeta() + ".*"
 	} else {
 		fileNamePattern += "\\..*?"
 	}
@@ -256,7 +256,7 @@ func (p *PackType) install(installation *PacksInstallationType, checkEula bool)
 		return err
 	}
 
-	packHomeDir := filepath.Join(Installation.PackRoot, p.Vendor, p.Name, p.GetVersion())
+	packHomeDir := filepath.Join(Installation.PackRoot, p.Vendor, p.Name, p.GetVersionNoMeta())
 	packBackupPath := filepath.Join(Installation.DownloadDir, p.PackFileName())
 
 	if len(p.Pdsc.License) > 0 {
@@ -365,7 +365,7 @@ func (p *PackType) uninstall(installation *PacksInstallationType) error {
 	log.Debugf("Uninstalling \"%v\"", p.path)
 
 	// Remove Vendor/Pack/x.y.z
-	packPath := filepath.Join(Installation.PackRoot, p.Vendor, p.Name, p.GetVersion())
+	packPath := filepath.Join(Installation.PackRoot, p.Vendor, p.Name, p.GetVersionNoMeta())
 	if err := os.RemoveAll(packPath); err != nil {
 		return err
 	}
@@ -609,7 +609,7 @@ func (p *PackType) PackID() string {
 
 // PackIDWithVersion returns the packID with version: Vendor.PackName.x.y.z
 func (p *PackType) PackIDWithVersion() string {
-	return p.PackID() + "." + utils.SemverStripMeta(p.GetVersion())
+	return p.PackID() + "." + p.GetVersionNoMeta()
 }
 
 // PackFileName returns a string with how the pack file name would be: Vendor.PackName.x.y.z.pack
@@ -636,10 +636,15 @@ func (p *PackType) GetVersion() string {
 	return p.Version
 }
 
+// GetVersionNoMeta return the version without meta information
+func (p *PackType) GetVersionNoMeta() string {
+	return utils.SemverStripMeta(p.GetVersion())
+}
+
 // toggleReadOnly will be used by Lock() and Unlock() to set or unset Read-Only flag on all pack files
 func (p *PackType) toggleReadOnly(setReadOnly bool) {
 	// Vendor/Pack/x.y.z/
-	packHomeDir := filepath.Join(Installation.PackRoot, p.Vendor, p.Name, utils.SemverStripMeta(p.GetVersion()))
+	packHomeDir := filepath.Join(Installation.PackRoot, p.Vendor, p.Name, p.GetVersionNoMeta())
 
 	// .Download/Vendor.Pack.z.y.z.pack
 	packBackupPath := filepath.Join(Installation.DownloadDir, p.PackFileName())

cmd/installer/root.go

@@ -91,7 +91,7 @@ func AddPack(packPath string, checkEula, extractEula, forceReinstall, noRequirem
 			log.Debugf("Making temporary backup of pack \"%s\"", packPath)
 
 			// Get target pack's full path and move it to a temporary "_tmp" directory
-			fullPackPath = filepath.Join(Installation.PackRoot, pack.Vendor, pack.Name, pack.Version)
+			fullPackPath = filepath.Join(Installation.PackRoot, pack.Vendor, pack.Name, pack.GetVersionNoMeta())
 			backupPackPath = fullPackPath + "_tmp"
 
 			if err := utils.MoveFile(fullPackPath, backupPackPath); err != nil {
@@ -101,7 +101,7 @@ func AddPack(packPath string, checkEula, extractEula, forceReinstall, noRequirem
 			log.Debugf("Moved pack to temporary path \"%s\"", backupPackPath)
 			dropPreInstalled = true
 		} else {
-			log.Errorf("Pack \"%s\" is already installed here: \"%s\", use the --force-reinstall (-F) flag to force installation", packPath, filepath.Join(Installation.PackRoot, pack.Vendor, pack.Name, pack.GetVersion()))
+			log.Errorf("Pack \"%s\" is already installed here: \"%s\", use the --force-reinstall (-F) flag to force installation", packPath, filepath.Join(Installation.PackRoot, pack.Vendor, pack.Name, pack.GetVersionNoMeta()))
 			return nil
 		}
 	}
@@ -990,7 +990,7 @@ func (p *PacksInstallationType) PackIsInstalled(pack *PackType) bool {
 
 	// Exact version is easy, just find a matching installation folder
 	if pack.versionModifier == utils.ExactVersion {
-		packDir := filepath.Join(installationDir, pack.Version)
+		packDir := filepath.Join(installationDir, pack.GetVersionNoMeta())
 		log.Debugf("Checking if \"%s\" exists", packDir)
 		return utils.DirExists(packDir)
 	}
@@ -1023,7 +1023,7 @@ func (p *PacksInstallationType) PackIsInstalled(pack *PackType) bool {
 		log.Debugf("Checking for installed packs >=%s", pack.Version)
 		for _, version := range installedVersions {
 			log.Debugf("- checking if %s >= %s", version, pack.Version)
-			if semver.Compare("v"+version, "v"+pack.Version) >= 0 {
+			if utils.SemverCompare(version, pack.Version) >= 0 {
 				log.Debugf("- found newer version %s", version)
 				pack.targetVersion = version
 				return true
@@ -1040,7 +1040,7 @@ func (p *PacksInstallationType) PackIsInstalled(pack *PackType) bool {
 		for _, version := range installedVersions {
 			log.Debugf("- checking against: %s", version)
 			sameMajor := semver.Major("v"+version) == semver.Major("v"+pack.Version)
-			if sameMajor && semver.Compare("v"+version, "v"+pack.Version) >= 0 {
+			if sameMajor && utils.SemverCompare(version, pack.Version) >= 0 {
 				pack.targetVersion = version
 				return true
 			}
@@ -1050,14 +1050,9 @@ func (p *PacksInstallationType) PackIsInstalled(pack *PackType) bool {
 	}
 
 	if pack.versionModifier == utils.RangeVersion {
-		minVersion := strings.Split(pack.Version, ":")[0]
-		maxVersion := strings.Split(pack.Version, ":")[1]
 		for _, version := range installedVersions {
-			if semver.Compare("v"+minVersion, "v"+version) <= 0 {
-				if (maxVersion == "_") || (semver.Compare("v"+version, "v"+maxVersion) <= 0) {
-					pack.targetVersion = version
-					return true
-				}
+			if utils.SemverCompareRange(version, pack.Version) == 0 {
+				return true
 			}
 		}
 		return false

cmd/installer/root_pack_add_test.go

@@ -702,7 +702,7 @@ func TestAddPack(t *testing.T) {
 			err = installer.AddPack(packPath, !CheckEula, !ExtractEula, !ForceReinstall, !NoRequirements, Timeout)
 			assert.Nil(err)
 
-			pack.Version = "1.2.3"
+			pack.Version = "1.2.3+metaInjected"
 			pack.IsPublic = true
 			checkPackIsInstalled(t, pack)
 		})
@@ -717,7 +717,7 @@ func TestAddPack(t *testing.T) {
 			packInfo, err := utils.ExtractPackInfo(packPath)
 			assert.Nil(err)
 			pack := packInfoToType(packInfo)
-			pack.Version = "1.2.3"
+			pack.Version = "1.2.3+meta"
 
 			// Prep the pdsc file to go in .Web/
 			packPdscFilePath := filepath.Join(installer.Installation.WebDir, pack.PdscFileName())
@@ -916,6 +916,7 @@ func TestAddPack(t *testing.T) {
 
 		// Make sure there's no pack folder in Vendor/PackName/x.y.z/, Vendor/PackName/ and Vendor/
 		assert.False(utils.DirExists(filepath.Join(installer.Installation.PackRoot, pack.Vendor, pack.Name, pack.Version)))
+		assert.False(utils.DirExists(filepath.Join(installer.Installation.PackRoot, pack.Vendor, pack.Name, pack.GetVersionNoMeta())))
 		assert.False(utils.DirExists(filepath.Join(installer.Installation.PackRoot, pack.Vendor, pack.Name)))
 		assert.False(utils.DirExists(filepath.Join(installer.Installation.PackRoot, pack.Vendor)))
 

cmd/utils/semver.go

@@ -15,8 +15,12 @@ import (
 // to re-use `semver` Compare and Major functions
 func stripLeadingZeros(version string) string {
 	regex := regexp.MustCompile(`\.0*(\d+)`)
-	version = strings.TrimLeft(version, "0")
 	version = regex.ReplaceAllString(version, ".$1")
+	version = strings.TrimLeft(version, "0") // trim leading zeros
+	if strings.HasPrefix(version, ".") {
+		// restore the only zero
+		version = "0" + version
+	}
 	return version
 }
 

cmd/utils/semver_test.go

@@ -33,6 +33,19 @@ func TestSemverCompare(t *testing.T) {
 		assert.True(utils.SemverCompare(version1, version2) < 0)
 		assert.True(utils.SemverCompare(version2, version1) > 0)
 	})
+	t.Run("test comparing two equal versions with and without leading zeros", func(t *testing.T) {
+		version1 := "01.02.03"
+		version2 := "1.2.3"
+		assert.True(utils.SemverCompare(version1, version2) == 0)
+	})
+	t.Run("test comparing two zero major versions with and without leading zeros", func(t *testing.T) {
+		version1 := "00.02.03"
+		version2 := "0.2.3"
+		version3 := "0.2.4"
+		assert.True(utils.SemverCompare(version1, version2) == 0)
+		assert.True(utils.SemverCompare(version1, version3) < 0)
+		assert.True(utils.SemverCompare(version2, version3) < 0)
+	})
 }
 
 func TestSemverMajor(t *testing.T) {

cmd/version.go

@@ -5,4 +5,4 @@ package main
 
 var version string
 
-const copyRight = "(C) 2021-2023 Linaro, 2023 Arm Ltd."
+const copyRight = "(C) 2021-2023 Linaro, 2024 Arm Ltd."