Merge pull request #289 from redhatrises/go_standards

Update file structure to closer match GO standards

.circleci/config.yml

@@ -12,7 +12,7 @@ jobs:
 
       - run:
           name: Build the program
-          command: go build
+          command: go build cmd/compliance-masonry/compliance-masonry.go cmd/compliance-masonry/diff.go
       - run:
           name: Run tests
           command: ./.circleci/coverage.sh

.codeclimate.yml

@@ -15,5 +15,5 @@ ratings:
   paths:
   - "**.go"
 exclude_paths:
-- fixtures/
+- test/
 - vendor/

.dockerignore

@@ -1,12 +1,11 @@
-circleci/
+.circleci/
 docs/
-exampleplugin/
-fixtures/
+examples/
+test/
 .codeclimate.yml
 .git
 .gitignore
 .goxc.json
 appveyor.yml
-circle.yml
 CONTRIBUTING.md
-release.sh
+release.sh

.gitignore

@@ -1,4 +1,3 @@
-.goxc.local.json
 /compliance-masonry
 *.swp
 *.out

appveyor.yml

@@ -17,6 +17,6 @@ install:
 
     set PATH=%PATH%;%GOPATH%\bin
 build_script:
-- cmd: go build
+- cmd: go build cmd/compliance-masonry/compliance-masonry.go cmd/compliance-masonry/diff.go 
 test_script:
 - cmd: FOR /F %%A IN ('glide novendor') DO go test -v %%A || exit /b 1

masonry-go.go → cmd/compliance-masonry/compliance-masonry.go

@@ -8,9 +8,9 @@ import (
 	"path/filepath"
 
 	"github.com/codegangsta/cli"
-	"github.com/opencontrol/compliance-masonry/commands/docs"
-	"github.com/opencontrol/compliance-masonry/commands/docs/gitbook"
-	"github.com/opencontrol/compliance-masonry/commands/get"
+	"github.com/opencontrol/compliance-masonry/pkg/cli/docs"
+	"github.com/opencontrol/compliance-masonry/pkg/cli/docs/gitbook"
+	"github.com/opencontrol/compliance-masonry/pkg/cli/get"
 	"github.com/opencontrol/compliance-masonry/tools/constants"
 	"github.com/opencontrol/compliance-masonry/tools/fs"
 	"github.com/opencontrol/compliance-masonry/version"

masonry-go_test.go → cmd/compliance-masonry/compliance_masonry_test.go

@@ -60,7 +60,7 @@ var _ = Describe("Masonry CLI", func() {
 				output := Masonry(
 					"docs", "gitbook", "LATO",
 					"-e", exportTempDir,
-					"-o", filepath.Join("fixtures", "opencontrol_fixtures"),
+					"-o", filepath.Join("..", "..", "test", "fixtures", "opencontrol_fixtures"),
 					"-m", "sdfds").Wait(1 * time.Second)
 				Eventually(output.Out.Contents).Should(ContainSubstring("Warning: markdown directory does not exist\n"))
 				Eventually(output.Out.Contents).Should(ContainSubstring("New Gitbook Documentation Created\n"))
@@ -73,8 +73,8 @@ var _ = Describe("Masonry CLI", func() {
 				output := Masonry(
 					"docs", "gitbook", "LATO",
 					"-e", exportTempDir,
-					"-o", filepath.Join("fixtures", "opencontrol_fixtures_with_markdown"),
-					"-m", filepath.Join("fixtures", "opencontrol_fixtures_with_markdown", "markdowns")).Wait(1 * time.Second)
+					"-o", filepath.Join("..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown"),
+					"-m", filepath.Join("..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown", "markdowns")).Wait(1 * time.Second)
 				Eventually(output.Out.Contents).ShouldNot(ContainSubstring("Warning: markdown directory does not exist\n"))
 				Eventually(output.Out.Contents).Should(ContainSubstring("New Gitbook Documentation Created\n"))
 			})
@@ -101,15 +101,15 @@ var _ = Describe("Masonry CLI", func() {
 			It("should print the number of missing controls", func() {
 				output := Masonry(
 					"diff", "LATO",
-					"-o", filepath.Join("fixtures", "opencontrol_fixtures")).Wait(1 * time.Second)
+					"-o", filepath.Join("..", "..", "test", "fixtures", "opencontrol_fixtures")).Wait(1 * time.Second)
 				Eventually(output.Out.Contents).Should(ContainSubstring("Number of missing controls:"))
 			})
 		})
 	})
 })
 
 func Masonry(args ...string) *Session {
-	path, err := Build("github.com/opencontrol/compliance-masonry")
+	path, err := Build("github.com/opencontrol/compliance-masonry/cmd/compliance-masonry")
 	Expect(err).NotTo(HaveOccurred())
 	cmd := exec.Command(path, args...)
 	stdin, err := cmd.StdinPipe()

diff.go → cmd/compliance-masonry/diff.go

@@ -3,7 +3,7 @@ package main
 import (
 	"fmt"
 	"github.com/codegangsta/cli"
-	"github.com/opencontrol/compliance-masonry/commands/diff"
+	"github.com/opencontrol/compliance-masonry/pkg/cli/diff"
 	"github.com/tg/gosortmap"
 )
 

diff_test.go → cmd/compliance-masonry/diff_test.go

@@ -34,7 +34,7 @@ var _ = Describe("Diff", func() {
 			}
 		})
 		It("should return return the number a missing controls when given a certification", func() {
-			err := app.Run([]string{app.Name, "diff", "LATO", "-o", filepath.Join("fixtures", "opencontrol_fixtures")})
+			err := app.Run([]string{app.Name, "diff", "LATO", "-o", filepath.Join("..", "..", "test", "fixtures", "opencontrol_fixtures")})
 			assert.Nil(GinkgoT(), err)
 			assert.Contains(GinkgoT(), buffer.String(), "Number of missing controls:")
 		})

