-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
2,804 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,255 @@ | ||
| // SPDX-FileCopyrightText: 2021 SAP SE or an SAP affiliate company and Gardener contributors | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| package api_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/gardener/docforge/pkg/api" | ||
| . "github.com/onsi/ginkgo" | ||
| . "github.com/onsi/gomega" | ||
| ) | ||
|
|
||
| func TestParser(t *testing.T) { | ||
| RegisterFailHandler(Fail) | ||
| RunSpecs(t, "Parser Suite") | ||
| } | ||
|
|
||
| var _ = Describe("Parser", func() { | ||
| Describe("Version processing", func() { | ||
| var ( | ||
| tags []string | ||
| n int | ||
| outputTags []string | ||
| err error | ||
| ) | ||
| JustBeforeEach(func() { | ||
| outputTags, err = api.GetLastNVersions(tags, n) | ||
| }) | ||
| Context("given general use case input", func() { | ||
| BeforeEach(func() { | ||
| tags = []string{"v1.2.3", "v1.2.8", "v1.1.5", "v1.1.0", "v1.1.3", "v2.0.1", "v2.0.8", "v2.1.0", "v2.0.6"} | ||
| n = 4 | ||
| }) | ||
|
|
||
| It("should process them correctly", func() { | ||
| Expect(outputTags).To(Equal([]string{"v2.1.0", "v2.0.8", "v1.2.8", "v1.1.5"})) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| }) | ||
| }) | ||
| Context("given versions without the v prefix", func() { | ||
| BeforeEach(func() { | ||
| tags = []string{"1.2.3", "1.2.8", "1.1.5", "1.1.0", "1.1.3", "2.0.1", "2.0.8", "2.1.0", "2.0.6"} | ||
| n = 4 | ||
| }) | ||
|
|
||
| It("should process them correctly", func() { | ||
| Expect(outputTags).To(Equal([]string{"2.1.0", "2.0.8", "1.2.8", "1.1.5"})) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| }) | ||
| }) | ||
| Context("given a tag string with less versions as requested", func() { | ||
| BeforeEach(func() { | ||
| tags = []string{"v1.2.3", "v1.2.8", "v1.1.5", "v1.1.0", "v1.1.3", "v2.0.1", "v2.0.8", "v2.1.0", "v2.0.6"} | ||
| n = 5 | ||
| }) | ||
| It("should return the appropriate error", func() { | ||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err.Error()).To(Equal("number of tags is greater than the actual number of all tags: wanted - 5, actual - 4")) | ||
| }) | ||
| }) | ||
| Context("given a unparsable version", func() { | ||
| BeforeEach(func() { | ||
| tags = []string{"v1.2.3", "v1.2.8.0"} | ||
| n = 1 | ||
| }) | ||
| It("should return appropriate error", func() { | ||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err.Error()).To(Equal("Error parsing version: v1.2.8.0")) | ||
| }) | ||
| }) | ||
|
|
||
| Context("given negative number", func() { | ||
| BeforeEach(func() { | ||
| tags = nil | ||
| n = -7 | ||
| }) | ||
|
|
||
| It("should throw error", func() { | ||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err.Error()).To(Equal("n can't be negative")) | ||
| }) | ||
| }) | ||
| Context("given empty version array", func() { | ||
| BeforeEach(func() { | ||
| tags = []string{} | ||
| n = 0 | ||
| }) | ||
| Context("and no num tags", func() { | ||
| BeforeEach(func() { | ||
| n = 0 | ||
| }) | ||
| It("should not return error", func() { | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(outputTags).To(Equal([]string{})) | ||
| }) | ||
| }) | ||
| Context("and some num tags", func() { | ||
| BeforeEach(func() { | ||
| n = 2 | ||
| }) | ||
| It("should return error that the number of tags is greater than the actual number of all tags", func() { | ||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err.Error()).To(Equal("number of tags is greater than the actual number of all tags: wanted - 2, actual - 0")) | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
| Describe("Parsing with metadata", func() { | ||
| var ( | ||
| manifest []byte | ||
| tags []string | ||
| nVersions int | ||
| targetBranch string | ||
| url string | ||
| got *api.Documentation | ||
| err error | ||
| ) | ||
| JustBeforeEach(func() { | ||
| v := map[string]int{} | ||
| vars := map[string]string{} | ||
|
|
||
| api.SetFlagsVariables(vars) | ||
| v[url] = len(tags) | ||
| api.SetNVersions(v, v) | ||
| got, err = api.ParseWithMetadata(manifest, tags, nVersions, targetBranch) | ||
| }) | ||
|
|
||
| Context("given a general use case", func() { | ||
| BeforeEach(func() { | ||
| manifest = []byte(`structure: | ||
| - name: community | ||
| source: https://github.com/gardener/docforge/edit/master/integration-test/tested-doc/merge-test/testFile.md | ||
| {{- $vers := Split .versions "," -}} | ||
| {{- range $i, $version := $vers -}} | ||
| {{- if eq $i 0 }} | ||
| - name: docs | ||
| {{- else }} | ||
| - name: {{$version}} | ||
| {{- end }} | ||
| source: https://github.com/gardener/docforge/blob/{{$version}}/integration-test/tested-doc/merge-test/testFile.md | ||
| {{- end }}`) | ||
| tags = []string{"v4.9", "v5.7", "v5.7.5", "v6.1", "v7.7"} | ||
| nVersions = 4 | ||
| targetBranch = "master" | ||
| url = "https://github.com/Kostov6/documentation/blob/master/.docforge/test.yamls" | ||
| }) | ||
|
|
||
| It("should work as expected", func() { | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(got).To(Equal(&api.Documentation{ | ||
| Structure: []*api.Node{ | ||
| &api.Node{ | ||
| Name: "community", | ||
| Source: "https://github.com/gardener/docforge/edit/master/integration-test/tested-doc/merge-test/testFile.md", | ||
| }, | ||
| &api.Node{ | ||
| Name: "docs", | ||
| Source: "https://github.com/gardener/docforge/blob/master/integration-test/tested-doc/merge-test/testFile.md", | ||
| }, | ||
| &api.Node{ | ||
| Name: "v7.7", | ||
| Source: "https://github.com/gardener/docforge/blob/v7.7/integration-test/tested-doc/merge-test/testFile.md", | ||
| }, | ||
| &api.Node{ | ||
| Name: "v6.1", | ||
| Source: "https://github.com/gardener/docforge/blob/v6.1/integration-test/tested-doc/merge-test/testFile.md", | ||
| }, | ||
| &api.Node{ | ||
| Name: "v5.7.5", | ||
| Source: "https://github.com/gardener/docforge/blob/v5.7.5/integration-test/tested-doc/merge-test/testFile.md", | ||
| }, | ||
| &api.Node{ | ||
| Name: "v4.9", | ||
| Source: "https://github.com/gardener/docforge/blob/v4.9/integration-test/tested-doc/merge-test/testFile.md", | ||
| }, | ||
| }, | ||
| })) | ||
| }) | ||
| Context("and no versions are wanted", func() { | ||
| BeforeEach(func() { | ||
| nVersions = 0 | ||
| }) | ||
| It("should only use target branch", func() { | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(got).To(Equal(&api.Documentation{ | ||
| Structure: []*api.Node{ | ||
| &api.Node{ | ||
| Name: "community", | ||
| Source: "https://github.com/gardener/docforge/edit/master/integration-test/tested-doc/merge-test/testFile.md", | ||
| }, | ||
| &api.Node{ | ||
| Name: "docs", | ||
| Source: "https://github.com/gardener/docforge/blob/master/integration-test/tested-doc/merge-test/testFile.md", | ||
| }, | ||
| }, | ||
| })) | ||
| }) | ||
| }) | ||
|
|
||
| Context("but more versions are requested than provided", func() { | ||
| BeforeEach(func() { | ||
| nVersions = 5 | ||
| }) | ||
| It("should return error that the number of tags is greater than the actual number of all tags", func() { | ||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err.Error()).To(Equal("number of tags is greater than the actual number of all tags: wanted - 5, actual - 4")) | ||
|
|
||
| }) | ||
| }) | ||
|
|
||
| Context("but with broken yaml manifest", func() { | ||
| BeforeEach(func() { | ||
| manifest = []byte(`structure: | ||
| -name: community | ||
| source: https://github.com/gardener/docforge/edit/master/integration-test/tested-doc/merge-test/testFile.md | ||
| {{- $vers := Split .versions "," -}} | ||
| {{- range $i, $version := $vers -}} | ||
| {{- if eq $i 0 }} | ||
| - name: docs | ||
| {{- else }} | ||
| - name: {{$version}} | ||
| {{- end }} | ||
| source: https://github.com/gardener/docforge/blob/{{$version}}/integration-test/tested-doc/merge-test/testFile.md | ||
| {{- end }}`) | ||
| }) | ||
| It("should register the yaml error", func() { | ||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err.Error()).To(Equal("yaml: line 3: mapping values are not allowed in this context")) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| Context("but with broken template format", func() { | ||
| BeforeEach(func() { | ||
| manifest = []byte(`structure: | ||
| - name: community | ||
| source: https://github.com/gardener/docforge/edit/master/integration-test/tested-doc/merge-test/testFile.md | ||
| {{- $vers := Split .versions "," -}} | ||
| {{- range $i, $version := $vers -}} | ||
| {{- if eq $i 0 }} | ||
| - name: docs | ||
| {{- else }} | ||
| - name: {{$version}} | ||
| {{- end }} | ||
| source: https://github.com/gardener/docforge/blob/{{$version}}/integration-test/tested-doc/merge-test/testFile.md`) | ||
| }) | ||
| It("should register the template error", func() { | ||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err.Error()).To(Equal("template: :11: unexpected EOF")) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.