Set archetype format version to the latest available spec version (#1426)

Fill the spec version when creating packages with `elastic-package create package` using
the latest available version in the Package Spec.

Review related tests to don't depend on the current directory.

Author: jsoriano

cmd/create_package.go

@@ -8,7 +8,6 @@ import (
 	"fmt"
 
 	"github.com/AlecAivazis/survey/v2"
-
 	"github.com/spf13/cobra"
 
 	"github.com/elastic/elastic-package/internal/licenses"
@@ -174,6 +173,12 @@ func createPackageCommandAction(cmd *cobra.Command, args []string) error {
 	}
 
 	descriptor := createPackageDescriptorFromAnswers(answers)
+	specVersion, err := archetype.GetLatestStableSpecVersion()
+	if err != nil {
+		return fmt.Errorf("failed to get spec version: %w", err)
+	}
+	descriptor.Manifest.SpecVersion = specVersion.String()
+
 	err = archetype.CreatePackage(descriptor)
 	if err != nil {
 		return fmt.Errorf("can't create new package: %w", err)

internal/packages/archetype/_static/package-manifest.yml.tmpl

@@ -1,4 +1,4 @@
-format_version: 2.10.0
+format_version: {{.Manifest.SpecVersion}}
 name: {{.Manifest.Name}}
 title: "{{.Manifest.Title}}"
 version: {{.Manifest.Version}}
@@ -71,4 +71,4 @@ policy_templates:
 {{ end }}
 {{ end -}}
 owner:
-  github: {{.Manifest.Owner.Github}}
+  github: {{.Manifest.Owner.Github}}

internal/packages/archetype/package.go

@@ -24,14 +24,18 @@ type PackageDescriptor struct {
 
 // CreatePackage function bootstraps the new package based on the provided descriptor.
 func CreatePackage(packageDescriptor PackageDescriptor) error {
-	baseDir := packageDescriptor.Manifest.Name
+	return createPackageInDir(packageDescriptor, ".")
+}
+
+func createPackageInDir(packageDescriptor PackageDescriptor, cwd string) error {
+	baseDir := filepath.Join(cwd, packageDescriptor.Manifest.Name)
 	_, err := os.Stat(baseDir)
 	if err == nil {
 		return fmt.Errorf(`package "%s" already exists`, baseDir)
 	}
 
 	logger.Debugf("Write package manifest")
-	err = renderResourceFile(packageManifestTemplate, &packageDescriptor, filepath.Join(baseDir, "manifest.yml"))
+	err = renderResourceFile(packageManifestTemplate, packageDescriptor, filepath.Join(baseDir, "manifest.yml"))
 	if err != nil {
 		return fmt.Errorf("can't render package manifest: %w", err)
 	}

internal/packages/archetype/package_test.go

@@ -6,7 +6,6 @@ package archetype
 
 import (
 	"fmt"
-	"os"
 	"path/filepath"
 	"testing"
 
@@ -39,23 +38,12 @@ func TestPackage(t *testing.T) {
 	})
 }
 
-func createAndCheckPackage(t require.TestingT, pd PackageDescriptor) error {
-	wd, err := os.Getwd()
+func createAndCheckPackage(t *testing.T, pd PackageDescriptor) error {
+	tempDir := t.TempDir()
+	err := createPackageInDir(pd, tempDir)
 	require.NoError(t, err)
 
-	tempDir, err := os.MkdirTemp("", "archetype-create-package-")
-	require.NoError(t, err)
-
-	os.Chdir(tempDir)
-	defer func() {
-		os.Chdir(wd)
-		os.RemoveAll(tempDir)
-	}()
-
-	err = CreatePackage(pd)
-	require.NoError(t, err)
-
-	err = checkPackage(pd.Manifest.Name)
+	err = checkPackage(filepath.Join(tempDir, pd.Manifest.Name))
 	return err
 }
 
@@ -64,12 +52,17 @@ func createPackageDescriptorForTest(packageType, kibanaVersion string) PackageDe
 	if packageType == "input" {
 		inputDataStreamType = "logs"
 	}
+	specVersion, err := GetLatestStableSpecVersion()
+	if err != nil {
+		panic(err)
+	}
 	return PackageDescriptor{
 		Manifest: packages.PackageManifest{
-			Name:    "go_unit_test_package",
-			Title:   "Go Unit Test Package",
-			Type:    packageType,
-			Version: "1.2.3",
+			SpecVersion: specVersion.String(),
+			Name:        "go_unit_test_package",
+			Title:       "Go Unit Test Package",
+			Type:        packageType,
+			Version:     "1.2.3",
 			Conditions: packages.Conditions{
 				Kibana: packages.KibanaConditions{
 					Version: kibanaVersion,
@@ -82,24 +75,14 @@ func createPackageDescriptorForTest(packageType, kibanaVersion string) PackageDe
 				Github: "mtojek",
 			},
 			Description: "This package has been generated by a Go unit test.",
-			License:     "basic",
 			Categories:  []string{"aws", "custom"},
 		},
 		InputDataStreamType: inputDataStreamType,
 	}
 }
 
-func checkPackage(packageName string) error {
-	wd, err := os.Getwd()
-	if err != nil {
-		return fmt.Errorf("can't get working directory: %w", err)
-	}
-	packageRoot := filepath.Join(wd, packageName)
-
-	os.Chdir(packageRoot)
-	defer os.Chdir(wd)
-
-	err = validator.ValidateFromPath(packageRoot)
+func checkPackage(packageRoot string) error {
+	err := validator.ValidateFromPath(packageRoot)
 	if err != nil {
 		return fmt.Errorf("linting package failed: %w", err)
 	}

internal/packages/archetype/spec.go

@@ -0,0 +1,29 @@
+// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+// or more contributor license agreements. Licensed under the Elastic License;
+// you may not use this file except in compliance with the Elastic License.
+
+package archetype
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/Masterminds/semver/v3"
+	spec "github.com/elastic/package-spec/v2"
+)
+
+func GetLatestStableSpecVersion() (semver.Version, error) {
+	specVersions, err := spec.VersionsInChangelog()
+	if err != nil {
+		return semver.Version{}, fmt.Errorf("can't find existing spec versions: %w", err)
+	}
+
+	// We assume versions are sorted here.
+	for _, version := range specVersions {
+		if version.Prerelease() == "" {
+			return version, nil
+		}
+	}
+
+	return semver.Version{}, errors.New("no stable package spec version found, this is probably a bug")
+}