Adds gauge_concepts_dir for defining concepts directory (#2379)

.github/workflows/tests.yml

@@ -63,7 +63,7 @@ jobs:
       - name: Install Gauge (windows)
         if: matrix.os == 'windows-latest'
         run: |
-          go run build/make.go --install  --verbose
+          go run build/make.go --install --verbose
           echo "C:\\Program Files\\gauge\\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
 
       - name: Install Gauge (linux)
@@ -123,7 +123,7 @@ jobs:
       - name: Install Gauge (windows)
         if: matrix.os == 'windows-latest'
         run: |
-          go run build/make.go --install  --verbose
+          go run build/make.go --install --verbose
           echo "C:\\Program Files\\gauge\\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
 
       - name: Install Gauge (linux)

CONTRIBUTING.md

@@ -84,7 +84,7 @@ If you are trying to write plugins for Gauge or trying to contribute to Gauge co
 Ex:
 ```diff
  // CurrentGaugeVersion represents the current version of Gauge
--var CurrentGaugeVersion = &Version{1, 0, 7}
-+var CurrentGaugeVersion = &Version{1, 0, 8}
+-var CurrentGaugeVersion = &Version{1, 5, 0}
++var CurrentGaugeVersion = &Version{1, 5, 1}
 
 ```

env/env.go

@@ -25,6 +25,8 @@ import (
 const (
 	// SpecsDir holds the location of spec files
 	SpecsDir = "gauge_specs_dir"
+	// ConceptsDir holds the location of concept files
+	ConceptsDir = "gauge_concepts_dir"
 	// GaugeReportsDir holds the location of reports
 	GaugeReportsDir = "gauge_reports_dir"
 	// GaugeEnvironment holds the name of the current environment

util/_testdata/proj1/env/multipleSpecs/multipleSpecs.properties

@@ -1 +1,2 @@
-gauge_specs_dir=spec1, spec2,    spec3
+gauge_specs_dir=spec1, spec2,    spec3
+gauge_concepts_dir=dir1, dir2,    dir3

util/fileUtils.go

@@ -147,12 +147,13 @@ func IsDir(path string) bool {
 	return fileInfo.IsDir()
 }
 
-// GetSpecFiles returns the list of spec files present at the given path.
-// If the path itself represents a spec file, it returns the same.
 var exitWithMessage = func(message string) {
 	logger.Errorf(true, message)
 	os.Exit(1)
 }
+
+// GetSpecFiles returns the list of spec files present at the given path.
+// If the path itself represents a spec file, it returns the same.
 var GetSpecFiles = func(paths []string) []string {
 	var specFiles []string
 	for _, path := range paths {
@@ -173,28 +174,43 @@ var GetSpecFiles = func(paths []string) []string {
 	return specFiles
 }
 
-// GetConceptFiles returns the list of concept files present in the PROJECTROOT
+func findConceptFiles(paths []string) []string {
+	var conceptFiles []string
+	for _, path := range paths {
+		var conceptPath = strings.TrimSpace(path)
+		if !filepath.IsAbs(conceptPath) {
+			conceptPath = filepath.Join(config.ProjectRoot, conceptPath)
+		}
+		absPath, err := filepath.Abs(conceptPath)
+		if err != nil {
+			logger.Fatalf(true, "Error getting absolute concept path. %v", err)
+		}
+		if !common.FileExists(absPath) {
+			exitWithMessage(fmt.Sprintf("No such file or diretory: %s", absPath))
+		}
+		conceptFiles = append(conceptFiles, FindConceptFilesIn(absPath)...)
+	}
+	return conceptFiles
+}
+
+// GetConceptFiles It returns the list of concept files
+// It returns concept files from gauge_concepts_dir if present
+// It returns concept files from projectRoot otherwise
 var GetConceptFiles = func() []string {
+	conceptPaths := GetConceptsPaths()
+	if len(conceptPaths) > 0 {
+		return removeDuplicateValues(findConceptFiles(conceptPaths))
+	}
 	projRoot := config.ProjectRoot
 	if projRoot == "" {
 		logger.Fatalf(true, "Failed to get project root.")
 	}
-	absPath, err := filepath.Abs(projRoot)
-	if err != nil {
-		logger.Fatalf(true, "Error getting absolute path. %v", err)
-	}
-	files := FindConceptFilesIn(absPath)
-	var specFromProperties = os.Getenv(env.SpecsDir)
-	if specFromProperties == "" {
-		return files
-	}
-	var specDirectories = strings.Split(specFromProperties, ",")
-	for _, dir := range specDirectories {
-		absSpecPath, err := filepath.Abs(strings.TrimSpace(dir))
-		if err != nil {
-			logger.Fatalf(true, "Error getting absolute path. %v", err)
-		}
-		files = append(files, FindConceptFilesIn(absSpecPath)...)
+	absProjRoot, _ := filepath.Abs(projRoot)
+	files := findConceptFiles([]string{absProjRoot})
+	specDirFromProperties := os.Getenv(env.SpecsDir)
+	if specDirFromProperties != "" {
+		specDirectories := strings.Split(specDirFromProperties, ",")
+		files = append(files, findConceptFiles(specDirectories)...)
 	}
 	return removeDuplicateValues(files)
 }
@@ -230,7 +246,7 @@ func GetPathToFile(path string) string {
 	}
 
 	gaugeDataDir := env.GaugeDataDir()
-	if gaugeDataDir != "." && filepath.IsAbs((env.GaugeDataDir())) {
+	if gaugeDataDir != "." && filepath.IsAbs(env.GaugeDataDir()) {
 		logger.Warningf(true, "'gauge_data_dir' property must be relative to Project Root. Found absolute path: %s", gaugeDataDir)
 	}
 

util/fileUtils_test.go

@@ -147,6 +147,7 @@ func (s *MySuite) TestFindAllConceptFilesInNestedDir(c *C) {
 }
 
 func (s *MySuite) TestGetConceptFiles(c *C) {
+	os.Clearenv()
 	config.ProjectRoot = "_testdata"
 	specsDir, _ := filepath.Abs(filepath.Join("_testdata", "specs"))
 
@@ -164,17 +165,42 @@ func (s *MySuite) TestGetConceptFiles(c *C) {
 }
 
 func (s *MySuite) TestGetConceptFilesWhenSpecDirIsOutsideProjectRoot(c *C) {
+	os.Clearenv()
 	config.ProjectRoot = "_testdata"
-	os.Setenv(env.SpecsDir, "_testSpecDir")
+	os.Setenv(env.SpecsDir, "../_testSpecDir")
 	c.Assert(len(GetConceptFiles()), Equals, 3)
 }
 
 func (s *MySuite) TestGetConceptFilesWhenSpecDirIsWithInProject(c *C) {
+	os.Clearenv()
 	config.ProjectRoot = "_testdata"
 	os.Setenv(env.SpecsDir, "_testdata/specs")
 	c.Assert(len(GetConceptFiles()), Equals, 2)
 }
 
+func (s *MySuite) TestGetConceptFilesWhenConceptsDirSet(c *C) {
+	os.Clearenv()
+	config.ProjectRoot = "_testdata"
+	c.Assert(len(GetConceptFiles()), Equals, 2)
+
+	os.Setenv(env.ConceptsDir, filepath.Join("specs", "concept1.cpt"))
+	c.Assert(len(GetConceptFiles()), Equals, 1)
+
+	os.Setenv(env.ConceptsDir, filepath.Join("specs", "subdir"))
+	c.Assert(len(GetConceptFiles()), Equals, 1)
+
+	conceptPath, _ := filepath.Abs(filepath.Join("_testdata", "specs", "subdir", "concept2.cpt"))
+	os.Setenv(env.ConceptsDir, conceptPath)
+	c.Assert(len(GetConceptFiles()), Equals, 1)
+}
+
+func (s *MySuite) TestGetConceptFilesWhenConceptDirIsOutsideProjectRoot(c *C) {
+	os.Clearenv()
+	config.ProjectRoot = "_testdata"
+	os.Setenv(env.ConceptsDir, "../_testSpecDir,../_testdata/specs")
+	c.Assert(len(GetConceptFiles()), Equals, 3)
+}
+
 func (s *MySuite) TestFindAllNestedDirs(c *C) {
 	nested1 := filepath.Join(dir, "nested")
 	nested2 := filepath.Join(dir, "nested2")
@@ -261,6 +287,25 @@ func (s *MySuite) TestGetSpecFilesWhenSpecsDirDoesNotExists(c *C) {
 	c.Assert(expectedErrorMessage, Equals, "Specs directory dir1 does not exist.")
 }
 
+func (s *MySuite) TestGetConceptFilesWhenConceptsDirDoesNotExists(c *C) {
+	os.Clearenv()
+	var expectedErrorMessage string
+	exitWithMessage = func(message string) {
+		expectedErrorMessage = message
+	}
+	config.ProjectRoot = "_testdata"
+
+	os.Setenv(env.SpecsDir, "specs2")
+	GetConceptFiles()
+	directory, _ := filepath.Abs(filepath.Join(config.ProjectRoot, "specs2"))
+	c.Assert(expectedErrorMessage, Equals, fmt.Sprintf("No such file or diretory: %s", directory))
+
+	os.Setenv(env.SpecsDir, "_testSpecsDir,non-exisitng")
+	GetConceptFiles()
+	directory, _ = filepath.Abs(filepath.Join(config.ProjectRoot, "non-exisitng"))
+	c.Assert(expectedErrorMessage, Equals, fmt.Sprintf("No such file or diretory: %s", directory))
+}
+
 func (s *MySuite) TestGetSpecFilesWhenSpecsDirIsEmpty(c *C) {
 	var expectedErrorMessage string
 	exitWithMessage = func(message string) {

util/util.go

@@ -110,6 +110,21 @@ func GetSpecDirs() []string {
 	return []string{common.SpecsDirectoryName}
 }
 
+// GetConceptsPaths returns the concepts directory.
+// It checks whether the environment variable for gauge_concepts_dir is set.
+// It returns specs directories otherwise
+func GetConceptsPaths() []string {
+	var conceptDirs []string
+	var conceptsDirFromProperties = os.Getenv(env.ConceptsDir)
+	if conceptsDirFromProperties != "" {
+		conceptDirs = strings.Split(conceptsDirFromProperties, ",")
+		for index, ele := range conceptDirs {
+			conceptDirs[index] = strings.TrimSpace(ele)
+		}
+	}
+	return conceptDirs
+}
+
 func ListContains(list []string, val string) bool {
 	for _, s := range list {
 		if s == val {

util/util_test.go

@@ -16,3 +16,13 @@ func (s *MySuite) TestSpecDirEnvVariableAllowsCommaSeparatedList(c *C) {
 	c.Assert(e, Equals, nil)
 	c.Assert(GetSpecDirs(), DeepEquals, []string{"spec1", "spec2", "spec3"})
 }
+
+func (s *MySuite) TestConceptsDirEnvVariableAllowsCommaSeparatedList(c *C) {
+	c.Skip("This is causing the net/httptest panic in util/httpUtils_test.go fail on windows.")
+	os.Clearenv()
+	config.ProjectRoot = "_testdata/proj1"
+
+	e := env.LoadEnv("multipleSpecs", nil)
+	c.Assert(e, Equals, nil)
+	c.Assert(GetConceptsPaths(), DeepEquals, []string{"dir1", "dir2", "dir3"})
+}

version/version.go

@@ -14,7 +14,7 @@ import (
 )
 
 // CurrentGaugeVersion represents the current version of Gauge
-var CurrentGaugeVersion = &Version{1, 5, 1}
+var CurrentGaugeVersion = &Version{1, 5, 2}
 
 // BuildMetadata represents build information of current release (e.g, nightly build information)
 var BuildMetadata = ""