Function SetCoveragePath

utils/utils.go:778–817

SetCoveragePath takes a goCovPath and sets the coverage path accordingly. It returns an error if the path is a file or if the path does not exist.

(logger *zap.Logger, goCovPath string)

// SetCoveragePath takes a goCovPath and sets the coverage path accordingly.
// It returns an error if the path is a file or if the path does not exist.
func SetCoveragePath(logger *zap.Logger, goCovPath string) (string, error) {
	if goCovPath == "" {
		// Calculate the current path and create a coverage-reports directory
		currentPath, err := GetAbsPath("")
		if err != nil {
			LogError(logger, err, "failed to get the current working directory")
			return "", err
		}
		goCovPath = currentPath + "/coverage-reports"
		if err := makeDirectory(goCovPath); err != nil {
			LogError(logger, err, "failed to create coverage-reports directory", zap.String("CoverageReportPath", goCovPath))
			return "", err
		}
		return goCovPath, nil
	}

	goCovPath, err := GetAbsPath(goCovPath)
	if err != nil {
		LogError(logger, err, "failed to get the absolute path for the coverage report path", zap.String("CoverageReportPath", goCovPath))
		return "", err
	}
	// Check if the path is a directory
	dirInfo, err := os.Stat(goCovPath)
	if err != nil {
		if os.IsNotExist(err) {
			LogError(logger, err, "the provided path does not exist", zap.String("CoverageReportPath", goCovPath))
			return "", err
		}
		LogError(logger, err, "failed to check the coverage report path", zap.String("CoverageReportPath", goCovPath))
		return "", err
	}
	if !dirInfo.IsDir() {
		msg := "the coverage report path is not a directory. Please provide a valid path to a directory for go coverage reports"

		LogError(logger, nil, msg, zap.String("CoverageReportPath", goCovPath))
		return "", errors.New("the path provided is not a directory")
	}

	return goCovPath, nil
}

type ErrType string