exampleplugin/example.go → examples/example.go

@@ -2,8 +2,8 @@ package main
 
 import (
 	"fmt"
-	"github.com/opencontrol/compliance-masonry/lib"
-	"github.com/opencontrol/compliance-masonry/lib/common"
+	"github.com/opencontrol/compliance-masonry/pkg/lib"
+	"github.com/opencontrol/compliance-masonry/pkg/lib/common"
 	"io"
 	"os"
 )

exampleplugin/example_test.go → examples/example_test.go

@@ -5,8 +5,8 @@ import (
 	. "github.com/onsi/gomega"
 	. "github.com/onsi/gomega/gbytes"
 	. "github.com/onsi/gomega/gexec"
-	"github.com/opencontrol/compliance-masonry/lib/common"
-	"github.com/opencontrol/compliance-masonry/lib/common/mocks"
+	"github.com/opencontrol/compliance-masonry/pkg/lib/common"
+	"github.com/opencontrol/compliance-masonry/pkg/lib/common/mocks"
 	"github.com/stretchr/testify/assert"
 	"os"
 	"os/exec"
@@ -48,8 +48,8 @@ var _ = Describe("Exampleplugin", func() {
 	Describe("run", func() {
 		Context("When running it on data in a workspace", func() {
 			It("should find the data and print it out to standard out", func() {
-				wsPath := filepath.Join("..", "fixtures", "opencontrol_fixtures")
-				certPath := filepath.Join("..", "..", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml")
+				wsPath := filepath.Join("..", "test", "fixtures", "opencontrol_fixtures")
+				certPath := filepath.Join("..", "..", "test", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml")
 				buffer := NewBuffer()
 				run(wsPath, certPath, buffer)
 				Expect(buffer).To(Say("partial"))
@@ -84,12 +84,12 @@ func cleanupOpencontrolWorkspace() {
 }
 
 func Masonry(args ...string) *Session {
-	path, err := Build("github.com/opencontrol/compliance-masonry")
+	path, err := Build("github.com/opencontrol/compliance-masonry/cmd/compliance-masonry")
 	Expect(err).NotTo(HaveOccurred())
 	return createCommand(path, args...)
 }
 func Plugin(args ...string) *Session {
-	path, err := Build("github.com/opencontrol/compliance-masonry/exampleplugin")
+	path, err := Build("github.com/opencontrol/compliance-masonry/examples")
 	Expect(err).NotTo(HaveOccurred())
 	return createCommand(path, args...)
 }

commands/diff/inventory.go → pkg/cli/diff/inventory.go

@@ -2,8 +2,8 @@ package diff
 
 import (
 	"fmt"
-	"github.com/opencontrol/compliance-masonry/lib"
-	"github.com/opencontrol/compliance-masonry/lib/common"
+	"github.com/opencontrol/compliance-masonry/pkg/lib"
+	"github.com/opencontrol/compliance-masonry/pkg/lib/common"
 	"github.com/opencontrol/compliance-masonry/tools/certifications"
 )
 

commands/diff/inventory_test.go → pkg/cli/diff/inventory_test.go

@@ -1,7 +1,7 @@
 package diff_test
 
 import (
-	. "github.com/opencontrol/compliance-masonry/commands/diff"
+	. "github.com/opencontrol/compliance-masonry/pkg/cli/diff"
 
 	"errors"
 	. "github.com/onsi/ginkgo"
@@ -39,7 +39,7 @@ var _ = Describe("Inventory", func() {
 		Context("When there are controls specified in the certification but some controls have been documented", func() {
 			It("should return a subset of the full list of controls", func() {
 				config := Config{
-					OpencontrolDir: filepath.Join(workingDir, "..", "..", "fixtures", "opencontrol_fixtures"),
+					OpencontrolDir: filepath.Join(workingDir, "..", "..", "..", "test", "fixtures", "opencontrol_fixtures"),
 					Certification:  "LATO",
 				}
 				i, err := ComputeGapAnalysis(config)
@@ -50,7 +50,7 @@ var _ = Describe("Inventory", func() {
 		Context("When there are controls specified in the certification and we have documented them", func() {
 			It("should return no missing controls", func() {
 				config := Config{
-					OpencontrolDir: filepath.Join(workingDir, "..", "..", "fixtures", "opencontrol_fixtures_complete"),
+					OpencontrolDir: filepath.Join(workingDir, "..", "..", "..", "test", "fixtures", "opencontrol_fixtures_complete"),
 					Certification:  "LATO",
 				}
 				i, err := ComputeGapAnalysis(config)

commands/docs/docs.go → pkg/cli/docs/docs.go

@@ -3,7 +3,7 @@ package docs
 import (
 	"os"
 
-	"github.com/opencontrol/compliance-masonry/commands/docs/gitbook"
+	"github.com/opencontrol/compliance-masonry/pkg/cli/docs/gitbook"
 	"github.com/opencontrol/compliance-masonry/tools/certifications"
 )
 

commands/docs/docs_test.go → pkg/cli/docs/docs_test.go

@@ -7,8 +7,8 @@ import (
 	"os"
 	"path/filepath"
 
-	. "github.com/opencontrol/compliance-masonry/commands/docs"
-	"github.com/opencontrol/compliance-masonry/commands/docs/gitbook"
+	. "github.com/opencontrol/compliance-masonry/pkg/cli/docs"
+	"github.com/opencontrol/compliance-masonry/pkg/cli/docs/gitbook"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/ginkgo/extensions/table"
@@ -27,7 +27,7 @@ var _ = Describe("Doc Tests", func() {
 		Entry(
 			"Check that the gitbook is correctly exported given the fixtures",
 			gitbook.Config{
-				OpencontrolDir: filepath.Join("..", "..", "fixtures", "opencontrol_fixtures"),
+				OpencontrolDir: filepath.Join("..", "..", "..", "test", "fixtures", "opencontrol_fixtures"),
 				Certification:  "LATO",
 				MarkdownPath:   "",
 			},
@@ -49,9 +49,9 @@ var _ = Describe("Doc Tests", func() {
 		Entry(
 			"Check that gitbook is created with markdowns",
 			gitbook.Config{
-				OpencontrolDir: filepath.Join("..", "..", "fixtures", "opencontrol_fixtures_with_markdown"),
+				OpencontrolDir: filepath.Join("..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown"),
 				Certification:  "LATO",
-				MarkdownPath:   filepath.Join("..", "..", "fixtures", "opencontrol_fixtures_with_markdown", "markdowns"),
+				MarkdownPath:   filepath.Join("..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown", "markdowns"),
 			},
 			"",
 			nil,
@@ -60,20 +60,20 @@ var _ = Describe("Doc Tests", func() {
 		Entry(
 			"Check that thre is an error returned when the certification does not exist",
 			gitbook.Config{
-				OpencontrolDir: filepath.Join("..", "..", "fixtures", "opencontrol_fixtures_with_markdown"),
+				OpencontrolDir: filepath.Join("..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown"),
 				Certification:  "LAT",
-				MarkdownPath:   filepath.Join("..", "..", "fixtures", "opencontrol_fixtures_with_markdown", "markdowns"),
+				MarkdownPath:   filepath.Join("..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown", "markdowns"),
 			},
 			"",
-			[]error{fmt.Errorf("Error: `%s` does not exist\nUse one of the following:\nLATO", filepath.Join("..", "..", "fixtures", "opencontrol_fixtures_with_markdown", "certifications", "LAT.yaml"))},
+			[]error{fmt.Errorf("Error: `%s` does not exist\nUse one of the following:\nLATO", filepath.Join("..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown", "certifications", "LAT.yaml"))},
 		),
 
 		Entry(
 			"Check that error is returned when certification argument is not present",
 			gitbook.Config{
-				OpencontrolDir: filepath.Join("..", "..", "fixtures", "opencontrol_fixtures_with_markdown"),
+				OpencontrolDir: filepath.Join("..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown"),
 				Certification:  "",
-				MarkdownPath:   filepath.Join("..", "..", "fixtures", "opencontrol_fixtures_with_markdown", "markdowns/"),
+				MarkdownPath:   filepath.Join("..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown", "markdowns/"),
 			},
 			"",
 			[]error{errors.New("Error: Missing Certification Argument")},

commands/docs/gitbook/gitbook.go → pkg/cli/docs/gitbook/gitbook.go

@@ -5,8 +5,8 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/opencontrol/compliance-masonry/lib"
-	"github.com/opencontrol/compliance-masonry/lib/common"
+	"github.com/opencontrol/compliance-masonry/pkg/lib"
+	"github.com/opencontrol/compliance-masonry/pkg/lib/common"
 	"github.com/opencontrol/compliance-masonry/tools/fs"
 )
 

commands/docs/gitbook/gitbookCertification.go → pkg/cli/docs/gitbook/gitbookCertification.go

@@ -5,7 +5,7 @@ import (
 	"io/ioutil"
 	"path/filepath"
 
-	"github.com/opencontrol/compliance-masonry/lib/common"
+	"github.com/opencontrol/compliance-masonry/pkg/lib/common"
 )
 
 func (openControl *OpenControlGitBook) getResponsibleRole(text string, component common.Component) string {

commands/docs/gitbook/gitbookCertification_test.go → pkg/cli/docs/gitbook/gitbookCertification_test.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/opencontrol/compliance-masonry/lib"
+	"github.com/opencontrol/compliance-masonry/pkg/lib"
 	"github.com/opencontrol/compliance-masonry/tools/fs"
 )
 
@@ -24,8 +24,8 @@ type exportControlTest struct {
 var exportControlTests = []exportControlTest{
 	// Check that a control is exported correctly
 	{
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures"),
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml"),
 		"NIST-800-53",
 		"CM-2",
 		"NIST-800-53-CM-2.md",

commands/docs/gitbook/gitbookComponents_test.go → pkg/cli/docs/gitbook/gitbookComponents_test.go

@@ -4,8 +4,8 @@ import (
 	"testing"
 
 	"github.com/blang/semver"
-	"github.com/opencontrol/compliance-masonry/lib/common"
-	v2 "github.com/opencontrol/compliance-masonry/lib/components/versions/2_0_0"
+	"github.com/opencontrol/compliance-masonry/pkg/lib/common"
+	v2 "github.com/opencontrol/compliance-masonry/pkg/lib/components/versions/2_0_0"
 )
 
 type componentExportTest struct {

commands/docs/gitbook/gitbookSummaries.go → pkg/cli/docs/gitbook/gitbookSummaries.go

@@ -2,7 +2,7 @@ package gitbook
 
 import (
 	"fmt"
-	"github.com/opencontrol/compliance-masonry/lib/common"
+	"github.com/opencontrol/compliance-masonry/pkg/lib/common"
 	"io/ioutil"
 	"path/filepath"
 	"strings"

commands/docs/gitbook/gitbookSummaries_test.go → pkg/cli/docs/gitbook/gitbookSummaries_test.go

@@ -7,7 +7,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/opencontrol/compliance-masonry/lib"
+	"github.com/opencontrol/compliance-masonry/pkg/lib"
 	"github.com/opencontrol/compliance-masonry/tools/fs"
 )
 
@@ -29,10 +29,10 @@ type buildStandardsSummariesTest struct {
 var buildComponentsSummariesTests = []buildComponentsSummariesTest{
 	// Check that the component summary is correctly exported
 	{
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures"),
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml"),
 		"",
-		filepath.Join("..", "..", "..", "fixtures", "exports_fixtures", "gitbook_exports", "components_readme.md"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "exports_fixtures", "gitbook_exports", "components_readme.md"),
 	},
 }
 
@@ -61,11 +61,11 @@ func TestBuildComponentsSummaries(t *testing.T) {
 var buildStandardsSummariesTests = []buildStandardsSummariesTest{
 	// Check that a standards summary is correctly exported
 	{
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures"),
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml"),
 		"",
-		filepath.Join("..", "..", "..", "fixtures", "exports_fixtures", "gitbook_exports", "standards_readme.md"),
-		filepath.Join("..", "..", "..", "fixtures", "exports_fixtures", "gitbook_exports", "standards"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "exports_fixtures", "gitbook_exports", "standards_readme.md"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "exports_fixtures", "gitbook_exports", "standards"),
 	},
 }
 

commands/docs/gitbook/gitbook_test.go → pkg/cli/docs/gitbook/gitbook_test.go

@@ -62,17 +62,17 @@ func TestReplaceParentheses(t *testing.T) {
 var buildGitbookTests = []buildGitbookTest{
 	// Check that the gitbook is correctly exported given the fixtures
 	{
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures"),
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures", "certifications", "LATO.yaml"),
 		"",
-		filepath.Join("..", "..", "..", "fixtures", "exports_fixtures", "complete_export"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "exports_fixtures", "complete_export"),
 	},
 	// Check that the gitbook is correctly exported given the fixtures with markdowns
 	{
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures_with_markdown"),
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures_with_markdown", "certifications", "LATO.yaml"),
-		filepath.Join("..", "..", "..", "fixtures", "opencontrol_fixtures_with_markdown", "markdowns"),
-		filepath.Join("..", "..", "..", "fixtures", "exports_fixtures", "complete_export_with_markdown"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown", "certifications", "LATO.yaml"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "opencontrol_fixtures_with_markdown", "markdowns"),
+		filepath.Join("..", "..", "..", "..", "test", "fixtures", "exports_fixtures", "complete_export_with_markdown"),
 	},
 }