Add tests

Author: jsoriano

internal/docs/readme_test.go

@@ -55,8 +55,7 @@ Introduction to the package`,
 		t.Run(c.title, func(t *testing.T) {
 
 			dir := t.TempDir()
-			err := createReadmeFile(dir, c.readmeTemplateContents)
-			require.NoError(t, err)
+			createReadmeTemplateFile(t, dir, c.readmeTemplateContents)
 
 			rendered, isTemplate, err := generateReadme(c.filename, "", dir, dir)
 			require.NoError(t, err)
@@ -112,8 +111,7 @@ http://www.example.com/bar
 			filename := filepath.Base(c.templatePath)
 			templatePath := filepath.Join(c.packageRoot, c.templatePath)
 
-			err := createReadmeFile(c.packageRoot, c.readmeTemplateContents)
-			require.NoError(t, err)
+			createReadmeTemplateFile(t, c.packageRoot, c.readmeTemplateContents)
 
 			rendered, err := renderReadme(filename, c.packageRoot, templatePath, c.linksMap)
 			require.NoError(t, err)
@@ -165,14 +163,9 @@ An example event for ` + "`example`" + ` looks as following:
 			filename := filepath.Base(c.templatePath)
 			templatePath := filepath.Join(c.packageRoot, c.templatePath)
 
-			err := createReadmeFile(c.packageRoot, c.readmeTemplateContents)
-			require.NoError(t, err)
-
-			err = createSampleEventFile(c.packageRoot, c.dataStreamName, c.sampleEventJsonContents)
-			require.NoError(t, err)
-
-			err = createManifestFile(c.packageRoot)
-			require.NoError(t, err)
+			createReadmeTemplateFile(t, c.packageRoot, c.readmeTemplateContents)
+			createSampleEventFile(t, c.packageRoot, c.dataStreamName, c.sampleEventJsonContents)
+			createManifestFile(t, c.packageRoot)
 
 			rendered, err := renderReadme(filename, c.packageRoot, templatePath, linksMap)
 			require.NoError(t, err)
@@ -183,26 +176,23 @@ An example event for ` + "`example`" + ` looks as following:
 	}
 }
 
-func TesRenderReadmeWithFields(t *testing.T) {
-	cases := []struct {
-		title                  string
-		packageRoot            string
-		templatePath           string
-		dataStreamName         string
-		readmeTemplateContents string
-		fieldsContents         string
-		expected               string
-	}{
-		{
-			title:        "README fields from package",
-			packageRoot:  t.TempDir(),
-			templatePath: "_dev/build/docs/README.md",
-			readmeTemplateContents: `
+var renderCases = []struct {
+	title                  string
+	templatePath           string
+	dataStreamName         string
+	readmeTemplateContents string
+	fieldsContents         string
+	expected               string
+}{
+	{
+		title:        "README fields from package",
+		templatePath: "_dev/build/docs/README.md",
+		readmeTemplateContents: `
 {{- generatedHeader }}
 # README
 Introduction to the package
 {{ fields }}`,
-			expected: `<!-- NOTICE: Do not edit this file manually.-->
+		expected: `<!-- NOTICE: Do not edit this file manually.-->
 <!-- This file is automatically generated by Elastic Package -->
 # README
 Introduction to the package
@@ -212,71 +202,95 @@ Introduction to the package
 |---|---|---|
 | data_stream.type | Data stream type package. | constant_keyword |
 `,
-			dataStreamName: "",
-			fieldsContents: `
+		dataStreamName: "",
+		fieldsContents: `
 - name: data_stream.type
   type: constant_keyword
   description: Data stream type package.`,
-		},
-		{
-			title:        "README with one field",
-			packageRoot:  t.TempDir(),
-			templatePath: "_dev/build/docs/README.md",
-			readmeTemplateContents: `
-# README
+	},
+	{
+		title:        "README with one field",
+		templatePath: "_dev/build/docs/README.md",
+		readmeTemplateContents: `# README
 Introduction to the package
 {{ fields "example" }}`,
-			expected: `<!-- NOTICE: Do not edit this file manually.-->
-<!-- This file is automatically generated by Elastic Package -->
-# README
+		expected: `# README
 Introduction to the package
 **Exported fields**
 
 | Field | Description | Type |
 |---|---|---|
 | data_stream.type | Data stream type. | constant_keyword |
 `,
-			dataStreamName: "example",
-			fieldsContents: `
+		dataStreamName: "example",
+		fieldsContents: `
 - name: data_stream.type
   type: constant_keyword
   description: Data stream type.`,
-		},
-		{
-			title:        "README no fields",
-			packageRoot:  t.TempDir(),
-			templatePath: "_dev/build/docs/README.md",
-			readmeTemplateContents: `
+	},
+	{
+		title:        "README with group fields",
+		templatePath: "_dev/build/docs/README.md",
+		readmeTemplateContents: `
+# README
+Introduction to the package
+{{ fields "example" }}`,
+		expected: `
+# README
+Introduction to the package
+**Exported fields**
+
+| Field | Description | Type |
+|---|---|---|
+| dns.answers | An array containing an object for each answer section returned by the server. The main keys that should be present in these objects are defined by ECS. Records that have more information may contain more keys than what ECS defines. Not all DNS data sources give all details about DNS answers. At minimum, answer objects must contain the ` + "`data`" + ` key. If more information is available, map as much of it to ECS as possible, and add any additional fields to the answer objects as custom fields. | group |
+| dns.answers.name | The domain name to which this resource record pertains. If a chain of CNAME is being resolved, each answer's ` + "`name`" + ` should be the one that corresponds with the answer's ` + "`data`" + `. It should not simply be the original ` + "`question.name`" + ` repeated. | keyword |
+`,
+		dataStreamName: "example",
+		fieldsContents: `
+- name: emptygroup
+  type: group
+- external: ecs
+  name: dns.answers
+  type: group
+- external: ecs
+  name: dns.answers.name
+`,
+	},
+	{
+		title:        "README no fields",
+		templatePath: "_dev/build/docs/README.md",
+		readmeTemplateContents: `
 {{- generatedHeader }}
 # README
 Introduction to the package
 {{ fields "notexist" }}`,
-			expected: `<!-- NOTICE: Do not edit this file manually.-->
+		expected: `<!-- NOTICE: Do not edit this file manually.-->
 <!-- This file is automatically generated by Elastic Package -->
 # README
 Introduction to the package
 **Exported fields**
 
 (no fields available)
 `,
-			dataStreamName: "example",
-			fieldsContents: "",
-		},
-	}
+		dataStreamName: "example",
+		fieldsContents: "",
+	},
+}
 
+func TestRenderReadmeWithFields(t *testing.T) {
 	linksMap := newEmptyLinkMap()
-	for _, c := range cases {
+	for _, c := range renderCases {
 		t.Run(c.title, func(t *testing.T) {
+			packageRoot := t.TempDir()
 			filename := filepath.Base(c.templatePath)
-			templatePath := filepath.Join(c.packageRoot, c.templatePath)
+			templatePath := filepath.Join(packageRoot, c.templatePath)
 
-			err := createReadmeFile(c.packageRoot, c.readmeTemplateContents)
-			require.NoError(t, err)
+			createManifestFile(t, packageRoot)
+			createBuildFile(t, packageRoot)
+			createReadmeTemplateFile(t, packageRoot, c.readmeTemplateContents)
+			createFieldsFile(t, packageRoot, c.dataStreamName, c.fieldsContents)
 
-			err = createFieldsFile(c.packageRoot, c.dataStreamName, c.fieldsContents)
-			require.NoError(t, err)
-
-			rendered, err := renderReadme(filename, c.packageRoot, templatePath, linksMap)
+			rendered, err := renderReadme(filename, packageRoot, templatePath, linksMap)
 			require.NoError(t, err)
 
 			renderedString := string(rendered)
@@ -285,81 +299,123 @@ Introduction to the package
 	}
 }
 
-func createReadmeFile(packageRoot, contents string) error {
-	docsFolder, err := createDocsFolder(packageRoot)
-	if err != nil {
-		return err
+func TestUpdateReadmeWithFields(t *testing.T) {
+	for _, c := range renderCases {
+		t.Run(c.title, func(t *testing.T) {
+			packageRoot := t.TempDir()
+			filename := filepath.Base(c.templatePath)
+
+			createManifestFile(t, packageRoot)
+			createBuildFile(t, packageRoot)
+			createReadmeTemplateFile(t, packageRoot, c.readmeTemplateContents)
+			createFieldsFile(t, packageRoot, c.dataStreamName, c.fieldsContents)
+
+			packageBuildRoot := t.TempDir()
+			createManifestFile(t, packageBuildRoot)
+
+			readmePath, err := updateReadme(filename, "", packageRoot, packageBuildRoot)
+			require.NoError(t, err)
+			require.NotEmpty(t, readmePath)
+			d, err := os.ReadFile(readmePath)
+			require.NoError(t, err)
+			assert.Equal(t, string(c.expected), string(d))
+
+			builtReadmePath, err := filepath.Rel(packageRoot, readmePath)
+			require.NoError(t, err)
+			builtReadmePath = filepath.Join(packageBuildRoot, builtReadmePath)
+			d, err = os.ReadFile(builtReadmePath)
+			require.NoError(t, err)
+			assert.Equal(t, string(c.expected), string(d))
+		})
 	}
+}
 
+func createReadmeTemplateFile(t *testing.T, packageRoot, contents string) {
+	t.Helper()
+	docsFolder := createDocsFolder(t, packageRoot)
 	if contents != "" {
 		readmeFile := filepath.Join(docsFolder, "README.md")
-		os.WriteFile(readmeFile, []byte(contents), 0644)
+		err := os.WriteFile(readmeFile, []byte(contents), 0644)
+		require.NoError(t, err)
 	}
-	return nil
 }
 
-func createDocsFolder(packageRoot string) (string, error) {
+func createDocsFolder(t *testing.T, packageRoot string) string {
+	t.Helper()
 	docsFolder := filepath.Join(packageRoot, "_dev", "build", "docs")
-	err := os.MkdirAll(docsFolder, os.ModePerm)
-	if err != nil {
-		return "", err
-	}
-	return docsFolder, nil
+	err := os.MkdirAll(docsFolder, 0755)
+	require.NoError(t, err)
+	return docsFolder
 }
 
-func createSampleEventFile(packageRoot, dataStreamName, contents string) error {
-	dataStreamFolder, err := createDataStreamFolder(packageRoot, dataStreamName)
-	if err != nil {
-		return err
-	}
+func createSampleEventFile(t *testing.T, packageRoot, dataStreamName, contents string) {
+	t.Helper()
+	dataStreamFolder := createDataStreamFolder(t, packageRoot, dataStreamName)
 
 	sampleEventFile := filepath.Join(dataStreamFolder, sampleEventFile)
-	if err := os.WriteFile(sampleEventFile, []byte(contents), 0644); err != nil {
-		return err
-	}
-	return nil
+	err := os.WriteFile(sampleEventFile, []byte(contents), 0644)
+	require.NoError(t, err)
 }
 
-func createManifestFile(packageRoot string) error {
+func createManifestFile(t *testing.T, packageRoot string) {
+	t.Helper()
 	// Minimal content needed to render readme.
-	manifest := `format_version: 2.10.0`
+	manifest := `format_version: 2.10.0
+type: integration
+version: 1.0.0
+`
 	manifestFile := filepath.Join(packageRoot, packages.PackageManifestFile)
-	return os.WriteFile(manifestFile, []byte(manifest), 0644)
+	err := os.WriteFile(manifestFile, []byte(manifest), 0644)
+	require.NoError(t, err)
 }
 
-func createDataStreamFolder(packageRoot, dataStreamName string) (string, error) {
+func createDataStreamFolder(t *testing.T, packageRoot, dataStreamName string) string {
+	t.Helper()
 	if dataStreamName == "" {
-		return "", nil
+		return ""
 	}
 
 	dataStreamFolder := filepath.Join(packageRoot, "data_stream", dataStreamName)
-	if err := os.MkdirAll(dataStreamFolder, os.ModePerm); err != nil {
-		return "", err
-	}
-	return dataStreamFolder, nil
+	err := os.MkdirAll(dataStreamFolder, 0755)
+	require.NoError(t, err)
+
+	return dataStreamFolder
 }
 
-func createFieldsFile(packageRoot, dataStreamName, contents string) error {
-	fieldsFolder, err := createFieldsFolder(packageRoot, dataStreamName)
-	if err != nil {
-		return err
-	}
+func createFieldsFile(t *testing.T, packageRoot, dataStreamName, contents string) {
+	t.Helper()
+	fieldsFolder := createFieldsFolder(t, packageRoot, dataStreamName)
 	fieldsFile := filepath.Join(fieldsFolder, "fields.yml")
-	if err := os.WriteFile(fieldsFile, []byte(contents), 0644); err != nil {
-		return err
-	}
-	return nil
+
+	err := os.WriteFile(fieldsFile, []byte(contents), 0644)
+	require.NoError(t, err)
 }
 
-func createFieldsFolder(packageRoot, dataStreamName string) (string, error) {
+func createFieldsFolder(t *testing.T, packageRoot, dataStreamName string) string {
+	t.Helper()
 	fieldsFolder := packageRoot
 	if dataStreamName != "" {
 		fieldsFolder = filepath.Join(fieldsFolder, "data_stream", dataStreamName)
 	}
 	fieldsFolder = filepath.Join(fieldsFolder, "fields")
 
-	if err := os.MkdirAll(fieldsFolder, os.ModePerm); err != nil {
-		return "", err
-	}
-	return fieldsFolder, nil
+	err := os.MkdirAll(fieldsFolder, 0755)
+	require.NoError(t, err)
+
+	return fieldsFolder
+}
+
+func createBuildFile(t *testing.T, packageRoot string) {
+	t.Helper()
+	buildDir := filepath.Join(packageRoot, "_dev", "build")
+	err := os.MkdirAll(buildDir, 0755)
+	require.NoError(t, err)
+
+	content := `dependencies:
+  ecs:
+    reference: git@8.1
+`
+	buildFile := filepath.Join(buildDir, "build.yml")
+	err = os.WriteFile(buildFile, []byte(content), 0644)
+	require.NoError(t, err)
 }

internal/fields/validate.go

@@ -260,16 +260,18 @@ type packageRootFinder interface {
 	FindPackageRoot() (string, error)
 }
 
-type packageRoot struct{}
+type packageRoot struct {
+	from string
+}
 
 func (p packageRoot) FindPackageRoot() (string, error) {
-	return packages.FindPackageRoot()
+	return packages.FindPackageRootFrom(p.from)
 }
 
 // CreateValidatorForDirectory function creates a validator for the directory.
 func CreateValidatorForDirectory(fieldsParentDir string, opts ...ValidatorOption) (v *Validator, err error) {
-	p := packageRoot{}
-	return createValidatorForDirectoryAndPackageRoot(fieldsParentDir, p, opts...)
+	finder := packageRoot{from: fieldsParentDir}
+	return createValidatorForDirectoryAndPackageRoot(fieldsParentDir, finder, opts...)
 }
 
 func createValidatorForDirectoryAndPackageRoot(fieldsParentDir string, finder packageRootFinder, opts ...ValidatorOption) (v *Validator, err error) {