util

Documentation

Index

• Constants
• Variables
• func ConvertPathToURI(path string) lsp.DocumentURI
• func ConvertURItoFilePath(uri lsp.DocumentURI) string
• func Download(url, targetDir, fileName string, silent bool) (string, error)
• func DownloadAndUnzip(downloadLink, tempDir string) (string, error)
• func FindAllNestedDirs(dir string) []string
• func FindConceptFilesIn(dir string) []string
• func GaugeFileExtensions() []string
• func GetConceptsPaths() []string
• func GetFileContents(filepath string) (string, error)
• func GetLineCount(text string) int
• func GetLinesFromText(text string) []string
• func GetPathToFile(path string) string
• func GetSpecDirs() []string
• func IsConcept(path string) bool
• func IsDir(path string) bool
• func IsGaugeFile(path string) bool
• func IsProcessRunning(pid int) bool
• func IsSpec(path string) bool
• func IsValidConceptExtension(path string) bool
• func IsValidSpecExtension(path string) bool
• func IsWindows() bool
• func ListContains(list []string, val string) bool
• func NumberOfCores() int
• func OpenFile(fileName string) (io.Writer, error)
• func RLimit() (int, error)
• func RelPathToProjectRoot(path string) string
• func Remove(dir string)
• func RemoveTempDir()
• func SaveFile(fileName string, content string, backup bool)
• func SetWorkingDir(workingDir string)

Constants

const (
	UnixSep = "/"

	WindowsSep = "\\"
)

Variables

var FindSpecFilesIn = func(dir string) []string {
	return findFilesIn(dir, IsValidSpecExtension, func(path string, f os.FileInfo) bool {
		return false
	})
}

FindSpecFilesIn Finds spec files in the given directory

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.")
	}
	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)
}

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 GetSpecFiles = func(paths []string) []string {
	var specFiles []string
	for _, path := range paths {
		if !common.FileExists(path) {
			exitWithMessage(fmt.Sprintf("Specs directory %s does not exist.", path))
		}
		if common.DirExists(path) {
			specFilesInpath := FindSpecFilesIn(path)
			if len(specFilesInpath) < 1 {
				exitWithMessage(fmt.Sprintf("No specifications found in %s.", path))
			}
			specFiles = append(specFiles, specFilesInpath...)
		} else if IsValidSpecExtension(path) {
			f, _ := filepath.Abs(path)
			specFiles = append(specFiles, f)
		}
	}
	return specFiles
}

GetSpecFiles returns the list of spec files present at the given path. If the path itself represents a spec file, it returns the same.

Functions

func ConvertPathToURI

func ConvertPathToURI(path string) lsp.DocumentURI

ConvertPathToURI - converts OS specific file paths to file uri (eg: file://example.spec).

func ConvertURItoFilePath

func ConvertURItoFilePath(uri lsp.DocumentURI) string

ConvertURItoFilePath - converts file uri (eg: file://example.spec) to OS specific file paths.

func Download

func Download(url, targetDir, fileName string, silent bool) (string, error)

Download fires a HTTP GET request to download a resource to target directory

func DownloadAndUnzip

func DownloadAndUnzip(downloadLink, tempDir string) (string, error)

DownloadAndUnzip downloads the zip file from given download link and unzips it. Returns the unzipped file path.

func FindAllNestedDirs

func FindAllNestedDirs(dir string) []string

FindAllNestedDirs returns list of all nested directories in given path

func FindConceptFilesIn

func FindConceptFilesIn(dir string) []string

FindConceptFilesIn Finds the concept files in specified directory

func GaugeFileExtensions

func GaugeFileExtensions() []string

IsGaugeFile Returns true if spec file or concept file

func GetConceptsPaths

func GetConceptsPaths() []string

GetConceptsPaths returns the concepts directory. It checks whether the environment variable for gauge_concepts_dir is set. It returns an empty list (of directories) otherwise

func GetFileContents

func GetFileContents(filepath string) (string, error)

func GetLineCount

func GetLineCount(text string) int

GetLineCount give no of lines in given text

func GetLinesFromText

func GetLinesFromText(text string) []string

GetLinesFromText gets lines of a text in an array

func GetPathToFile

func GetPathToFile(path string) string

GetPathToFile returns the path to a given file from the Project root

func GetSpecDirs

func GetSpecDirs() []string

GetSpecDirs returns the specification directory. It checks whether the environment variable for gauge_specs_dir is set. It returns 'specs' otherwise

func IsConcept

func IsConcept(path string) bool

IsConcept Returns true if concept file

func IsDir

func IsDir(path string) bool

IsDir reports whether path describes a directory.

func IsGaugeFile

func IsGaugeFile(path string) bool

IsGaugeFile Returns true if spec file or concept file

func IsProcessRunning

func IsProcessRunning(pid int) bool

IsProcessRunning checks if the process with the given process id is still running

func IsSpec

func IsSpec(path string) bool

IsSpec Returns true if spec file file

func IsValidConceptExtension

func IsValidConceptExtension(path string) bool

IsValidConceptExtension Checks if the path has a concept file extension

func IsValidSpecExtension

func IsValidSpecExtension(path string) bool

IsValidSpecExtension Checks if the path has a spec file extension

func IsWindows

func IsWindows() bool

IsWindows returns if Gauge is running on Windows

func ListContains

func ListContains(list []string, val string) bool

func NumberOfCores

func NumberOfCores() int

NumberOfCores returns the number of CPU cores on the system

func OpenFile

func OpenFile(fileName string) (io.Writer, error)

func RLimit

func RLimit() (int, error)

func RelPathToProjectRoot

func RelPathToProjectRoot(path string) string

func Remove

func Remove(dir string)

Remove removes all the files and directories recursively for the given path

func RemoveTempDir

func RemoveTempDir()

RemoveTempDir removes the temp dir

func SaveFile

func SaveFile(fileName string, content string, backup bool)

SaveFile saves contents at the given path

func SetWorkingDir

func SetWorkingDir(workingDir string)

SetWorkingDir sets the current working directory to specified location