Function GetOSesForJob

checks/fileparser/github_workflow.go:173–222

GetOSesForJob returns the OSes this job runs on.

(job *actionlint.Job)

// GetOSesForJob returns the OSes this job runs on.
func GetOSesForJob(job *actionlint.Job) ([]string, error) {
	// The 'runs-on' field either lists the OS'es directly, or it can have an expression '${{ matrix.os }}' which
	// is where the OS'es are actually listed.
	jobOSes := make([]string, 0)
	jobRunsOnLabels := getJobRunsOnLabels(job)
	getFromMatrix := len(jobRunsOnLabels) == 1 && strings.Contains(jobRunsOnLabels[0].Value, matrixos)
	if !getFromMatrix {
		// We can get the OSes straight from 'runs-on'.
		for _, os := range jobRunsOnLabels {
			jobOSes = append(jobOSes, os.Value)
		}
		return jobOSes, nil
	}

	jobStrategyMatrixRows := getJobStrategyMatrixRows(job)
	for rowKey, rowValue := range jobStrategyMatrixRows {
		if rowKey != os {
			continue
		}
		for _, os := range rowValue.Values {
			jobOSes = append(jobOSes, strings.Trim(os.String(), "'\""))
		}
	}

	matrixCombinations := getJobStrategyMatrixIncludeCombinations(job)
	for _, combination := range matrixCombinations {
		if combination.Assigns == nil {
			continue
		}
		for _, assign := range combination.Assigns {
			if assign.Key == nil || assign.Key.Value != os || assign.Value == nil {
				continue
			}
			jobOSes = append(jobOSes, strings.Trim(assign.Value.String(), "'\""))
		}
	}

	if len(jobOSes) == 0 {
		// This error is caught by the caller, which is responsible for adding more
		// precise location information
		jobName := GetJobName(job)
		return jobOSes, &checker.ElementError{
			Location: finding.Location{
				Snippet: &jobName,
			},
			Err: sce.ErrJobOSParsing,
		}
	}
	return jobOSes, nil
}

// JobAlwaysRunsOnWindows returns true if the only OS that this job runs on is Windows.
func JobAlwaysRunsOnWindows(job *actionlint.Job) (bool, error) {