├── .semver ├── go.mod ├── pipeline ├── job.go ├── fixtures │ ├── simple-pipeline.yml │ └── complex-pipeline.yml ├── help.go ├── simulator.go ├── printer.go ├── parser_test.go ├── evaluator_test.go ├── evaluator.go └── parser.go ├── CHANGELOG.md ├── .gitignore ├── .github └── workflows │ ├── ci.yml │ └── release.yml ├── Makefile ├── .goreleaser.yaml ├── go.sum ├── main.go ├── CONTRIBUTING.md ├── README.md └── LICENSE /.semver: -------------------------------------------------------------------------------- 1 | 0.2.0 -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module gitlab-pipeline-simulator 2 | 3 | go 1.21.1 4 | 5 | require ( 6 | github.com/Knetic/govaluate v3.0.0+incompatible 7 | github.com/stretchr/testify v1.10.0 8 | gopkg.in/yaml.v3 v3.0.1 9 | ) 10 | 11 | require ( 12 | github.com/davecgh/go-spew v1.1.1 // indirect 13 | github.com/pmezard/go-difflib v1.0.0 // indirect 14 | ) 15 | -------------------------------------------------------------------------------- /pipeline/job.go: -------------------------------------------------------------------------------- 1 | package pipeline 2 | 3 | type Job struct { 4 | Name string 5 | Stage string 6 | Rules []Rule 7 | Scripts []string 8 | } 9 | 10 | type Rule struct { 11 | If string 12 | When string 13 | } 14 | 15 | type JobResult struct { 16 | Name string 17 | Stage string 18 | MatchedRule Rule 19 | MatchedCondition string 20 | Scripts []string 21 | } 22 | -------------------------------------------------------------------------------- /pipeline/fixtures/simple-pipeline.yml: -------------------------------------------------------------------------------- 1 | stages: 2 | - build 3 | - test 4 | 5 | build-job: 6 | stage: build 7 | rules: 8 | - if: $CI_COMMIT_BRANCH == "master" 9 | when: always 10 | script: 11 | - echo "Building" 12 | 13 | test-job: 14 | stage: test 15 | rules: 16 | - if: $CI_PIPELINE_SOURCE == "schedule" 17 | when: never 18 | - if: $CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/ 19 | when: manual -------------------------------------------------------------------------------- /pipeline/fixtures/complex-pipeline.yml: -------------------------------------------------------------------------------- 1 | stages: 2 | - deploy 3 | 4 | deploy-prod: 5 | stage: deploy 6 | rules: 7 | - if: $CI_COMMIT_BRANCH == "master" && $DEPLOY_ENV == "production" 8 | when: always 9 | - if: $CI_COMMIT_TAG =~ /^v\d+-\d+$/ 10 | when: manual 11 | script: 12 | - ./deploy.sh prod 13 | 14 | deploy-staging: 15 | stage: deploy 16 | rules: 17 | - if: $CI_COMMIT_BRANCH =~ /^feature\/.*/ 18 | when: always -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. 4 | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) 6 | and this project adheres to [Semantic Versioning](https://semver.org/). 7 | 8 | ## [0.2.0] - 2025-02-13 9 | ### Added 10 | - Adds -expand-only, -help and -version CLI options 11 | 12 | 13 | ## [0.1.0] - 2025-02-13 14 | ### Added 15 | - Initial version of the GitLab pipeline simulator 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.exe~ 4 | *.dll 5 | *.so 6 | *.dylib 7 | 8 | # Test binary, built with `go test -c` 9 | *.test 10 | 11 | # Output of the go coverage tool, specifically when used with LiteIDE 12 | *.out 13 | 14 | # Dependency directories (remove the comment below to include it) 15 | # vendor/ 16 | 17 | # Go workspace file 18 | go.work 19 | go.work.sum 20 | 21 | # env file 22 | .env 23 | # Added by goreleaser init: 24 | dist/ 25 | 26 | # Binary file 27 | glps -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | types: [opened, synchronize, reopened] 9 | 10 | jobs: 11 | test: 12 | name: Test 13 | runs-on: ubuntu-latest 14 | steps: 15 | - name: Checkout repository 16 | uses: actions/checkout@v4 17 | 18 | - name: Set up Go 19 | uses: actions/setup-go@v5 20 | with: 21 | go-version: 1.21 22 | 23 | - name: Run tests 24 | run: make test -------------------------------------------------------------------------------- /pipeline/help.go: -------------------------------------------------------------------------------- 1 | package pipeline 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | ) 7 | 8 | func CustomUsage() { 9 | fmt.Printf(`Usage: %s [options] [var=value...] 10 | 11 | Options: 12 | -show-scripts Display scripts that will be executed for matching jobs 13 | -expand-only Output expanded YAML configuration without simulation 14 | -version Show version information 15 | -h, -help Show this help message 16 | 17 | Examples: 18 | %s -show-scripts .gitlab-ci.yml CI_COMMIT_BRANCH=master 19 | %s -expand-only complex-pipeline.yml > expanded.yml 20 | `, os.Args[0], os.Args[0], os.Args[0]) 21 | } 22 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | BINARY_NAME = glps 2 | GO_FILES = $(shell find . -type f -name '*.go') 3 | VERSION=$(shell cat .semver | tr -d '[:space:]') 4 | 5 | .PHONY: all build test lint clean run 6 | 7 | all: build 8 | 9 | build: $(GO_FILES) 10 | @echo "Building $(BINARY_NAME) v$(VERSION)" 11 | @go build -o $(BINARY_NAME) -ldflags "-X main.version=$(VERSION)" 12 | 13 | test: 14 | @echo "Running tests..." 15 | @go test -v -coverprofile=coverage.out ./... 16 | 17 | 18 | .PHONY: tag 19 | tag: 20 | @if [ ! -f .semver ]; then \ 21 | echo "Error: .semver file not found!" >&2; \ 22 | exit 1; \ 23 | fi 24 | git tag -a "v$(VERSION)" -m "Release v$(VERSION)" 25 | git push origin "v$(VERSION)" -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | on: 4 | push: 5 | tags: 6 | - '*' 7 | 8 | permissions: 9 | contents: write 10 | 11 | jobs: 12 | release: 13 | name: Build & Release 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Checkout repository 17 | uses: actions/checkout@v4 18 | 19 | - name: Set up Go 20 | uses: actions/setup-go@v5 21 | with: 22 | go-version: 1.21 23 | 24 | - name: Run GoReleaser 25 | uses: goreleaser/goreleaser-action@v6 26 | with: 27 | version: '~> v2' 28 | args: release --clean 29 | env: 30 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 31 | -------------------------------------------------------------------------------- /.goreleaser.yaml: -------------------------------------------------------------------------------- 1 | version: 2 2 | 3 | before: 4 | hooks: 5 | - go mod tidy 6 | 7 | builds: 8 | - env: 9 | - CGO_ENABLED=0 10 | goos: 11 | - linux 12 | - windows 13 | - darwin 14 | binary: glps 15 | 16 | archives: 17 | - formats: binary 18 | name_template: >- 19 | glps_ 20 | {{- title .Os }}_ 21 | {{- if eq .Arch "amd64" }}x86_64 22 | {{- else if eq .Arch "386" }}i386 23 | {{- else }}{{ .Arch }}{{ end }} 24 | {{- if .Arm }}v{{ .Arm }}{{ end }} 25 | 26 | changelog: 27 | sort: asc 28 | filters: 29 | exclude: 30 | - "^docs:" 31 | - "^test:" 32 | 33 | release: 34 | github: 35 | owner: sanchezpaco 36 | name: gitlab-pipeline-simulator 37 | footer: >- 38 | 39 | --- 40 | 41 | Released by [GoReleaser](https://github.com/goreleaser/goreleaser). 42 | -------------------------------------------------------------------------------- /pipeline/simulator.go: -------------------------------------------------------------------------------- 1 | package pipeline 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | ) 7 | 8 | type Simulator struct { 9 | evaluator *Evaluator 10 | showScripts bool 11 | } 12 | 13 | func NewSimulator(env map[string]string, showScripts bool) *Simulator { 14 | return &Simulator{ 15 | evaluator: NewEvaluator(env), 16 | showScripts: showScripts, 17 | } 18 | } 19 | 20 | func (s *Simulator) Run(filePath string) error { 21 | data, err := os.ReadFile(filePath) 22 | if err != nil { 23 | return fmt.Errorf("failed to read file: %w", err) 24 | } 25 | 26 | root := expandYAML(data) 27 | jobs, stageOrder, err := extractJobsAndStages(root) 28 | if err != nil { 29 | return fmt.Errorf("failed to extract jobs and stages: %w", err) 30 | } 31 | 32 | results := s.evaluator.EvaluatePipeline(jobs) 33 | PrintResults(results, stageOrder, s.showScripts) 34 | 35 | return nil 36 | } 37 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/Knetic/govaluate v3.0.0+incompatible h1:7o6+MAPhYTCF0+fdvoz1xDedhRb4f6s9Tn1Tt7/WTEg= 2 | github.com/Knetic/govaluate v3.0.0+incompatible/go.mod h1:r7JcOSlj0wfOMncg0iLm8Leh48TZaKVeNIfJntJ2wa0= 3 | github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= 4 | github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 5 | github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= 6 | github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= 7 | github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= 8 | github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= 9 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= 10 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= 11 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= 12 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= 13 | -------------------------------------------------------------------------------- /pipeline/printer.go: -------------------------------------------------------------------------------- 1 | package pipeline 2 | 3 | import ( 4 | "fmt" 5 | "os" 6 | 7 | "gopkg.in/yaml.v3" 8 | ) 9 | 10 | func PrintResults(results map[string][]JobResult, stageOrder []string, showScripts bool) { 11 | fmt.Println("\n=== Pipeline Simulation Results ===") 12 | fmt.Println("Jobs that would run based on current conditions:") 13 | 14 | for _, stage := range stageOrder { 15 | if jobResults, exists := results[stage]; exists { 16 | fmt.Printf("🚀 Stage: %s\n", stage) 17 | for _, result := range jobResults { 18 | fmt.Printf(" ✅ Job: %s\n", result.Name) 19 | if result.MatchedCondition != "" { 20 | fmt.Printf(" ├─ Condition: %s\n", colorizeCondition(result.MatchedCondition)) 21 | } 22 | if showScripts && len(result.Scripts) > 0 { 23 | fmt.Println(" ├─ Scripts:") 24 | for _, script := range result.Scripts { 25 | fmt.Printf(" │ - %s\n", script) 26 | } 27 | } 28 | fmt.Println() 29 | } 30 | } 31 | } 32 | } 33 | 34 | func PrintExpandedYAML(root *yaml.Node) { 35 | encoder := yaml.NewEncoder(os.Stdout) 36 | encoder.SetIndent(2) 37 | if err := encoder.Encode(root); err != nil { 38 | panic(err) 39 | } 40 | } 41 | 42 | func colorizeCondition(cond string) string { 43 | return fmt.Sprintf("\033[1;36m%s\033[0m", cond) // Cyan 44 | } 45 | -------------------------------------------------------------------------------- /pipeline/parser_test.go: -------------------------------------------------------------------------------- 1 | package pipeline 2 | 3 | import ( 4 | "os" 5 | "path/filepath" 6 | "testing" 7 | 8 | "github.com/stretchr/testify/assert" 9 | "github.com/stretchr/testify/require" 10 | ) 11 | 12 | func TestParser(t *testing.T) { 13 | t.Run("simple_pipeline", func(t *testing.T) { 14 | data := loadFixture(t, "simple-pipeline.yml") 15 | root := expandYAML(data) 16 | jobs, stages, err := extractJobsAndStages(root) 17 | 18 | require.NoError(t, err) 19 | assert.Equal(t, []string{"build", "test"}, stages) 20 | assert.Len(t, jobs, 2) 21 | 22 | buildJob := findJob(jobs, "build-job") 23 | assert.Equal(t, "build", buildJob.Stage) 24 | assert.Len(t, buildJob.Rules, 1) 25 | assert.Equal(t, "echo \"Building\"", buildJob.Scripts[0]) 26 | }) 27 | 28 | t.Run("complex_rules", func(t *testing.T) { 29 | data := loadFixture(t, "complex-pipeline.yml") 30 | root := expandYAML(data) 31 | jobs, stages, err := extractJobsAndStages(root) 32 | 33 | require.NoError(t, err) 34 | assert.Equal(t, []string{"deploy"}, stages) 35 | assert.Len(t, jobs, 2) 36 | 37 | deployProd := findJob(jobs, "deploy-prod") 38 | assert.Len(t, deployProd.Rules, 2) 39 | assert.Equal(t, "./deploy.sh prod", deployProd.Scripts[0]) 40 | }) 41 | } 42 | 43 | func loadFixture(t *testing.T, name string) []byte { 44 | path := filepath.Join("fixtures", name) 45 | data, err := os.ReadFile(path) 46 | require.NoError(t, err) 47 | return data 48 | } 49 | 50 | func findJob(jobs []Job, name string) *Job { 51 | for _, job := range jobs { 52 | if job.Name == name { 53 | return &job 54 | } 55 | } 56 | return nil 57 | } 58 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "gitlab-pipeline-simulator/pipeline" 7 | "log" 8 | "os" 9 | "strings" 10 | ) 11 | 12 | var ( 13 | showScripts bool 14 | expandOnly bool 15 | printVersion bool 16 | version = "dev" // Set during build with ldflags 17 | ) 18 | 19 | func main() { 20 | flag.BoolVar(&showScripts, "show-scripts", false, "Display scripts that will be executed for each job") 21 | flag.BoolVar(&expandOnly, "expand-only", false, "Output expanded YAML configuration without simulation") 22 | flag.BoolVar(&printVersion, "version", false, "Show version information") 23 | flag.Usage = pipeline.CustomUsage 24 | flag.Parse() 25 | 26 | if printVersion { 27 | fmt.Printf("pipeline-simulator version %s\n", version) 28 | os.Exit(0) 29 | } 30 | 31 | if len(flag.Args()) < 1 { 32 | flag.Usage() 33 | os.Exit(1) 34 | } 35 | 36 | filePath := flag.Arg(0) 37 | env := parseEnv(flag.Args()[1:]) 38 | 39 | if expandOnly { 40 | data, err := os.ReadFile(filePath) 41 | if err != nil { 42 | log.Fatal(err) 43 | } 44 | root := pipeline.ExpandYAML(data) 45 | pipeline.PrintExpandedYAML(root) 46 | os.Exit(0) 47 | } 48 | 49 | simulator := pipeline.NewSimulator(env, showScripts) 50 | if err := simulator.Run(filePath); err != nil { 51 | log.Fatalf("Error running pipeline simulation: %v", err) 52 | log.Fatal(err) 53 | } 54 | } 55 | 56 | func parseEnv(args []string) map[string]string { 57 | env := make(map[string]string) 58 | for _, arg := range args { 59 | parts := strings.SplitN(arg, "=", 2) 60 | if len(parts) == 2 { 61 | env[parts[0]] = parts[1] 62 | } 63 | } 64 | return env 65 | } 66 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing Guidelines 2 | 3 | Thank you for considering contributing to this project! 🎉 4 | This project follows **Conventional Commits** and **Semantic Versioning** to maintain a clear and structured commit history. 5 | 6 | --- 7 | 8 | ## 📌 Commit Message Format 9 | Each commit message must follow this structure: 10 | 11 | (): 12 | 13 | [optional body] 14 | 15 | [optional footer(s)] 16 | 17 | ### ✅ Examples: 18 | feat(parser): add support for regex rules 19 | fix(evaluator): prevent nil pointer panic 20 | docs(readme): update installation instructions 21 | 22 | ### 🚀 Allowed Commit Types 23 | | Type | Purpose | 24 | |-----------|---------| 25 | | **feat** | Introduces a new feature | 26 | | **fix** | Fixes a bug | 27 | | **docs** | Documentation updates (e.g., README) | 28 | | **chore** | Maintenance tasks (e.g., CI/CD updates) | 29 | | **refactor** | Code improvements without changing behavior | 30 | | **test** | Adding/updating tests | 31 | 32 | --- 33 | 34 | ## 🏗️ Development Workflow 35 | 36 | 1. **Fork** the repository and create a new branch: 37 | git checkout -b feat/new-feature 38 | 39 | 2. **Make changes & commit** following the **Conventional Commits** format. 40 | 41 | 3. **Push your branch** and **open a Pull Request (PR)**. 42 | 43 | --- 44 | 45 | ## 📜 Versioning Strategy 46 | 47 | This project follows **Semantic Versioning (`MAJOR.MINOR.PATCH`)**: 48 | - **MAJOR** → Breaking changes 🚨 49 | - **MINOR** → New features, backward-compatible ✅ 50 | - **PATCH** → Bug fixes 🐛 51 | 52 | Releases are automated using **GitHub Actions** and the `.semver` file. 53 | 54 | --- 55 | 56 | ## 🔧 Setting Up the Project 57 | 58 | ### 1️⃣ Install Dependencies 59 | Ensure you have **Go installed** (version 1.21+ recommended). 60 | 61 | go mod tidy 62 | 63 | ### 2️⃣ Run Tests 64 | go test ./... 65 | 66 | --- 67 | 68 | ## ✅ Code Style & Formatting 69 | 70 | - Follow **Go best practices** and use ` + "`gofmt`" + ` before committing. 71 | - Keep code **clean and modular**. 72 | 73 | gofmt -w . 74 | 75 | --- 76 | 77 | ## 🎯 Need Help? 78 | If you're unsure about something, feel free to open an **Issue** or **Pull Request**. 79 | I'm happy to help! 🚀 -------------------------------------------------------------------------------- /pipeline/evaluator_test.go: -------------------------------------------------------------------------------- 1 | package pipeline 2 | 3 | import ( 4 | "fmt" 5 | "testing" 6 | 7 | "github.com/stretchr/testify/assert" 8 | ) 9 | 10 | func TestEvaluator(t *testing.T) { 11 | tests := []struct { 12 | name string 13 | env map[string]string 14 | job Job 15 | expected bool 16 | }{ 17 | { 18 | name: "simple_always_rule", 19 | env: map[string]string{"CI_COMMIT_BRANCH": "master"}, 20 | job: Job{ 21 | Rules: []Rule{ 22 | {If: `$CI_COMMIT_BRANCH == "master"`, When: "always"}, 23 | }, 24 | }, 25 | expected: true, 26 | }, 27 | { 28 | name: "regex_match", 29 | env: map[string]string{"CI_COMMIT_TAG": "v1.2.3"}, 30 | job: Job{ 31 | Rules: []Rule{ 32 | {If: `$CI_COMMIT_TAG =~ /^v\d+\.\d+\.\d+$/`, When: "manual"}, 33 | }, 34 | }, 35 | expected: false, // Because when: manual 36 | }, 37 | { 38 | name: "rule_order_precedence", 39 | env: map[string]string{"CI_COMMIT_BRANCH": "master"}, 40 | job: Job{ 41 | Rules: []Rule{ 42 | {If: `$CI_COMMIT_BRANCH == "master"`, When: "never"}, 43 | {If: `$CI_PIPELINE_SOURCE == "schedule"`, When: "always"}, 44 | }, 45 | }, 46 | expected: false, 47 | }, 48 | } 49 | 50 | for _, tt := range tests { 51 | t.Run(tt.name, func(t *testing.T) { 52 | e := NewEvaluator(tt.env) 53 | result, _ := e.shouldRun(tt.job) 54 | assert.Equal(t, tt.expected, result) 55 | }) 56 | } 57 | } 58 | 59 | func TestConditionEvaluation(t *testing.T) { 60 | e := NewEvaluator(map[string]string{ 61 | "CI_COMMIT_BRANCH": "feature/new-auth", 62 | "DEPLOY_ENV": "production", 63 | "CI_COMMIT_TAG": "v2-45", 64 | }) 65 | 66 | tests := []struct { 67 | condition string 68 | expected bool 69 | }{ 70 | {`$DEPLOY_ENV == "production" && $CI_COMMIT_TAG =~ /^v\d+-\d+$/`, true}, 71 | } 72 | 73 | for i, tt := range tests { 74 | t.Run(fmt.Sprintf("case_%d", i), func(t *testing.T) { 75 | // Print transformed condition for debugging 76 | transformed := e.transformCondition(tt.condition) 77 | t.Logf("Transformed condition: %s => %s", tt.condition, transformed) 78 | 79 | result, err := e.evaluateCondition(tt.condition) 80 | assert.NoError(t, err) 81 | assert.Equal(t, tt.expected, result) 82 | }) 83 | } 84 | } 85 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GitLab Pipeline Simulator 🚀 2 | 3 | [![CI Status](https://github.com/sanchezpaco/gitlab-pipeline-simulator/actions/workflows/ci.yml/badge.svg)](https://github.com/sanchezpaco/gitlab-pipeline-simulator/actions/workflows/ci.yml) 4 | [![Go Report Card](https://goreportcard.com/badge/github.com/sanchezpaco/gitlab-pipeline-simulator)](https://goreportcard.com/report/github.com/sanchezpaco/gitlab-pipeline-simulator) 5 | [![Release](https://img.shields.io/github/v/release/sanchezpaco/gitlab-pipeline-simulator)](https://github.com/sanchezpaco/gitlab-pipeline-simulator/releases) 6 | 7 | A powerful CLI tool that predicts which GitLab CI jobs will run under different conditions. Perfect for testing pipeline rules without pushing commits! 8 | 9 | ## Features ✨ 10 | 11 | - **Rules Simulation** - Test `if`/`when` conditions locally 12 | - **YAML Expansion** - Resolve anchors, aliases, and `!reference` 13 | - **Regex Support** - Validate branch/tag patterns (=~ operator) 14 | - **Script Preview** - See what commands would execute 15 | 16 | ## Quick Demo 🎬 17 | 18 | ```bash 19 | # See what would run for a master branch commit 20 | $ ./glps .gitlab-ci.yml CI_COMMIT_BRANCH=master 21 | 22 | 🚀 Stage: build 23 | ✅ Job: build_production 24 | ├─ Condition: $CI_COMMIT_BRANCH == "master" 25 | └─ When: always 26 | 27 | 🚀 Stage: test 28 | ✅ Job: unit_tests 29 | ├─ Condition: $CI_PIPELINE_SOURCE == "push" 30 | └─ When: on_success 31 | ``` 32 | 33 | ## Installation 📦 34 | 35 | ### Binary Downloads 36 | Get pre-built binaries from [Releases page](https://github.com/sanchezpaco/gitlab-pipeline-simulator/releases) 37 | 38 | ### From Source 39 | 40 | ## Releases 41 | 42 | ```bash 43 | git clone https://github.com/sanchezpaco/gitlab-pipeline-simulator 44 | cd gitlab-pipeline-simulator 45 | make build 46 | ``` 47 | 48 | ## Usage Examples 💡 49 | 50 | 1. Simulate Feature Branch Pipeline 51 | 52 | ```bash 53 | ./glps ci.yml CI_COMMIT_BRANCH=feat/new-auth CI_DEBUG_TRACE=true 54 | 55 | 🚀 Stage: quality 56 | ✅ Job: eslint 57 | ├─ Condition: $CI_COMMIT_BRANCH =~ /^feat\/.*/ 58 | └─ When: manual 59 | ✅ Job: unittest 60 | ├─ Condition: $CI_DEBUG_TRACE == "true" 61 | └─ When: always 62 | ``` 63 | 64 | 2. Validate Experimental Tag 65 | 66 | ```bash 67 | ./glps ci.yml CI_COMMIT_TAG=v1.5.0-experimental 68 | 69 | 🚀 Stage: test 70 | ✅ Job: chaos_test 71 | ├─ Condition: $CI_COMMIT_TAG =~ /-experimental$/ 72 | └─ When: manual 73 | ``` 74 | 75 | 76 | ## CLI Options ⚙️ 77 | 78 | | Flag | Description | 79 | |-----------|-----------------------------------| 80 | | `-show-scripts` | Display scripts for matching jobs | 81 | | `-expand-only` | Output expanded YAML without simulating a pipeline | 82 | | `-h -help` | Prints CLI options and examples | 83 | 84 | 85 | ## Current Limitations ⚠️ 86 | Not yet implemented (PRs welcome!): 87 | * `include` statements 88 | * `only/except` rules 89 | * Child/parent pipelines 90 | 91 | ## Development 👩💻 92 | 93 | ```bash 94 | make test # Run all tests 95 | make build # Generates the binary 96 | ``` 97 | 98 | ## Contributing 🤝 99 | Contributions are welcomed! Please check: 100 | 101 | [Contribution guide](CONTRIBUTING.md) 102 | 103 | Star ⭐ the repo if you find this useful! -------------------------------------------------------------------------------- /pipeline/evaluator.go: -------------------------------------------------------------------------------- 1 | package pipeline 2 | 3 | import ( 4 | "fmt" 5 | "regexp" 6 | "strings" 7 | 8 | "github.com/Knetic/govaluate" 9 | ) 10 | 11 | type Evaluator struct { 12 | env map[string]string 13 | } 14 | 15 | func NewEvaluator(env map[string]string) *Evaluator { 16 | return &Evaluator{env: env} 17 | } 18 | 19 | func (e *Evaluator) EvaluatePipeline(jobs []Job) map[string][]JobResult { 20 | results := make(map[string][]JobResult) 21 | 22 | for _, job := range jobs { 23 | shouldRun, matchedRule := e.shouldRun(job) 24 | if shouldRun { 25 | results[job.Stage] = append(results[job.Stage], JobResult{ 26 | Name: job.Name, 27 | Stage: job.Stage, 28 | MatchedRule: matchedRule, 29 | MatchedCondition: matchedRule.If, 30 | Scripts: job.Scripts, 31 | }) 32 | } 33 | } 34 | 35 | return results 36 | } 37 | 38 | func (e *Evaluator) shouldRun(job Job) (bool, Rule) { 39 | if len(job.Rules) == 0 { 40 | return true, Rule{} 41 | } 42 | 43 | for _, rule := range job.Rules { 44 | result, err := e.evaluateCondition(rule.If) 45 | if err != nil || !result { 46 | continue 47 | } 48 | 49 | switch rule.When { 50 | case "always": 51 | return true, rule 52 | case "never": 53 | return false, rule 54 | case "manual": 55 | return false, rule 56 | default: 57 | return true, rule 58 | } 59 | } 60 | 61 | return false, Rule{} 62 | } 63 | 64 | func (e *Evaluator) evaluateCondition(condition string) (bool, error) { 65 | if condition == "" { 66 | return true, nil 67 | } 68 | 69 | transformed := e.transformCondition(condition) 70 | expression, err := govaluate.NewEvaluableExpressionWithFunctions(transformed, e.getFunctions()) 71 | if err != nil { 72 | return false, fmt.Errorf("failed to parse condition: %w", err) 73 | } 74 | 75 | parameters := make(map[string]interface{}) 76 | for k, v := range e.env { 77 | parameters[k] = v 78 | } 79 | 80 | result, err := expression.Evaluate(parameters) 81 | if err != nil { 82 | return false, fmt.Errorf("failed to evaluate condition: %w", err) 83 | } 84 | 85 | return isTruthy(result), nil 86 | } 87 | 88 | func (e *Evaluator) transformCondition(condition string) string { 89 | condition = e.replaceRegexOperators(condition) 90 | condition = e.substituteVariables(condition) 91 | return condition 92 | } 93 | 94 | func (e *Evaluator) replaceRegexOperators(condition string) string { 95 | re := regexp.MustCompile(`(\$\w+)\s*=~\s*/((?:\\/|[^/])+)/`) 96 | return re.ReplaceAllStringFunc(condition, func(match string) string { 97 | parts := re.FindStringSubmatch(match) 98 | if len(parts) != 3 { 99 | return match 100 | } 101 | 102 | varName := parts[1] 103 | // Escape backslashes in the pattern 104 | pattern := strings.ReplaceAll(parts[2], `\`, `\\`) 105 | pattern = strings.ReplaceAll(pattern, `\/`, `/`) 106 | return fmt.Sprintf("matches(%s, \"%s\")", varName, pattern) 107 | }) 108 | } 109 | 110 | func (e *Evaluator) substituteVariables(condition string) string { 111 | re := regexp.MustCompile(`\$(\w+)`) 112 | return re.ReplaceAllStringFunc(condition, func(match string) string { 113 | varName := strings.TrimPrefix(match, "$") 114 | value, exists := e.env[varName] 115 | if !exists { 116 | return `""` 117 | } 118 | return fmt.Sprintf("%q", value) 119 | }) 120 | } 121 | 122 | func (e *Evaluator) getFunctions() map[string]govaluate.ExpressionFunction { 123 | return map[string]govaluate.ExpressionFunction{ 124 | "matches": func(args ...interface{}) (interface{}, error) { 125 | if len(args) != 2 { 126 | return false, fmt.Errorf("matches requires exactly 2 arguments") 127 | } 128 | str := fmt.Sprintf("%v", args[0]) 129 | pattern := fmt.Sprintf("%v", args[1]) 130 | matched, err := regexp.MatchString(pattern, str) 131 | if err != nil { 132 | return false, fmt.Errorf("invalid regex pattern: %w", err) 133 | } 134 | return matched, nil 135 | }, 136 | } 137 | } 138 | 139 | func isTruthy(i interface{}) bool { 140 | if i == nil { 141 | return false 142 | } 143 | 144 | switch v := i.(type) { 145 | case bool: 146 | return v 147 | case string: 148 | return v != "" 149 | case int, int8, int16, int32, int64: 150 | return v != 0 151 | case uint, uint8, uint16, uint32, uint64: 152 | return v != 0 153 | case float32, float64: 154 | return v != 0.0 155 | default: 156 | return true 157 | } 158 | } 159 | -------------------------------------------------------------------------------- /pipeline/parser.go: -------------------------------------------------------------------------------- 1 | package pipeline 2 | 3 | import ( 4 | "fmt" 5 | 6 | "gopkg.in/yaml.v3" 7 | ) 8 | 9 | func ExpandYAML(data []byte) *yaml.Node { 10 | root := expandYAML(data) 11 | return root 12 | } 13 | 14 | func expandYAML(data []byte) *yaml.Node { 15 | var root yaml.Node 16 | if err := yaml.Unmarshal(data, &root); err != nil { 17 | panic(fmt.Errorf("failed to unmarshal YAML: %w", err)) 18 | } 19 | 20 | anchors := make(map[string]*yaml.Node) 21 | collectAnchors(&root, anchors) 22 | resolveAliases(&root, anchors) 23 | processMergeKeys(&root, anchors) 24 | 25 | if len(root.Content) > 0 { 26 | docRoot := root.Content[0] 27 | resolveReferences(docRoot, docRoot) 28 | } 29 | 30 | return &root 31 | } 32 | 33 | func extractJobsAndStages(root *yaml.Node) ([]Job, []string, error) { 34 | var jobs []Job 35 | var stageOrder []string 36 | 37 | if root.Kind != yaml.DocumentNode || len(root.Content) == 0 { 38 | return nil, nil, fmt.Errorf("invalid YAML structure") 39 | } 40 | 41 | content := root.Content[0] 42 | if content.Kind != yaml.MappingNode { 43 | return nil, nil, fmt.Errorf("root node is not a mapping") 44 | } 45 | 46 | // Extract stage order 47 | for i := 0; i < len(content.Content); i += 2 { 48 | key := content.Content[i] 49 | value := content.Content[i+1] 50 | 51 | if key.Value == "stages" && value.Kind == yaml.SequenceNode { 52 | for _, stageNode := range value.Content { 53 | if stageNode.Kind == yaml.ScalarNode { 54 | stageOrder = append(stageOrder, stageNode.Value) 55 | } 56 | } 57 | } 58 | } 59 | 60 | // Extract jobs 61 | for i := 0; i < len(content.Content); i += 2 { 62 | key := content.Content[i] 63 | value := content.Content[i+1] 64 | 65 | if key.Kind == yaml.ScalarNode && key.Value != "stages" && value.Kind == yaml.MappingNode { 66 | job := Job{Name: key.Value} 67 | for j := 0; j < len(value.Content); j += 2 { 68 | attrKey := value.Content[j] 69 | attrValue := value.Content[j+1] 70 | 71 | switch attrKey.Value { 72 | case "stage": 73 | if attrValue.Kind == yaml.ScalarNode { 74 | job.Stage = attrValue.Value 75 | } 76 | case "rules": 77 | if attrValue.Kind == yaml.SequenceNode { 78 | for _, ruleNode := range attrValue.Content { 79 | if ruleNode.Kind == yaml.MappingNode { 80 | rule := Rule{} 81 | for k := 0; k < len(ruleNode.Content); k += 2 { 82 | ruleKey := ruleNode.Content[k] 83 | ruleValue := ruleNode.Content[k+1] 84 | 85 | switch ruleKey.Value { 86 | case "if": 87 | if ruleValue.Kind == yaml.ScalarNode { 88 | rule.If = ruleValue.Value 89 | } 90 | case "when": 91 | if ruleValue.Kind == yaml.ScalarNode { 92 | rule.When = ruleValue.Value 93 | } 94 | } 95 | } 96 | job.Rules = append(job.Rules, rule) 97 | } 98 | } 99 | } 100 | case "script": 101 | if attrValue.Kind == yaml.SequenceNode { 102 | for _, scriptNode := range attrValue.Content { 103 | if scriptNode.Kind == yaml.ScalarNode { 104 | job.Scripts = append(job.Scripts, scriptNode.Value) 105 | } 106 | } 107 | } 108 | } 109 | } 110 | jobs = append(jobs, job) 111 | } 112 | } 113 | 114 | return jobs, stageOrder, nil 115 | } 116 | 117 | func collectAnchors(node *yaml.Node, anchors map[string]*yaml.Node) { 118 | if node == nil { 119 | return 120 | } 121 | 122 | if node.Anchor != "" { 123 | anchors[node.Anchor] = node 124 | } 125 | 126 | for _, child := range node.Content { 127 | collectAnchors(child, anchors) 128 | } 129 | } 130 | 131 | func resolveAliases(node *yaml.Node, anchors map[string]*yaml.Node) { 132 | if node == nil { 133 | return 134 | } 135 | 136 | if node.Kind == yaml.AliasNode { 137 | if anchored, ok := anchors[node.Alias.Anchor]; ok { 138 | *node = *anchored 139 | } 140 | } 141 | 142 | for _, child := range node.Content { 143 | resolveAliases(child, anchors) 144 | } 145 | } 146 | 147 | func processMergeKeys(node *yaml.Node, anchors map[string]*yaml.Node) { 148 | if node.Kind != yaml.MappingNode { 149 | for _, child := range node.Content { 150 | processMergeKeys(child, anchors) 151 | } 152 | return 153 | } 154 | 155 | var newContent []*yaml.Node 156 | var merges []*yaml.Node 157 | 158 | for i := 0; i < len(node.Content); i += 2 { 159 | key := node.Content[i] 160 | value := node.Content[i+1] 161 | 162 | if key.Value == "<<" { 163 | merges = append(merges, getMergeSources(value, anchors)...) 164 | } else { 165 | newContent = append(newContent, key, value) 166 | } 167 | } 168 | 169 | for _, merge := range merges { 170 | if merge.Kind != yaml.MappingNode { 171 | continue 172 | } 173 | newContent = append(merge.Content, newContent...) 174 | } 175 | 176 | node.Content = newContent 177 | 178 | for _, child := range node.Content { 179 | processMergeKeys(child, anchors) 180 | } 181 | } 182 | 183 | func getMergeSources(node *yaml.Node, anchors map[string]*yaml.Node) []*yaml.Node { 184 | var sources []*yaml.Node 185 | 186 | if node.Kind == yaml.SequenceNode { 187 | for _, item := range node.Content { 188 | resolveAliases(item, anchors) 189 | sources = append(sources, item) 190 | } 191 | } else { 192 | resolveAliases(node, anchors) 193 | sources = append(sources, node) 194 | } 195 | 196 | return sources 197 | } 198 | 199 | func resolveReferences(node *yaml.Node, root *yaml.Node) { 200 | if node == nil { 201 | return 202 | } 203 | 204 | if node.Tag == "!reference" { 205 | if path := parseReferencePath(node); len(path) > 0 { 206 | if referenced, err := findReferencedNode(root, path); err == nil { 207 | *node = *referenced 208 | } 209 | } 210 | } 211 | 212 | for _, child := range node.Content { 213 | resolveReferences(child, root) 214 | } 215 | } 216 | 217 | func parseReferencePath(node *yaml.Node) []string { 218 | var path []string 219 | 220 | if node.Kind == yaml.SequenceNode { 221 | for _, item := range node.Content { 222 | if item.Kind == yaml.ScalarNode { 223 | path = append(path, item.Value) 224 | } 225 | } 226 | } 227 | 228 | return path 229 | } 230 | 231 | func findReferencedNode(root *yaml.Node, path []string) (*yaml.Node, error) { 232 | current := root 233 | 234 | for _, component := range path { 235 | if current.Kind != yaml.MappingNode { 236 | return nil, fmt.Errorf("nodo no es un mapping en el componente: %s", component) 237 | } 238 | 239 | found := false 240 | for i := 0; i < len(current.Content); i += 2 { 241 | key := current.Content[i] 242 | if key.Value == component { 243 | current = current.Content[i+1] 244 | found = true 245 | break 246 | } 247 | } 248 | 249 | if !found { 250 | return nil, fmt.Errorf("componente no encontrado: %s", component) 251 | } 252 | } 253 | 254 | return current, nil 255 | } 256 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------