├── .gitignore
├── .gitlab-ci.yml
├── .go-version
├── .golangci.yml
├── .goreleaser.yml
├── .pre-commit-hooks.yaml
├── CHANGELOG.md
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── ci
    ├── build-docker-image
    │   ├── Dockerfile
    │   └── README.md
    ├── make-godoc.sh
    └── update-gitlab-release.sh
├── cmd_check.go
├── cmd_install.go
├── cmd_uninstall.go
├── config
    ├── config.go
    └── config_test.go
├── doc.go
├── doc
    ├── pages
    │   ├── index.html
    │   └── style.css
    ├── screen-hook-ko.png
    ├── screen-standalone-ko.png
    └── screen-standalone-ok.png
├── git.go
├── git_test.go
├── gitlab.go
├── go.mod
├── go.sum
├── hooks.go
├── main.go
└── netrc.go


/.gitignore:
--------------------------------------------------------------------------------
 1 | # don't commit binaries
 2 | /.idea
 3 | /gitlab-ci-linter
 4 | /vendor/
 5 | /lint-gitlab-ci
 6 | .build/
 7 | _build/
 8 | *.exe
 9 | /.idea/workspace.xml
10 | /bin/


--------------------------------------------------------------------------------
/.gitlab-ci.yml:
--------------------------------------------------------------------------------
  1 | # yaml-language-server: $schema=https://gitlab.com/gitlab-org/gitlab/-/raw/master/app/assets/javascripts/editor/schema/ci.json
  2 | 
  3 | stages:
  4 |   - checks
  5 |   - build
  6 | 
  7 | variables:
  8 |   CGO_ENABLED: 0
  9 |   COVERAGEREPORTDIR: "_build/coverage"
 10 | 
 11 | default:
 12 |   image: golang:1.24
 13 | 
 14 | ## -- Check stage -------------------------------------------------------------
 15 | 
 16 | lint:
 17 |   stage: checks
 18 |   script:
 19 |     - go tool golangci-lint run
 20 | 
 21 | govulncheck:
 22 |   stage: checks
 23 |   script:
 24 |     - go mod tidy
 25 |     - go tool govulncheck -show color ./...
 26 | 
 27 | # A test job template, to make different test jobs by branch/tags
 28 | .go test: &_go_test_template
 29 |   stage: checks
 30 |   variables:
 31 |     GOTESTFLAGS: -v
 32 |   script:
 33 |     - mkdir -p $COVERAGEREPORTDIR
 34 |     - go test -cover --covermode=atomic --coverprofile=$COVERAGEREPORTDIR/main.cover ./...
 35 |     - go tool cover -func $COVERAGEREPORTDIR/main.cover
 36 |     - go tool cover -html $COVERAGEREPORTDIR/main.cover -o $COVERAGEREPORTDIR/main.html
 37 |   coverage: /^total:\s*\(statements\)\s*(\d+.\d+)\%/
 38 | 
 39 | # Coverage on branches are only kept for 1 week
 40 | go test:
 41 |   <<: *_go_test_template
 42 |   only:
 43 |     - branches
 44 |   artifacts:
 45 |     paths:
 46 |       - $COVERAGEREPORTDIR/
 47 |     expire_in: 1 week
 48 | 
 49 | # Coverage results on tags are kept much longer (1 year)
 50 | go test release:
 51 |   <<: *_go_test_template
 52 |   only:
 53 |     - tags
 54 |   artifacts:
 55 |     paths:
 56 |       - $COVERAGEREPORTDIR/
 57 |     expire_in: 1 year
 58 | 
 59 | ## -- Build stage -------------------------------------------------------------
 60 | 
 61 | dev build:
 62 |   stage: build
 63 |   image:
 64 |     name: goreleaser/goreleaser
 65 |     entrypoint: [""]
 66 |   services:
 67 |     - docker:dind
 68 |   variables:
 69 |     DOCKER_DRIVER: overlay2
 70 |     DOCKER_TLS_CERTDIR: ""
 71 |     DOCKER_HOST: tcp://docker:2375
 72 |   rules:
 73 |     - if: $CI_COMMIT_BRANCH
 74 |   before_script:
 75 |     - apk add --update docker-cli
 76 |   script:
 77 |     - goreleaser release --clean --snapshot --skip=publish
 78 |   artifacts:
 79 |     paths:
 80 |       - .build/dist/
 81 |     expire_in: 1 week
 82 | 
 83 | release:
 84 |   stage: build
 85 |   image:
 86 |     name: goreleaser/goreleaser
 87 |     entrypoint: [""]
 88 |   services:
 89 |     - docker:dind
 90 |   variables:
 91 |     DOCKER_DRIVER: overlay2
 92 |     DOCKER_TLS_CERTDIR: ""
 93 |     DOCKER_HOST: tcp://docker:2375
 94 |     # Disable shallow cloning so that goreleaser can diff between tags to
 95 |     # generate a changelog.
 96 |     GIT_DEPTH: 0
 97 |   rules:
 98 |     - if: $CI_COMMIT_TAG && '$CI_COMMIT_TAG =~ /^v\d+.\d+.\d+$/'
 99 |   before_script:
100 |     - apk add --update py3-pip jq docker-cli
101 |     - pip install --upgrade --break-system-packages cloudsmith-cli
102 |     - echo "$DOCKER_HUB_TOKEN" | docker login --username $DOCKER_HUB_USER --password-stdin
103 |   script:
104 |     - goreleaser release --clean
105 |     # Uploading RAW artifacts on cloudsmith is done sequentially outside Goreleaser, as it seems there is some bug
106 |     # when goreleaser do it in parallel mode (only for raw artifact, no issue with linux packages
107 |     - test -f .build/dist/metadata.json
108 |     - test -f .build/dist/artifacts.json
109 |     - export VERSION="$(cat .build/dist/metadata.json | jq -r '.version')"
110 |     - |
111 |       cat .build/dist/artifacts.json | jq -r '[.[] | select((.type == "Binary") and (.extra.ID=="gitlab-ci-linter"))] | sort_by(.goos, .goarch) | .[] | [.goos, .goarch, .path] | @tsv' | while read GOOS GOARCH ARTIFACT_PATH
112 |       do
113 |         echo "-> Uploading artifact $ARTIFACT_PATH $VERSION for ${GOOS}/${GOARCH}"
114 |         cloudsmith push raw --republish --version "$VERSION" --name "gitlab-ci-linter_${GOOS}_${GOARCH}" --tags "${GOOS},${GOARCH}" orobardet/gitlab-ci-linter "$ARTIFACT_PATH" || exit 1
115 |       done
116 | 


--------------------------------------------------------------------------------
/.go-version:
--------------------------------------------------------------------------------
1 | 1.24.1
2 | 


--------------------------------------------------------------------------------
/.golangci.yml:
--------------------------------------------------------------------------------
 1 | version: "2"
 2 | 
 3 | run:
 4 |   tests: false
 5 | 
 6 | formatters:
 7 |   enable:
 8 |     - gofmt
 9 |     - goimports
10 |   settings:
11 |     gofmt:
12 |       simplify: true
13 |       rewrite-rules:
14 |         - pattern: interface{}
15 |           replacement: any
16 |   exclusions:
17 |     generated: lax
18 |     paths:
19 |       - third_party$
20 |       - builtin$
21 |       - examples$
22 | 
23 | linters:
24 |   default: none
25 |   enable:
26 |     - bodyclose
27 |     - errcheck
28 |     - errname
29 |     - gocyclo
30 |     - gosec
31 |     - govet
32 |     - ineffassign
33 |     - predeclared
34 |     - revive
35 |     - staticcheck
36 |     - unused
37 |   settings:
38 |     gocyclo:
39 |       min-complexity: 15
40 |   exclusions:
41 |     generated: lax
42 |     presets:
43 |       - comments
44 |       - common-false-positives
45 |       - legacy
46 |       - std-error-handling
47 |     paths:
48 |       - third_party$
49 |       - builtin$
50 |       - examples$
51 | 
52 | issues:
53 |   max-issues-per-linter: 0
54 |   max-same-issues: 0
55 | 


--------------------------------------------------------------------------------
/.goreleaser.yml:
--------------------------------------------------------------------------------
  1 | # yaml-language-server: $schema=https://goreleaser.com/static/schema.json
  2 | version: 2
  3 | project_name: gitlab-ci-linter
  4 | dist: .build/dist
  5 | env:
  6 |   - CGO_ENABLED=0
  7 |   - MAIN_PACKAGE_PATH=gitlab.com/orobardet/gitlab-ci-linter/
  8 |   - CI={{ if index .Env "CI"  }}{{.Env.CI}}{{ else }}{{ end }}
  9 | before:
 10 |   hooks:
 11 |     - go mod tidy
 12 | builds:
 13 |   - id: gitlab-ci-linter
 14 |     binary: gitlab-ci-linter
 15 |     goos:
 16 |       - linux
 17 |       - windows
 18 |       - darwin
 19 |     goarch:
 20 |       - 386
 21 |       - amd64
 22 |       - arm
 23 |       - arm64
 24 |     ignore:
 25 |       - goos: windows
 26 |         goarch: arm
 27 |       - goos: darwin
 28 |         goarch: 386
 29 |       - goos: darwin
 30 |         goarch: arm
 31 |     flags:
 32 |       - -trimpath
 33 |     ldflags:
 34 |       - -s -w -X {{.Env.MAIN_PACKAGE_PATH}}config.VERSION={{.Version}} -X {{.Env.MAIN_PACKAGE_PATH}}config.REVISION={{.FullCommit}} -X {{.Env.MAIN_PACKAGE_PATH}}config.BUILDTIME={{ time "2006-01-02T15:04:05-0700" }}
 35 | archives:
 36 |   - id: binaries-gitlab-ci-linter
 37 |     ids:
 38 |       - gitlab-ci-linter
 39 |     formats:
 40 |       - binary
 41 | nfpms:
 42 |   - id: debian-gitlab-ci-linter
 43 |     package_name: gitlab-ci-linter
 44 |     ids:
 45 |       - gitlab-ci-linter
 46 |     formats:
 47 |       - deb
 48 |     vendor: Olivier Robardet
 49 |     maintainer: Olivier Robardet
 50 |     homepage: https://gitlab.com/orobardet/gitlab-ci-linter
 51 |     description: .gitlab-ci.yml linter, using online Gitlab lint API (gitlab.com or self-hosted)
 52 |     license: MIT
 53 |     deb:
 54 |       lintian_overrides:
 55 |         - statically-linked-binary
 56 |         - changelog-file-missing-in-native-package
 57 |         - extended-description-is-empty
 58 |         - no-copyright-file
 59 |         - no-manual-page
 60 |         - unknown-section
 61 |   - id: rpm-gitlab-ci-linter
 62 |     package_name: gitlab-ci-linter
 63 |     ids:
 64 |       - gitlab-ci-linter
 65 |     formats:
 66 |       - rpm
 67 |     vendor: Olivier Robardet
 68 |     maintainer: Olivier Robardet
 69 |     homepage: https://gitlab.com/orobardet/gitlab-ci-linter
 70 |     description: .gitlab-ci.yml linter, using online Gitlab lint API (gitlab.com or self-hosted)
 71 |   - id: apk-gitlab-ci-linter
 72 |     package_name: gitlab-ci-linter
 73 |     ids:
 74 |       - gitlab-ci-linter
 75 |     formats:
 76 |       - apk
 77 |     vendor: Olivier Robardet
 78 |     maintainer: Olivier Robardet
 79 |     homepage: https://gitlab.com/orobardet/gitlab-ci-linter
 80 |     description: .gitlab-ci.yml linter, using online Gitlab lint API (gitlab.com or self-hosted)
 81 | dockers:
 82 |   - image_templates:
 83 |       - "orobardet/gitlab-ci-linter:latest"
 84 |       - "orobardet/gitlab-ci-linter:{{ .Version }}"
 85 |       - "orobardet/gitlab-ci-linter:{{ .Major }}"
 86 |       - "orobardet/gitlab-ci-linter:{{ .Major }}.{{ .Minor }}"
 87 | publishers:
 88 |   - name: debian-cloudsmith
 89 |     ids:
 90 |       - debian-gitlab-ci-linter
 91 |     cmd: cloudsmith push deb --republish orobardet/gitlab-ci-linter/any-distro/any-version "{{ .ArtifactPath }}"
 92 |     env:
 93 |       - CLOUDSMITH_API_KEY={{ .Env.CLOUDSMITH_API_KEY }}
 94 |   - name: rpm-cloudsmith
 95 |     ids:
 96 |       - rpm-gitlab-ci-linter
 97 |     cmd: cloudsmith push rpm --republish orobardet/gitlab-ci-linter/any-distro/any-version "{{ .ArtifactPath }}"
 98 |     env:
 99 |       - CLOUDSMITH_API_KEY={{ .Env.CLOUDSMITH_API_KEY }}
100 |   - name: apk-cloudsmith
101 |     ids:
102 |       - apk-gitlab-ci-linter
103 |     cmd: cloudsmith push alpine --republish orobardet/gitlab-ci-linter/alpine/any-version "{{ .ArtifactPath }}"
104 |     env:
105 |       - CLOUDSMITH_API_KEY={{ .Env.CLOUDSMITH_API_KEY }}
106 | checksum:
107 |   name_template: 'checksums.txt'
108 |   disable: false
109 | snapshot:
110 |   version_template: "{{ .Version }}-dev"
111 | changelog:
112 |   sort: desc
113 | release:
114 |   gitlab:
115 |     owner: orobardet
116 |     name: gitlab-ci-linter
117 |   skip_upload: false
118 | gitlab_urls:
119 |   use_package_registry: true
120 |   use_job_token: false
121 | 


--------------------------------------------------------------------------------
/.pre-commit-hooks.yaml:
--------------------------------------------------------------------------------
 1 | # Allows gitlab-ci-linter to be used as a pre-commit-hook with pre-commit
 2 | # https://pre-commit.com/#pre-commit-configyaml---hooks
 3 | - id: gitlab-ci-linter
 4 |   name: gitlab ci linter
 5 |   description: Check the .gitlab-ci.yml for valid syntax
 6 |   entry: gitlab-ci-linter
 7 |   language: golang
 8 |   types: [yaml]
 9 |   files: '\.gitlab-ci\.ya?ml$'
10 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # vNext
 2 | 
 3 | # v2.4.0
 4 | 
 5 | - Added a `--dry-run` option to run pipeline creation simulation
 6 | - Added a `--dry-run-ref` option to choose trigger ref when dry run
 7 | - Bumps to Go 1.24.1
 8 | 
 9 | # v2.3.0
10 | 
11 | - Switch from deprecated v3 Gitlab API to v4. Thanks @SfinxNT (!20)
12 | - Add support of .netrc file to get personal access token, under new `--netrc|-n` option. Allows to use multiple Gitlab instances with auth in a same dev environment
13 | - Guess project path, and use it in the API URL.
14 | - Added a `--project-path` option
15 | - Added a `--merged-yaml` option to allow merged yaml to be returned in response from gitlab API
16 | - Improve Gitlab API HTTP error code handling
17 | - Publish release on Cloudsmith
18 | - Build and publish a Docker image on Docker Hub
19 | - Upgrade to Go 1.23
20 | - Use Goreleaser
21 | - Bugfixes
22 | 
23 | # v2.2.0
24 | 
25 | - Add a `--personal-access-token` option specify a personal access token (e.g. when 2FA is enabled). Thanks @fhitche1 (!13)
26 | - Fixes short command line options that where not working since upgrade to urfave/cli v2 (#12)
27 | - Option `--gitlab-url` now has precedence over detecting URL from the origin remote(#13)
28 | - Code refactoring, CI and build tooling improvement (!15)
29 | - Validate value of `--gitlab-url` (#14)
30 | - Better error when unable to contact the gitlab API (#9)
31 | 
32 | **Breaking changes:**
33 | 
34 | - When no scheme (http or https) is explicitly given or guessable for a Gitlab URL, https:// is now used by default.
35 | 
36 | # v2.1.0
37 | 
38 | - Upgrade dependencies to latest versions (#10)
39 | - Upgrade to go 1.13 and go modules. Thanks @sascha-andres (!9)
40 | - Introduce support for use with pre-commit.com
41 | - Add support for git repos without a remote named "origin". Thanks @rubensayshi (!11)
42 | - Compress release binaries with UPX to reduce size (#4)
43 | - Binary releases are uploaded to bintray (#2)
44 | 
45 | # v2.0.0
46 | 
47 | - Full rewrite in Go
48 | 
49 | # v1.0.0
50 | 
51 | - First version as a pure bash script
52 | 


--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM alpine
2 | 
3 | COPY gitlab-ci-linter /usr/bin/gitlab-ci-linter
4 | 
5 | CMD [ "gitlab-ci-linter" ]


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2017 Olivier Robardet
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
  1 | # Olivier Robardet's Go Makefile v1.0.0
  2 | #
  3 | # Targets:
  4 | #
  5 | # - setup: install dev dependencies (needs a valid and workin Go environment)
  6 | # - imports: list all direct imports for all the packages of the application
  7 | # - deps: list all dependencies (imports recursively) for all the packages of the application
  8 | # - all: default, just match 'build' target
  9 | # - build: go build the program
 10 | # - clean: remove the binary if it exists
 11 | # - rebuild: force the rebuild by running clean and then build
 12 | # - run: run the builded binary (build it if needed). The environment variable `RUNARGS` can be used to pas arguments to the binary
 13 | # - install: go install the program
 14 | # - vet: go vet of all source files
 15 | # - fmt: go fmt check (no modification) of all source files
 16 | # - checkstyle: golint to stylistic lint all souce files
 17 | # - cyclo: gocyclo all source files
 18 | # - secucheck: gosecu all source files
 19 | # - test: run tests with coverage.
 20 | #         Coverage reports are generated in a directory that can be overrided using the `COVERAGEREPORTDIR` envvar
 21 | # - html-cover: run tests and generate html reports for test coverage.
 22 | #               HTML coverage reports are generated in the same directory as plain coverage reports
 23 | # - check: vet + fmt + checkstyle + cyclo + secucheck
 24 | 
 25 | export GO111MODULE?=on
 26 | 
 27 | ifdef CI
 28 | 	export GOFLAGS+=-buildvcs=false
 29 | endif
 30 | 
 31 | SOURCEDIR=.
 32 | BUILDDIR?=.build
 33 | DOCBUILDDIR?=$(BUILDDIR)/godoc
 34 | # Program name. Defaults to the name of the local package any, or the directory name
 35 | PROGRAM_NAME?=$(shell basename `go list . 2> /dev/null` || echo "`basename $(shell pwd)`")
 36 | 
 37 | # Output path and name of the program binary result
 38 | BINARY?=$(if $(filter $(OS),Windows_NT),$(BUILDDIR)/$(PROGRAM_NAME).exe,$(BUILDDIR)/$(PROGRAM_NAME))
 39 | 
 40 | # Use the environnement variable to pass arguments to the program when using `make run`
 41 | # e.g.:
 42 | # `RUNARGS="-version" make run`
 43 | # or
 44 | # `make run version`
 45 | # will run (after building if necessary):
 46 | # `$(BINARY) version`
 47 | # If the first argument is "run"...
 48 | #ifeq (run,$(firstword $(MAKECMDGOALS)))
 49 |   # use the rest as arguments for "run"
 50 | #  RUNARGS?=$(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
 51 |   # ...and turn them into do-nothing targets
 52 | #  $(eval $(RUNARGS):;@:)
 53 | #endif
 54 | 
 55 | DEBUG:=0
 56 | 
 57 | # Version number to use when building the program
 58 | VERSION?=$(shell git describe --tags --match=v* 2> /dev/null || cat ${SOURCEDIR}/VERSION 2> /dev/null || echo v0.0.0)+dev
 59 | # Revision or VCS hash to use when building the program. Can be long, it may be truncated by the program at
 60 | REVISION?=$(shell git rev-parse HEAD || echo "")
 61 | # Build date&time to use when building the programme. Unlikely needed to be overriden.
 62 | BUILDTIME?=$(shell date +%FT%T%z)
 63 | 
 64 | MAIN_PACKAGE_PATH=$(shell go list . 2> /dev/null)/
 65 | LDFLAGS+=-X $(MAIN_PACKAGE_PATH)config.VERSION=${VERSION} -X $(MAIN_PACKAGE_PATH)config.REVISION=${REVISION} -X $(MAIN_PACKAGE_PATH)config.BUILDTIME=${BUILDTIME}
 66 | ifeq ($(DEBUG),0)
 67 |   LDFLAGS+=-s -w
 68 | endif
 69 | SOURCES:=$(shell find $(SOURCEDIR) -name '*.go' -not -path "$(SOURCEDIR)/vendor/*" 2>/dev/null)
 70 | PACKAGES:=$(shell go list ./...)
 71 | PACKAGEPATHS:=$(shell go list -f "{{.Dir}}" ./...)
 72 | CYCLOTHRESHOLD?=15
 73 | 
 74 | GOTESTCMD?=go test
 75 | GOTESTFLAGS?=
 76 | COVERAGEREPORTDIR?=$(BUILDDIR)/coverage
 77 | COVERAGEMODE?=atomic
 78 | COVERAGEGLOBALFILE?=all.cover
 79 | 
 80 | SOURCES:=$(shell find $(SOURCEDIR) -name '*.go' -not -path "$(SOURCEDIR)/vendor/*" 2>/dev/null)
 81 | PACKAGES:=$(shell go list ./...)
 82 | PACKAGEPATHS:=$(shell go list -f "{{.Dir}}" ./...)
 83 | 
 84 | .DEFAULT_GOAL: all
 85 | 
 86 | .PHONY: all
 87 | all: build
 88 | 
 89 | build: $(BINARY)
 90 | 
 91 | .PHONY: release
 92 | 
 93 | release: build
 94 | 
 95 | rebuild: clean build
 96 | 
 97 | .PHONY: setup
 98 | setup:
 99 | 
100 | .PHONY: imports
101 | imports:
102 | 	@go list -f '{{ join .Imports "\n" }}' ./... | sort -u
103 | 
104 | .PHONY: deps
105 | deps:
106 | 	@go list -f '{{ join .Deps "\n" }}' ./... | sort -u
107 | 
108 | .PHONY: check checks
109 | check: lint test
110 | checks: check
111 | 
112 | .PHONY: lint
113 | lint:  $(SOURCES)
114 | 	go tool golangci-lint run
115 | 
116 | .PHONY: run
117 | run: $(BINARY)
118 | 	$(BINARY) $(RUNARGS)
119 | 
120 | $(BINARY): $(SOURCES)
121 | 	go build -ldflags "${LDFLAGS}" -o ${BINARY}
122 | 
123 | .PHONY: install
124 | install:
125 | 	go install -ldflags "${LDFLAGS}" ./...
126 | 
127 | .PHONY: clean
128 | clean:
129 | 	go clean
130 | 	if [ -f "$(BINARY)" ] ; then rm $(BINARY) ; fi
131 | 	rm -fr $(COVERAGEREPORTDIR)
132 | 	rm -fr $(DOCBUILDDIR)
133 | 	-rmdir $(BUILDDIR) 2>/dev/null || true
134 | 
135 | $(COVERAGEREPORTDIR):
136 | 	mkdir -p $(COVERAGEREPORTDIR)
137 | 
138 | .PHONY: test _test
139 | test: _test | $(COVERAGEREPORTDIR)
140 | _test: $(addprefix test-package/,$(PACKAGES))
141 | 	@echo "Merging all coverage reports"
142 | 	@echo "mode: $(COVERAGEMODE)" > $(COVERAGEREPORTDIR)/$(COVERAGEGLOBALFILE)
143 | 	@find $(COVERAGEREPORTDIR) -name "*.cover" ! -name "$(COVERAGEGLOBALFILE)" -exec cat {} \; 2>/dev/null | grep -v "^mode:" >> $(COVERAGEREPORTDIR)/$(COVERAGEGLOBALFILE)
144 | 	go tool cover -func $(COVERAGEREPORTDIR)/$(COVERAGEGLOBALFILE)
145 | 
146 | test-package/%: pkg_path=$*
147 | test-package/%: pkg_name=$(shell go list -f '{{.Name}}' $(pkg_path))
148 | test-package/%: | $(COVERAGEREPORTDIR)
149 | 	$(GOTESTCMD) -cover -covermode=$(COVERAGEMODE) -coverprofile=$(COVERAGEREPORTDIR)/pkg-$(pkg_name).cover $(GOTESTFLAGS) $(pkg_path)
150 | 
151 | .PHONY: html-cover _html-cover
152 | .SECONDEXPANSION:
153 | COVERFILES=$(shell find $(COVERAGEREPORTDIR) -name '*.cover' -printf "%f\n" 2>/dev/null)
154 | html-cover: _html-cover | $(COVERAGEREPORTDIR)
155 | _html-cover: $(addprefix html-cover-package/,$(COVERFILES))
156 | 
157 | html-cover-package/%: | $(COVERAGEREPORTDIR)
158 | 	go tool cover -html=$(COVERAGEREPORTDIR)/$* -o $(COVERAGEREPORTDIR)/$(*:.cover=.html)
159 | 
160 | .PHONY: godoc
161 | godoc: _godoc_binary
162 | 	ci/make-godoc.sh
163 | 
164 | .PHONY: release-snapshot
165 | release-snapshot:
166 | 	go tool goreleaser release --clean --snapshot --skip=publish


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # .gitlab-ci.yml lint helper tool
  2 | 
  3 | > Goodbye "yaml invalid" pipeline errors, and don't come back!
  4 | 
  5 | This tool use the [Gitlab API](https://docs.gitlab.com/ce/api/lint.html) to validate your local `.gitlab-ci.yml`.  
  6 | It can be installed as a git pre-commit hook, preventing commit (and so push) of an invalid `.gitlab-ci.yml`. 
  7 | 
  8 | **The tool itself does not lint anything: it uses the lint API of a Gitlab instance => it needs to be run somewhere with an access to the Gitlab instance where your project come from.**
  9 | 
 10 | # Installation
 11 | 
 12 | You can download the tool from the [releases page](https://gitlab.com/orobardet/gitlab-ci-linter/-/releases) or from [Cloudsmith](https://cloudsmith.io/~orobardet/repos/gitlab-ci-linter/packages/).
 13 | 
 14 | ## Linux repositories
 15 | 
 16 | ### Debian based
 17 | 
 18 | ```shell
 19 | curl -1sLf \
 20 |   'https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/setup.deb.sh' \
 21 |   | sudo -E bash
 22 | ```
 23 | 
 24 | or see manual or alternative instructions on Cloudsmith: https://cloudsmith.io/~orobardet/repos/gitlab-ci-linter/setup/#formats-deb
 25 | 
 26 | ### RPM based
 27 | 
 28 | ```shell
 29 | curl -1sLf \
 30 |   'https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/setup.rpm.sh' \
 31 |   | sudo -E bash
 32 | ```
 33 | 
 34 | or see manual or alternative instructions on Cloudsmith: https://cloudsmith.io/~orobardet/repos/gitlab-ci-linter/setup/#formats-rpm
 35 | 
 36 | ### Alpine
 37 | 
 38 | ```shell
 39 | sudo apk add --no-cache bash
 40 | curl -1sLf \
 41 |   'https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/setup.alpine.sh' \
 42 |   | sudo -E bash
 43 | ```
 44 | 
 45 | or see manual or alternative instructions on Cloudsmith: https://cloudsmith.io/~orobardet/repos/gitlab-ci-linter/setup/#formats-alpine
 46 | 
 47 | ## Binaries
 48 | 
 49 | The tool is made in [Go](https://golang.org/). So it's cross-platform and can be run in Linux, Windows, Mac or any other
 50 | operating system supported by Go.
 51 | 
 52 | To install, just [download the binary](https://gitlab.com/orobardet/gitlab-ci-linter/-/releases) matching you system and put it somewhere (preferably in your `$PATH`).  
 53 | Upgrade is just overriding the binary with a new one.
 54 |  
 55 | The following binary versions are available:
 56 | 
 57 | - [Windows x64](https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/raw/names/gitlab-ci-linter_windows_amd64/versions/2.3.0/gitlab-ci-linter.exe)
 58 | - [Windows x86](https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/raw/names/gitlab-ci-linter_windows_386/versions/2.3.0/gitlab-ci-linter.exe)
 59 | - [Windows ARM64](https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/raw/names/gitlab-ci-linter_windows_arm64/versions/2.3.0/gitlab-ci-linter.exe)
 60 | - [Linux x64](https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/raw/names/gitlab-ci-linter_linux_amd64/versions/2.3.0/gitlab-ci-linter)
 61 | - [Linux x86](https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/raw/names/gitlab-ci-linter_linux_386/versions/2.3.0/gitlab-ci-linter)
 62 | - [Linux ARM64](https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/raw/names/gitlab-ci-linter_linux_arm64/versions/2.3.0/gitlab-ci-linter)
 63 | - [Linux ARM](https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/raw/names/gitlab-ci-linter_linux_arm/versions/2.3.0/gitlab-ci-linter)
 64 | - [Mac ARM64 (Apple silicon)](https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/raw/names/gitlab-ci-linter_darwin_arm64/versions/2.3.0/gitlab-ci-linter)
 65 | - [Mac x64](https://dl.cloudsmith.io/public/orobardet/gitlab-ci-linter/raw/names/gitlab-ci-linter_darwin_amd64/versions/2.3.0/gitlab-ci-linter)
 66 | 
 67 | ## Docker
 68 | 
 69 | ```shell
 70 | docker pull orobardet/gitlab-ci-linter
 71 | ```
 72 | 
 73 | ## Requirements
 74 | 
 75 | None.
 76 |   
 77 | You don't even need a Git client.
 78 | 
 79 | The only thing required is a network connection to the Gitlab instance you are using in the repository you want to check.    
 80 | And a git repository to check of course, having an `origin` remote corresponding to a Gitlab instance and a `.gitlab-ci.yml` file. 
 81 | 
 82 | # Quick start
 83 | 
 84 | Once installed (look above).
 85 | 
 86 | ## Setup
 87 | 
 88 | To do once per computer/environment you install the tool.
 89 | 
 90 | 1. Generate a new [personal access token on your Gitlab.com account](https://gitlab.com/-/user_settings/personal_access_tokens), with `api` scope.  
 91 |    Then edit your `~/.netrc` (if you are creating it, **don't forget to make it only readable and writable by _you_ and no one else**), and add:
 92 |    ```shell
 93 |    machine gitlab.com account <YOUR_PERSONAL_ACCESS_TOKEN>
 94 |    ```
 95 |    You only need to this the first time you 
 96 | 2. Add `export GCL_NETRC=1` to your environment (`.bashrc`, `.zshrc`, powershell profile...) and restart your shell.
 97 | 3. Optionally, repeat step 1 for any private Gitlab instance you may use.
 98 | 
 99 | ## Use
100 |  
101 | 1. `cd` to a git repository having gitlab.com as origin remote (with https or ssh).
102 | 2. Run `gitlab-ci-lint` to check the validity of your `.gitlab-ci-lint`
103 | 3. Optionally, run `gitlab-ci-lint install` to install it as a pre-commit hook: git will launch the check each time you commit things.
104 | 
105 | As a docker container, from your repository root:
106 | 
107 | ```shell
108 | docker run --rm -it -e "GCL_PERSONAL_ACCESS_TOKEN=<YOUR_PERSONAL_ACCESS_TOKEN>" -v $(PWD):/src -w /src orobardet/gitlab-ci-linter
109 | ```
110 | 
111 | 
112 | ## Tips
113 | 
114 | Declare an alias `gcl` in your shell to invoke the tool even quicker.
115 | 
116 | # Usage
117 | 
118 | Once installed, it can be used as a simple standalone program, by launching it from any directory 
119 | inside a git repository clone.
120 | 
121 | Let's say you have a Gitlab project cloned in `~/dev/my-super-project`:
122 | 
123 | ```shell
124 | cd ~/dev/my-super-project
125 | gitlab-ci-linter
126 | ```
127 | If the `.gitlab-ci.yml` is valid:
128 | 
129 | ![.gitlab-ci.yml is valid!](doc/screen-standalone-ok.png)
130 | 
131 | You don't need to be in the root of the git repository:
132 | ```shell
133 | cd ~/dev/my-super-project/src/public
134 | gitlab-ci-linter
135 | ```
136 | 
137 | If the `.gitlab-ci.yml` is invalid:
138 | 
139 | ![Arg! An error!](doc/screen-standalone-ko.png)
140 | 
141 | ## As git pre-commit hook
142 | 
143 | The tool can be used as a git pre-commit hook. It means it will be run by git automatically each time you ask for a 
144 | commit, and git will stop if your `.gitlab-ci.yml` is invalid:
145 | 
146 | ![Thanks alerting me!](doc/screen-hook-ko.png)
147 | 
148 | The tool can install (and uninstall) itself as a pre-commit hook, using the commands `install` and `uninstall`.
149 | 
150 | ```shell
151 | # Inside a git repository tree, install the pre-commit hook:
152 | gitlab-ci-linter install
153 | # Uninstall the pre-commit hook:
154 | gitlab-ci-linter uninstall
155 | ```
156 | 
157 | The self installation is pretty simple: it will just create a `.git/hooks/pre-commit` file as a symbolic link to itself.
158 | 
159 | > It means updating the tool to a newer version will update all the hooks installed in all your repo => Good!  
160 | > But moving the executable will broke commit in these repo until you manually remove the hook and reinstall it => Not so good...  
161 | > Conclusion: install the tool in a safe and viable place :)
162 | 
163 | > **Note for Windows users:** Windows require administrator privileges to create symbolic links. So the `gitlab-ci-linter install` 
164 | > command will only work if run with administrator privileges. 
165 | 
166 | It won't be able to self install if a `.git/hooks/pre-commit` already exists (and is not a link to itself).
167 |  
168 | Self uninstall will only works if `.git/hooks/pre-commit` is a link to itself.
169 | 
170 | If you are already using a pre-commit hook, you'll have to install manually: simply add a call to the tool in your 
171 | existing pre-commit script.
172 | 
173 | ### Integration with the `pre-commit` project
174 | 
175 | There is also native support for using gitlab-ci-linter as a pre-commit-hook in
176 | the [pre-commit project](https://pre-commit.com/). If you're using pre-commit,
177 | include this tool in your `.pre-commit-config.yaml` like this:
178 | 
179 | ```
180 |   - repo: https://gitlab.com/orobardet/gitlab-ci-linter/
181 |     rev: < you define a git revision or tag here >
182 |     hooks:
183 |       - id: gitlab-ci-linter
184 | ```
185 | 
186 | Note: this supposes you have a working Go toolchain in a valid version.
187 | 
188 | ## Things to know
189 | 
190 | - If no `.gitlab-ci.yml` is detected in the git repository root, the tool does nothing (if installed as pre-commit hook, it will not prevent the commit).
191 | - This tool works (or should) with any instance of Gitlab: gitlab.com or private instance.
192 | - It uses the url of the remote `origin` to guess the url of the Gitlab to use, and the project path (also works if the remote is ssh, as soon as the Gitlab respond on HTTP using the same FQDN as ssh)
193 | - If the `projects/:project_path_or_id/ci/lint` API is not publicly accessible (or 2FA is enforced), you can specify a personal access token using `--personal-access-token|-p` option or `GCL_PERSONAL_ACCESS_TOKEN` environment variable. The token must have the `api` scope.
194 | - You can also use the flag `--netrc|-n` to try getting the token from the [`.netrc` file](https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html) (by default `~/.netrc` on *nix, `$HOME/_netrc` on Windows), but not the token must be set
195 |    on the `account` field, not `password` (to prevent conflict with basic auth). `login` is not used.
196 |    e.g.: for gitlab.com, the .netrc entry should be:
197 |    ```shell
198 |    machine gitlab.com
199 |         # possible login and password definition
200 |         account MY_PERSONAL_ACCESS_TOKEN
201 |    ```
202 |   Also, the `default` entry of .netrc is _ignored_.
203 | - Original `/ci/lint` API endpoint was [deprecated](https://docs.gitlab.com/ee/update/deprecations.html?removal_milestone=16.0#post-cilint-api-endpoint-deprecated) in v15.7 and removed in v16.0. Now, `projects/:project_path_or_id/ci/lint` is used instead. 
204 |   The tool will try by default to guess the project path from your remote, but you can specify:
205 |   - The project PATH using `--project-path|-P` option or `CI_PROJECT_ID` environment variable (predefined in Gitlab CI).
206 |   - The project ID using `--project-id|-I` option or `CI_PROJECT_PATH` environment variable (predefined in Gitlab CI).
207 |   `--project-id` has precedence over `--project-path`.
208 | 
209 | ## --help 
210 | 
211 | A bunch of options are available to configure the tool. All options can be also set using environment variables.  
212 | Option's value on the command line have precedence over environment variables. 
213 | 
214 | ```
215 | Usage:
216 |    gitlab-ci-linter [global options] [command [command options]] [PATH]
217 | 
218 |    The used Gitlab API is tied to a Gitlab project. Thus, the tools needs to know which Gitlab project (on which Gitlab instance) it has to target.
219 |    By default, it will try to autodetect from the 'origin' remote configured in the git repository (if any), by extracting the FQDN as the root URL,
220 |    and the project path. Works for 'http'' or 'ssh' remotes. e.g.: a remote "https://gitlab.com/orobardet/gitlab-ci-linter.git" or
221 |    "git@gitlab.com:orobardet/gitlab-ci-linter.git" will target the API of the project "orobardet/gitlab-ci-linter" on "https://gitlab.com".
222 | 
223 |    In case the auto-detection does not work, or you don't have a compatible remote, or you want to target another project, you can specify the Gitlab
224 |    root URL using '-gitlab-url|-u' flag, and the project using '--project-path|-P' or '--project-id|-I' flags. '--project-id' has precedence over '--project-path'.
225 | 
226 |    If your gitlab instance or project needs an authentification (which is the case on gitlab.com), you have to specify a personal access token with '--personal-access-token|-p'.
227 |    You can also use the flag '--netrc|-n' to try getting the token from the .netrc file (by default ~/.netrc on *nix, $HOME/_netrc on Windows), but not the token must be set
228 |    on the 'account' field, not 'password' (to prevent conflict with basic auth). Also, the 'default' entry of .netrc is ignored.
229 |    e.g.: for gitlab.com, the .netrc entry should be:
230 |       machine gitlab.com
231 |         # possible login and password definition
232 |         account MY_PERSONAL_ACCESS_TOKEN
233 | 
234 | Global options:
235 |    --gitlab-url URL, -u URL             root URL of the Gitlab instance to use API (default: auto-detect from remote origin, else "https://gitlab.com") [$GCL_GITLAB_URL]
236 |    --ci-file FILE, -f FILE              FILE is the relative or absolute path to the gitlab-ci file [$GCL_GITLAB_CI_FILE]
237 |    --directory DIR, -d DIR              DIR is the directory from where to search for gitlab-ci file and git repository (default: ".") [$GCL_DIRECTORY]
238 |    --personal-access-token TOK, -p TOK  personal access token TOK for accessing repositories when you have 2FA enabled. Has precedence over .netrc usage [$GCL_PERSONAL_ACCESS_TOKEN]
239 |    --netrc, -n                          Try to get personal access token as 'account' from .netrc file (default: false) [$GCL_NETRC]
240 |    --netrc-file value                   Path of .netrc file to use. By default, try to detect it. [$GCL_NETRC_FILE]
241 |    --project-path PATH, -P PATH         PATH of the GitLab project that is used in the API for Gitlab >=13.6. Has precedence over path guessing from remote [$CI_PROJECT_PATH, $GCL_PROJECT_PATH]
242 |    --project-id ID, -I ID               ID of the GitLab project that is used in the API for Gitlab >=13.6. Has precedence over --project-path [$CI_PROJECT_ID, $GCL_PROJECT_ID]
243 |    --timeout value, -t value            timeout in second after which http request to Gitlab API will timeout (and the program will fails) (default: 15) [$GCL_TIMEOUT]
244 |    --no-color                           don't color output. By defaults the output is colorized if a compatible terminal is detected. (default: false) [$GCL_NOCOLOR]
245 |    --verbose, -v                        verbose mode (default: false) [$GCL_VERBOSE]
246 |    --merged-yaml, -m                    include merged yaml in response (default: false) [$GCL_INCLUDE_MERGED_YAML]
247 |    --help, -h                           show help
248 |    --version                            print the version information (default: false)
249 | 
250 | Arguments:
251 |    If PATH if given, it will depending of its type on filesystem:
252 |     - if a file, it will be used as the gitlab-ci file to check (similar to global --ci-file option)
253 |     - if a directory, it will be used as the folder from where to search for a ci file and a git repository (similar to global --directory option)
254 |    PATH have precedence over --ci-file and --directory options.
255 | 
256 | Commands:
257 |    check, c      Check the .gitlab-ci.yml (default command if none is given)
258 |    install, i    install as git pre-commit hook
259 |    uninstall, u  uninstall the git pre-commit hook
260 |    version, v    Print the version information
261 |    help, h       Shows a list of commands or help for one command
262 | 
263 |    If no command is given, 'check 'is used by default
264 | ```
265 | 
266 | ## Usage examples
267 | 
268 | Check the `.gitlab-ci.yml` of the git repository containing the current working directory:
269 | 
270 | ```shell
271 | gitlab-ci-lint
272 | # or
273 | gitlab-ci-lint check
274 | ```
275 | 
276 | Check the `.gitlab-ci.yml` of another git repository directory:
277 | 
278 | ```shell
279 | gitlab-ci-lint /path/to/another/git
280 | # or 
281 | gitlab-ci-lint check /path/to/another/git
282 | # or
283 | gitlab-ci-lint --directory /path/to/another/git check
284 | ```
285 | 
286 | Check a specific CI file (not at the root of the git repository, or not name `.gitlab-ci-.yml`):
287 | 
288 | ```shell
289 | gitlab-ci-lint /path/to/ci-file.yml
290 | # or 
291 | gitlab-ci-lint check /path/to/ci-file.yml
292 | # or
293 | gitlab-ci-lint --ci-file /path/to/ci-file.yml check
294 | ```
295 | 
296 | Install a pre-commit hook in the current git repository:
297 | 
298 | ```shell
299 | gitlab-ci-lint install
300 | ```
301 | 
302 | Install a pre-commit hook in another git repository:
303 | 
304 | ```shell
305 | gitlab-ci-lint -d /path/to/another/git install
306 | ```
307 | 
308 | You don't want https://gitlab.com to be the default Gitlab URL to use? There is no origin remote configured in your repository?
309 | Or you don't want to use this gitlab?
310 | 
311 | ```shell
312 | gitlab-ci-lint --gitlab-url https://gitlab.my.org check
313 | ```
314 | 
315 | But you may prefer to use define the environment variable `GCL_GITLAB_URL=https://gitlab.my.org`, possibly in your shell 
316 | init script, to configure this globally and also for pre-commit hooks.
317 | 
318 | 
319 | # Contributing
320 | 
321 | This tool was my very first Go development, while learning the language.
322 | 
323 | It was done to fit my personal needs in context of my own day work.
324 | 
325 | So there is should be plenty room for improvement. Do not hesitate to propose bugfix, new features, or code improvements.  
326 | Open issues.
327 | 
328 | As I may not have a lot of time to implement propositions, the best way to have a request landing quickly is to come with a merge request :) 
329 | 
330 | 
331 | # Development
332 | 
333 | ## Clone the package
334 | 
335 | ```shell
336 | git clokd git@gitlab.com:orobardet/gitlab-ci-linter
337 | ```
338 | 
339 | ## Dependencies and module
340 | 
341 | This software uses go module to handle dependencies. Just ensure to use a recent and compatible version of Go (see go.mod for exact version needed).
342 | 
343 | ## Compilation
344 | 
345 | A [Makefile](Makefile) is provided, to build the executable you can simply run:
346 | 
347 | ```shell
348 | make
349 | ```
350 | 
351 | The Makefile accept the following targets (but not limited to):
352 | 
353 | - `setup`: install some Go tooling (goreleaser, golangci-lint, ...)
354 | - `build`
355 | - `clean` 
356 | - `test`: runs tests with code coverage
357 | - `html-cover`: generate an html report of tests coverage
358 | - `check`: runs some checks (fmt, vet, lint, security, cyclo, ...)
359 | - `rebuild`: force the rebuild from scratch (simply runs `clean` followed by `build`)
360 | - `release-snapshot`: launch goreleaser for a local release: builds all binaries and packages in `.build/dist/`
361 | 
362 | The Makefile also accept the following environment variables:
363 | 
364 | - `BINARY`: the name and path of the binary to build (by default `.build/gitlab-ci-linter`)
365 | - `VERSION`: the version number to include in the program (by default use the last git tag if any, else the short commit hash, both suffixed by `-dev`)
366 | - `REVISION`: the revision string to include in the program, typically the VCS commit hash (by default the git full commit hash) 
367 | - `BUILDTIME`: the build date and time (by default the current ones, of course)
368 | - `DEBUG`: binaries a build without debug symbols to reduce their size (`-s -w` link options) ; setting `DEBUG` to a non-zero value (0 by default) will build binary with debug symbols
369 | 
370 | Other targets exists, look directly in the [Makefile](Makefile)'s comments. 
371 | 
372 | ## Dev workflow
373 | 
374 | - Change the code
375 | - Run with:
376 | ```shell
377 | # The following commands are equivalent:
378 | go run . [--some-gitlab-ci-linter-options or arguments]
379 | ``` 
380 | 
381 | Once you are happy with your changes, and before commiting/pushing something, check the code quality and run tests with `make checks`.


--------------------------------------------------------------------------------
/ci/build-docker-image/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM golang:1.23
 2 | 
 3 | # Install jq
 4 | ADD https://github.com/stedolan/jq/releases/download/jq-1.5/jq-linux64 /usr/local/bin/jq
 5 | RUN chmod +x /usr/local/bin/jq
 6 | 
 7 | # Set a local go user and use it
 8 | ENV GOUSER=go
 9 | RUN adduser --gecos "" --disabled-password $GOUSER
10 | USER $GOUSER
11 | 
12 | # Install some go tools
13 | RUN go install golang.org/x/tools/cmd/godoc@latest && \
14 |     go install golang.org/x/lint/golint@latest && \
15 |     go install github.com/alecthomas/gocyclo@latest && \
16 |     go install github.com/securego/gosec/v2/cmd/gosec@latest && \
17 |     go clean && rm -fr /tmp/*
18 | 


--------------------------------------------------------------------------------
/ci/build-docker-image/README.md:
--------------------------------------------------------------------------------
1 | This docker image is used to build the application.
2 | 
3 | It is based on Go 1.9 official image, and only adds [dep](https://github.com/golang/dep), until it's (hopefully) included in go toolbox.


--------------------------------------------------------------------------------
/ci/make-godoc.sh:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env bash
 2 | 
 3 | set -e
 4 | 
 5 | SOURCE_DIR=${SOURCE_DIR:=$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. >/dev/null && pwd)}
 6 | DOCBUILDDIR=${DOCBUILDDIR:=$SOURCE_DIR/.build/godoc}
 7 | 
 8 | CRESET='\e[0m' # Reset color
 9 | CGREEN='\e[1;32m'
10 | CCYAN='\e[1;36m'
11 | 
12 | cd "$SOURCE_DIR"
13 | 
14 | echo "Will generate godoc in $DOCBUILDDIR directory"
15 | 
16 | MAIN_PACKAGENAME="$(go list .)"
17 | PACKAGEPATH="${PACKAGEPATH:=gitlab.com/orobardet/gitlab-ci-linter}"
18 | 
19 | rm -fr "$DOCBUILDDIR"
20 | 
21 | mkdir -p "$DOCBUILDDIR"
22 | cd "$DOCBUILDDIR"
23 | echo -e "${CCYAN}Starting godoc server on port 8989...${CRESET}"
24 | godoc -http "127.0.0.1:8989" &
25 | GODOCPID=$!
26 | echo -e "${CCYAN}Give some time to godoc server to be ready...${CRESET}"
27 | sleep 10
28 | echo -e "${CCYAN}Crawling $PACKAGEPATH doc file...${CRESET}"
29 | set +e
30 | wget \
31 |     --convert-links \
32 |     --recursive \
33 |     --page-requisites \
34 |     --no-parent \
35 |     --no-host-directories \
36 |     --adjust-extension \
37 |     --exclude-directories '/src/'$PACKAGEPATH'/.git,/src/'$PACKAGEPATH'/.*,/src/'$PACKAGEPATH'/vendor,/src/'$PACKAGEPATH'/coverage,/src/'$PACKAGEPATH'/doc,/src/'$PACKAGEPATH'/tools' \
38 |     -e robots=off \
39 |     -nv \
40 |     -U mozilla \
41 |     http://localhost:8989/src/$PACKAGEPATH \
42 |     http://localhost:8989/pkg/$PACKAGEPATH
43 | kill $GODOCPID
44 | set -e
45 | 
46 | echo -e "${CCYAN}Post processing godoc...${CRESET}"
47 | 
48 | # Replace the package's directory index file by the package file
49 | mv "pkg/$PACKAGEPATH.html" "pkg/$(dirname "$PACKAGEPATH")/index.html"
50 | 
51 | # Ugly hack to hide menu and footer in godocs, that points to
52 | echo "div#menu,div#footer { display: none; }" >> "lib/godoc/style.css"
53 | 
54 | # Make an index file at the root of the generated doc tree, that redirect the the package's index
55 | echo "<!DOCTYPE html><html><head><meta http-equiv=\"refresh\" content=\"0;pkg/$(dirname "$PACKAGEPATH")/index.html\"></head></html>" > index.html
56 | 
57 | echo -e "\n\t${CGREEN}Package documentation successfully generated in $DOCBUILDDIR ($(du -sh "." | cut -f1))${CRESET}\n"


--------------------------------------------------------------------------------
/ci/update-gitlab-release.sh:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env bash
  2 | 
  3 | set -e
  4 | 
  5 | CHANGELOG_FILE=${CHANGELOG_FILE:=CHANGELOG.md}
  6 | VERSION=${VERSION##v}
  7 | AF_BINARY_URL=${AF_BINARY_URL:=https://api.bintray.com}
  8 | AF_BINARY_DL_URL=${AF_BINARY_DL_URL:=https://dl.bintray.com}
  9 | 
 10 | MARKDOWN=""
 11 | 
 12 | if [[ -z "$AF_BINARY_URL" ]] ; then
 13 |     >&2 echo "No Artifactory/bintray API url found (\$AF_BINARY_URL)."
 14 |     exit 1
 15 | fi
 16 | if [[ -z "$AF_BINARY_DL_URL" ]] ; then
 17 |     >&2 echo "No Artifactory/bintray download url found (\$AF_BINARY_DL_URL)."
 18 |     exit 1
 19 | fi
 20 | if [[ -z "$AF_BINARY_SUBJECT" ]] ; then
 21 |     >&2 echo "No Artifactory/bintray subject found (\$AF_BINARY_SUBJECT)."
 22 |     exit 1
 23 | fi
 24 | if [[ -z "$AF_BINARY_REPO" ]] ; then
 25 |     >&2 echo "No Artifactory/bintray repository name found (\$AF_BINARY_REPO)."
 26 |     exit 1
 27 | fi
 28 | if [[ -z "$AF_BINARY_PACKAGE" ]] ; then
 29 |     >&2 echo "No Artifactory/bintray package name found (\$AF_BINARY_PACKAGE)."
 30 |     exit 1
 31 | fi
 32 | if [[ -z "$AF_API_USER" ]] ; then
 33 |     >&2 echo "No Artifactory/bintray API user found (\$AF_API_USER)."
 34 |     exit 1
 35 | fi
 36 | if [[ -z "$AF_API_KEY" ]] ; then
 37 |     >&2 echo "No Artifactory/bintray API key found (\$AF_API_KEY)."
 38 |     exit 1
 39 | fi
 40 | 
 41 | if [[ -z "$CI_GITLAB_URL" ]] ; then
 42 |     >&2 echo "No Gitlab URL found (\$CI_GITLAB_URL)."
 43 |     exit 1
 44 | fi
 45 | if [[ -z "$CI_PROJECT_PATH" ]] ; then
 46 |     >&2 echo "No project path found (\$CI_PROJECT_PATH)."
 47 |     exit 1
 48 | fi
 49 | if [[ -z "$CI_JOB_TOKEN" ]] ; then
 50 |     >&2 echo "No job token found (\$CI_JOB_TOKEN)."
 51 |     exit 1
 52 | fi
 53 | 
 54 | if [[ ! -f "$CHANGELOG_FILE" ]] ; then
 55 |     >&2 echo "No changelog file '$CHANGELOG_FILE' found (\$CHANGELOG_FILE)."
 56 |     exit 1
 57 | fi
 58 | 
 59 | if [[ -z "$CHANGELOG_FILE" ]] ; then
 60 |     >&2 echo "No version found (\$VERSION)."
 61 |     exit 1
 62 | fi
 63 | 
 64 | function escapeForJSON() {
 65 |     local l_string="$1" ; shift
 66 | 
 67 |     l_string=${l_string//\\/\\\\} # \
 68 |     l_string=${l_string//\"/\\\"} # "
 69 |     l_string=${l_string//$'\t'/\\t} # \t (tab)
 70 |     l_string=${l_string//$'\n'/\\n} # \n (newline)
 71 |     l_string=${l_string//$'\r'/\\r} # \r (carriage return)
 72 | 
 73 |     echo "$l_string"
 74 | }
 75 | 
 76 | rawurlencode() {
 77 |   local string="${1}"
 78 |   local strlen=${#string}
 79 |   local encoded=""
 80 |   local pos c o
 81 | 
 82 |   for (( pos=0 ; pos<strlen ; pos++ )); do
 83 |      c=${string:$pos:1}
 84 |      case "$c" in
 85 |         [-_.~a-zA-Z0-9]) o="${c}" ;;
 86 |         * ) printf -v o '%%%02x' "'$c"
 87 |      esac
 88 |      encoded+="${o}"
 89 |   done
 90 |   echo "${encoded}"    # You can either set a return variable (FASTER)
 91 | }
 92 | 
 93 | echo "Updating release note for $AF_BINARY_PACKAGE v$VERSION..."
 94 | 
 95 | echo "  Extracting changelog..."
 96 | 
 97 | # sed -e <Version Line> -e <Next version line> CHANGELOG.md | sed -e <remove starting and tailing empty lines>
 98 | MARKDOWN=$(sed -e '1,/^# v'$VERSION'/d' -e '/^#/,$d' CHANGELOG.md | sed -e :a -e '/./,$!d;/^\n*$/{$d;N;};/\n$/ba' )
 99 | 
100 | MARKDOWN="$MARKDOWN"$'\n\n'
101 | 
102 | echo "  Retrieving binary files list from bintray..."
103 | 
104 | BINTRAY_FILES=$(curl -s "$AF_BINARY_URL/packages/$AF_BINARY_SUBJECT/$AF_BINARY_REPO/$AF_BINARY_PACKAGE/versions/$VERSION/files?include_unpublished=0" | jq -r 'sort_by(.name)[] | .name+":"+.path')
105 | 
106 | if [[ -n "$BINTRAY_FILES" ]] ; then
107 |     MARKDOWN="$MARKDOWN**Download binaries:**"$'\n\n'
108 |     for file in $BINTRAY_FILES ; do
109 |         IFS=':' read name path <<< "$file"
110 |         MARKDOWN="$MARKDOWN- [$name]($AF_BINARY_DL_URL/$AF_BINARY_SUBJECT/$AF_BINARY_PACKAGE/$path)"$'\n'
111 |     done
112 | fi
113 | 
114 | echo "  Generated release note:"
115 | echo ">>RELEASE_NOTE_START>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
116 | echo -e "$MARKDOWN"
117 | echo "<<RELEASE_NOTE_END<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<"
118 | 
119 | escapedMARKDOWN=$(escapeForJSON "$MARKDOWN")
120 | printf -v l_jsonBody '{ "description":"%s" }' "$escapedMARKDOWN"
121 | l_APIUrl="${CI_GITLAB_URL}/api/v4/projects/$(rawurlencode "$CI_PROJECT_PATH")/repository/tags/v$VERSION/release"
122 | echo "  Updating Gitlab release ($l_APIUrl)..."
123 | curl -s --header "PRIVATE-TOKEN: $CI_JOB_TOKEN" --header "Content-Type: application/json" -XPUT --data "$l_jsonBody" $l_APIUrl > /dev/null
124 | 
125 | echo "Release note for $AF_BINARY_PACKAGE v$VERSION updated."


--------------------------------------------------------------------------------
/cmd_check.go:
--------------------------------------------------------------------------------
  1 | // Copyright © 2018-2020 Olivier Robardet
  2 | //
  3 | // Permission is hereby granted, free of charge, to any person obtaining a copy
  4 | // of this software and associated documentation files (the "Software"), to deal
  5 | // in the Software without restriction, including without limitation the rights
  6 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7 | // copies of the Software, and to permit persons to whom the Software is
  8 | // furnished to do so, subject to the following conditions:
  9 | //
 10 | // The above copyright notice and this permission notice shall be included in
 11 | // all copies or substantial portions of the Software.
 12 | //
 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 18 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 19 | // THE SOFTWARE.
 20 | 
 21 | package main
 22 | 
 23 | import (
 24 | 	"fmt"
 25 | 	"os"
 26 | 	"path/filepath"
 27 | 	"strings"
 28 | 
 29 | 	"github.com/fatih/color"
 30 | 	"github.com/urfave/cli/v2"
 31 | )
 32 | 
 33 | func getGitlabLintURL(gitRepoPath string) (string, error) {
 34 | 	// If a gitlab URL was given as parameter, just use it
 35 | 	if gitlabRootURL != "" {
 36 | 		return gitlabRootURL, nil
 37 | 	}
 38 | 
 39 | 	// Else, let's try to guess it, it there is a git repository
 40 | 	if gitRepoPath == "" {
 41 | 		// Warn user that we're defaulting because no git repo was found
 42 | 		yellow := color.New(color.FgYellow).SprintFunc()
 43 | 		fmt.Fprintf(color.Output, yellow("No GIT repository found, using default Gitlab API '%s'\n"), defaultGitlabRootURL)
 44 | 
 45 | 		return defaultGitlabRootURL, nil
 46 | 	}
 47 | 
 48 | 	// Extract origin remote url from repository config
 49 | 	remoteURL, err := getGitOriginRemoteURL(gitRepoPath)
 50 | 	if err != nil {
 51 | 		return defaultGitlabRootURL, fmt.Errorf("failed to find origin remote url in repository: %s", err)
 52 | 	}
 53 | 
 54 | 	// Check if we can use the origin remote url
 55 | 	if remoteURL != "" {
 56 | 		// Guess gitlab url based on remote url
 57 | 		localGitlabRootURL, err := guessGitlabAPIFromGitRemoteURL(remoteURL)
 58 | 		if err != nil {
 59 | 			return defaultGitlabRootURL, fmt.Errorf("no valid and responding Gitlab API URL found from repository's origin remote: %s", err)
 60 | 		}
 61 | 		return localGitlabRootURL, nil
 62 | 	}
 63 | 
 64 | 	// Warn user that we're defaulting because no origin remote was found
 65 | 	yellow := color.New(color.FgYellow).SprintFunc()
 66 | 	fmt.Fprintf(color.Output, yellow("No origin remote found in repository, using default Gitlab API '%s'\n"), gitlabRootURL)
 67 | 
 68 | 	return defaultGitlabRootURL, nil
 69 | }
 70 | 
 71 | // 'check' command of the program, which is the main action
 72 | // It aims to validate the syntax of a .gitlab-ci.yml file, using the CI Lint API of a Gitlab instance
 73 | // First it search for a gitlab-ci file if no one is given
 74 | // Then it search for a .git repository directory
 75 | // If a .git repository is found, its origin remote is analysed to extract and guess a the Gitlab root url to use for
 76 | // the API. If no valid origin remote or API is found, the defaultGitlabRootURL is used
 77 | // Finally, it call the API with the gitlab-ci file content. If the content if syntax valid, it silently stop. Else it
 78 | // display the error messages returned by the API and exit with an error
 79 | func commandCheck(c *cli.Context) error {
 80 | 
 81 | 	if c.Args().Present() && c.Args().Get(0) != "" {
 82 | 		processPathArgument(c.Args().Get(0))
 83 | 	}
 84 | 
 85 | 	if verboseMode {
 86 | 		fmt.Printf("Settings:\n  directoryRoot: %s\n  gitlabCiFilePath: %s\n", directoryRoot, gitlabCiFilePath)
 87 | 	}
 88 | 
 89 | 	// Find gitlab-ci file, if not given
 90 | 	if gitlabCiFilePath == "" {
 91 | 		file, err := findGitlabCiFile(directoryRoot)
 92 | 		if err != nil {
 93 | 			fmt.Println("No gitlab-ci file found")
 94 | 			return nil
 95 | 		}
 96 | 		gitlabCiFilePath = file
 97 | 	}
 98 | 
 99 | 	cwd, _ := os.Getwd()
100 | 	relativeGitlabCiFilePath, _ := filepath.Rel(cwd, gitlabCiFilePath)
101 | 
102 | 	// Find git repository. First, start from gitlab-ci file location
103 | 	gitRepoPath, err := findGitRepo(filepath.Dir(gitlabCiFilePath))
104 | 	if err == nil {
105 | 		// if not found, search from directoryRoot
106 | 		gitRepoPath, _ = findGitRepo(directoryRoot)
107 | 	}
108 | 
109 | 	localGitlabLintURL, err := getGitlabLintURL(gitRepoPath)
110 | 	if err != nil {
111 | 		return cli.Exit(err, 5)
112 | 	}
113 | 
114 | 	fmt.Printf("Validating %s... ", relativeGitlabCiFilePath)
115 | 
116 | 	if verboseMode {
117 | 		fmt.Printf("\n")
118 | 	}
119 | 
120 | 	// Call the API to validate the gitlab-ci file
121 | 	ciFileContent, err := os.ReadFile(gitlabCiFilePath)
122 | 	if err != nil {
123 | 		return cli.Exit(fmt.Sprintf("error while reading '%s' file content: %s", relativeGitlabCiFilePath, err), 5)
124 | 	}
125 | 
126 | 	status, errorMessages, err := lintGitlabCIUsingAPI(localGitlabLintURL, string(ciFileContent))
127 | 	if err != nil {
128 | 		return cli.Exit(fmt.Errorf("error linting using Gitlab API %s: %w", localGitlabLintURL, err), 5)
129 | 	}
130 | 
131 | 	if !status {
132 | 		if verboseMode {
133 | 			fmt.Printf("%s ", relativeGitlabCiFilePath)
134 | 		}
135 | 
136 | 		red := color.New(color.FgRed).SprintFunc()
137 | 		fmt.Fprintf(color.Output, "%s\n", red("KO"))
138 | 
139 | 		messages := red(strings.Join(errorMessages, "\n"))
140 | 		fmt.Fprintf(os.Stderr, "%s\n", messages)
141 | 
142 | 		return cli.Exit("", 10)
143 | 	}
144 | 
145 | 	if verboseMode {
146 | 		fmt.Printf("%s ", relativeGitlabCiFilePath)
147 | 	}
148 | 	green := color.New(color.FgGreen).SprintFunc()
149 | 	fmt.Fprintf(color.Output, "%s\n", green("OK"))
150 | 
151 | 	return nil
152 | }
153 | 


--------------------------------------------------------------------------------
/cmd_install.go:
--------------------------------------------------------------------------------
 1 | // Copyright © 2017-2020 Olivier Robardet
 2 | //
 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | // of this software and associated documentation files (the "Software"), to deal
 5 | // in the Software without restriction, including without limitation the rights
 6 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | // copies of the Software, and to permit persons to whom the Software is
 8 | // furnished to do so, subject to the following conditions:
 9 | //
10 | // The above copyright notice and this permission notice shall be included in
11 | // all copies or substantial portions of the Software.
12 | //
13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | // THE SOFTWARE.
20 | 
21 | package main
22 | 
23 | import (
24 | 	"fmt"
25 | 	"path/filepath"
26 | 
27 | 	"github.com/fatih/color"
28 | 	"github.com/urfave/cli/v2"
29 | )
30 | 
31 | // 'install' command of the program
32 | func commandInstall(c *cli.Context) error {
33 | 
34 | 	if c.Args().Present() && c.Args().Get(0) != "" {
35 | 		processPathArgument(c.Args().Get(0))
36 | 	}
37 | 
38 | 	// Find git repository. First, start from gitlab-ci file location
39 | 	gitRepoPath, err := findGitRepo(filepath.Dir(gitlabCiFilePath))
40 | 	if err == nil {
41 | 		// if not found, search from directoryRoot
42 | 		gitRepoPath, _ = findGitRepo(directoryRoot)
43 | 	}
44 | 
45 | 	if gitRepoPath == "" {
46 | 		return cli.Exit("No GIT repository found, can't install a hook", 5)
47 | 	}
48 | 	if verboseMode {
49 | 		fmt.Printf("Git repository found: %s\n", gitRepoPath)
50 | 	}
51 | 
52 | 	// Extract origin remote url from repository config
53 | 	remoteURL, err := getGitOriginRemoteURL(gitRepoPath)
54 | 	if err != nil {
55 | 		return cli.Exit(fmt.Sprintf("Failed to find origin remote url in repository: %s", err), 5)
56 | 	}
57 | 
58 | 	// Check if we can use the origin remote url
59 | 	if remoteURL != "" {
60 | 		// Guess gitlab url based on remote url
61 | 		_, err = guessGitlabAPIFromGitRemoteURL(remoteURL)
62 | 		if err != nil {
63 | 			return cli.Exit("No valid and responding Gitlab API URL found from repository's origin remote, can't install a hook", 5)
64 | 		}
65 | 	} else if verboseMode {
66 | 		// Warn user that we're defaulting because no origin remote was found
67 | 		yellow := color.New(color.FgYellow).SprintFunc()
68 | 		fmt.Fprintf(color.Output, yellow("No origin remote found in repository, will be using default Gitlab API '%s'\n"), gitlabRootURL)
69 | 	}
70 | 
71 | 	status, err := createGitHookLink(gitRepoPath, "pre-commit")
72 | 	if err != nil {
73 | 		return cli.Exit(err, 5)
74 | 	}
75 | 	switch status {
76 | 	case HookAlreadyExists:
77 | 		yellow := color.New(color.FgYellow).SprintFunc()
78 | 		msg := yellow("A pre-commit hook already exists\nPlease install manually by adding a call to me in your pre-commit script.")
79 | 		return cli.Exit(msg, 4)
80 | 	case HookAlreadyCreated:
81 | 		cyan := color.New(color.FgCyan).SprintFunc()
82 | 		fmt.Fprintf(color.Output, "%s\n", cyan("Already installed."))
83 | 	case HookCreated:
84 | 		green := color.New(color.FgGreen).SprintFunc()
85 | 		fmt.Fprintf(color.Output, "%s\n", green(fmt.Sprintf("Git pre-commit hook installed in %s", filepath.Dir(gitRepoPath))))
86 | 	default:
87 | 		return cli.Exit("Unkown error", 5)
88 | 	}
89 | 
90 | 	return nil
91 | }
92 | 


--------------------------------------------------------------------------------
/cmd_uninstall.go:
--------------------------------------------------------------------------------
 1 | // Copyright © 2017-2020 Olivier Robardet
 2 | //
 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | // of this software and associated documentation files (the "Software"), to deal
 5 | // in the Software without restriction, including without limitation the rights
 6 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | // copies of the Software, and to permit persons to whom the Software is
 8 | // furnished to do so, subject to the following conditions:
 9 | //
10 | // The above copyright notice and this permission notice shall be included in
11 | // all copies or substantial portions of the Software.
12 | //
13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | // THE SOFTWARE.
20 | 
21 | package main
22 | 
23 | import (
24 | 	"fmt"
25 | 	"path/filepath"
26 | 
27 | 	"github.com/fatih/color"
28 | 	"github.com/urfave/cli/v2"
29 | )
30 | 
31 | // 'uninstall' command of the program
32 | func commandUninstall(c *cli.Context) error {
33 | 
34 | 	if c.Args().Present() && c.Args().Get(0) != "" {
35 | 		processPathArgument(c.Args().Get(0))
36 | 	}
37 | 
38 | 	// Find git repository. First, start from gitlab-ci file location
39 | 	gitRepoPath, err := findGitRepo(filepath.Dir(gitlabCiFilePath))
40 | 	if err == nil {
41 | 		// if not found, search from directoryRoot
42 | 		gitRepoPath, _ = findGitRepo(directoryRoot)
43 | 	}
44 | 
45 | 	if gitRepoPath == "" {
46 | 		return cli.Exit("No GIT repository found, can't install a hook", 5)
47 | 	}
48 | 	if verboseMode {
49 | 		fmt.Printf("Git repository found: %s\n", gitRepoPath)
50 | 	}
51 | 
52 | 	status, err := deleteGitHookLink(gitRepoPath, "pre-commit")
53 | 	if err != nil {
54 | 		return cli.Exit(err, 5)
55 | 	}
56 | 	switch status {
57 | 	case HookNotMatching:
58 | 		red := color.New(color.FgRed).SprintFunc()
59 | 		return cli.Exit(red("Unknown pre-commit hook\nPlease uninstall manually."), 4)
60 | 	case HookNotExisting:
61 | 		yellow := color.New(color.FgYellow).SprintFunc()
62 | 		fmt.Fprintf(color.Output, "%s\n", yellow("No pre-commit hook found."))
63 | 	case HookDeleted:
64 | 		green := color.New(color.FgGreen).SprintFunc()
65 | 		fmt.Fprintf(color.Output, "%s\n", green("Git pre-commit hook uninstalled."))
66 | 	default:
67 | 		return cli.Exit("Unknown error", 5)
68 | 	}
69 | 
70 | 	return nil
71 | }
72 | 


--------------------------------------------------------------------------------
/config/config.go:
--------------------------------------------------------------------------------
 1 | // Package config contains the internal configuration of the program.
 2 | package config
 3 | 
 4 | // APPNAME contains the application name
 5 | var APPNAME = "gitlab-ci-linter"
 6 | 
 7 | // VERSION contains the version of the program
 8 | var VERSION = "2.4.0-dev"
 9 | 
10 | // REVISION contains the revision of the program
11 | var REVISION = "HEAD"
12 | 
13 | // BUILDTIME contains the build date and time of the program
14 | var BUILDTIME = ""
15 | 


--------------------------------------------------------------------------------
/config/config_test.go:
--------------------------------------------------------------------------------
 1 | package config_test
 2 | 
 3 | import (
 4 | 	"testing"
 5 | 
 6 | 	"github.com/stretchr/testify/assert"
 7 | 	"gitlab.com/orobardet/gitlab-ci-linter/config"
 8 | )
 9 | 
10 | func Test_APPNAME(t *testing.T) {
11 | 	asserter := assert.New(t)
12 | 	asserter.NotEmpty(config.APPNAME)
13 | }
14 | 
15 | func Test_VERSION(t *testing.T) {
16 | 	asserter := assert.New(t)
17 | 	asserter.NotEmpty(config.VERSION)
18 | }
19 | 
20 | func Test_REVISION(t *testing.T) {
21 | 	asserter := assert.New(t)
22 | 	asserter.NotEmpty(config.REVISION)
23 | }
24 | 


--------------------------------------------------------------------------------
/doc.go:
--------------------------------------------------------------------------------
 1 | // Copyright © 2018-2020 Olivier Robardet
 2 | //
 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | // of this software and associated documentation files (the "Software"), to deal
 5 | // in the Software without restriction, including without limitation the rights
 6 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | // copies of the Software, and to permit persons to whom the Software is
 8 | // furnished to do so, subject to the following conditions:
 9 | //
10 | // The above copyright notice and this permission notice shall be included in
11 | // all copies or substantial portions of the Software.
12 | //
13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | // THE SOFTWARE.
20 | 
21 | // This command line tool use the Gitlab API to validate your local `.gitlab-ci.yml`.
22 | // It can be installed as a git pre-commit hook, preventing commit (and so push) of an invalid `.gitlab-ci.yml`.
23 | //
24 | // The tool itself does not lint anything: it uses the lint API of a Gitlab instance => it needs to be run somewhere with an access to the Gitlab instance where your project come from.
25 | //
26 | //	Goodbye "yaml invalid" pipeline errors, and don't come back!
27 | package main
28 | 


--------------------------------------------------------------------------------
/doc/pages/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html>
 3 | <head>
 4 |     <meta charset="utf-8">
 5 |     <meta name="generator" content="GitLab Pages">
 6 |     <title>gitlab-ci-linter</title>
 7 |     <link rel="stylesheet" href="style.css">
 8 | </head>
 9 | <body>
10 | <div class="navbar">
11 |     <a href="coverage/all.html">💉 Code coverage</a>
12 |     <a href="godoc/index.html">📖 Godoc</a>
13 | </div>
14 | 
15 | <div class="main-content">
16 |     <h1>gitlab-ci-linter</h1>
17 | 
18 |     <p>
19 |         <div class="code">
20 |         Goodbye "yaml invalid" pipeline errors, and don't come back!
21 |         </div>
22 |     </p>
23 |     <p>
24 |         This tool use the <a hreg="https://docs.gitlab.com/ce/api/ci/lint.html">Gitlab API</a> to validate your local <span class="code">.gitlab-ci.yml</span>.<br/>
25 |         It can be installed as a git pre-commit hook, preventing commit (and so push) of an invalid <span class="code">.gitlab-ci.yml</span>.<br/>
26 |         <br/>
27 |         <b>The tool itself does not lint anything: it uses the lint API of a Gitlab instance => it needs to be run somewhere with an access to the Gitlab instance where your project come from.</b>
28 |     <br/>
29 |     <ul>
30 |         <li><a href="coverage/all.html">💉 Code coverage</a></li>
31 |         <li><a href="godoc/index.html">📖 Godoc</a></li>
32 |     </ul>
33 |     </p>
34 | </div>
35 | 
36 | <div class="footer">
37 |     <a href="https://gitlab.com/orobardet/gitlab-ci-linter">⌨️ code on Gitlab</a>
38 | </div>
39 | </body>
40 | </html>
41 | 


--------------------------------------------------------------------------------
/doc/pages/style.css:
--------------------------------------------------------------------------------
 1 | html,body {
 2 |     padding: 0;
 3 |     margin: 0;
 4 | }
 5 | 
 6 | .navbar {
 7 |     background-color: #333;
 8 | }
 9 | 
10 | .navbar a {
11 |     padding: 10px 15px;
12 |     color: #AAA;
13 |     display: inline-block;
14 |     font-size: 15px;
15 |     text-decoration: none;
16 | }
17 | 
18 | .navbar a:hover {
19 |     background-color: white;
20 |     color: #333;
21 | }
22 | 
23 | .main-content {
24 |     font-family: sans-serif;
25 |     margin: auto;
26 |     max-width: 1280px;
27 |     padding: 10px;
28 | }
29 | 
30 | .main-content a {
31 |     color: #5279C7;
32 |     text-decoration: none;
33 | }
34 | .main-content a:hover {
35 |     color: #5158a5;
36 |     text-decoration: underline dotted;
37 | }
38 | 
39 | .footer {
40 |     padding: 10px 15px;
41 |     margin-top: 20px;
42 |     text-align: center;
43 |     color: #AAA;
44 |     font-size: 12px;
45 | }
46 | 
47 | .footer a {
48 |     color: #AAA;
49 |     text-decoration: none;
50 | }
51 | 
52 | .code {
53 |     font-family: monospace;
54 |     color: #1F1F1F;
55 |     background-color: #F2F2F2;
56 |     word-break: keep-all;
57 |     padding: 2px 4px;
58 |     border-radius: 4px;
59 | }
60 | span.code {
61 |     font-weight: inherit;
62 |     display: inline-block;
63 | }
64 | div.code {
65 |     font-weight: inherit;
66 |     padding: 5px;
67 |     margin: 5px 0px;
68 | }


--------------------------------------------------------------------------------
/doc/screen-hook-ko.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/orobardet/gitlab-ci-linter/c00efcbb2477f08dd0610075f46991669f85aea3/doc/screen-hook-ko.png


--------------------------------------------------------------------------------
/doc/screen-standalone-ko.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/orobardet/gitlab-ci-linter/c00efcbb2477f08dd0610075f46991669f85aea3/doc/screen-standalone-ko.png


--------------------------------------------------------------------------------
/doc/screen-standalone-ok.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/orobardet/gitlab-ci-linter/c00efcbb2477f08dd0610075f46991669f85aea3/doc/screen-standalone-ok.png


--------------------------------------------------------------------------------
/git.go:
--------------------------------------------------------------------------------
  1 | // Copyright © 2017-2020 Olivier Robardet
  2 | //
  3 | // Permission is hereby granted, free of charge, to any person obtaining a copy
  4 | // of this software and associated documentation files (the "Software"), to deal
  5 | // in the Software without restriction, including without limitation the rights
  6 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7 | // copies of the Software, and to permit persons to whom the Software is
  8 | // furnished to do so, subject to the following conditions:
  9 | //
 10 | // The above copyright notice and this permission notice shall be included in
 11 | // all copies or substantial portions of the Software.
 12 | //
 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 18 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 19 | // THE SOFTWARE.
 20 | 
 21 | package main
 22 | 
 23 | import (
 24 | 	"errors"
 25 | 	"os"
 26 | 	"path"
 27 | 	"path/filepath"
 28 | 	"regexp"
 29 | 	"strings"
 30 | 
 31 | 	"github.com/go-ini/ini"
 32 | )
 33 | 
 34 | // Name of the git repo directory
 35 | const gitRepoDirectory = ".git"
 36 | 
 37 | // Name of the git repo config file in a git repo directory
 38 | const gitRepoConfigFilename = "config"
 39 | 
 40 | // Search in the given directory a git repository directory
 41 | // It goes up in the filesystem hierarchy until a repository is found, or the root is reach
 42 | // A git repository directory is a '.git' folder (gitRepoDirectory constant) containing a 'config' file
 43 | // (gitRepoConfigFilename constant)
 44 | func findGitRepo(directory string) (string, error) {
 45 | 	candidate := path.Join(directory, gitRepoDirectory)
 46 | 
 47 | 	fileInfo, err := os.Stat(candidate)
 48 | 	if !os.IsNotExist(err) && fileInfo.IsDir() {
 49 | 		// Found a git directory, check of it has a config file
 50 | 		fileInfo, err = os.Stat(path.Join(candidate, gitRepoConfigFilename))
 51 | 
 52 | 		if !os.IsNotExist(err) && !fileInfo.IsDir() {
 53 | 			return candidate, nil
 54 | 		}
 55 | 	}
 56 | 
 57 | 	// If we are at the root of the filesystem, it means we did not find any gitlab-ci file
 58 | 	if directory[len(directory)-1] == filepath.Separator {
 59 | 		return "", errors.New("not found")
 60 | 	}
 61 | 
 62 | 	return findGitRepo(filepath.Dir(directory))
 63 | }
 64 | 
 65 | // Load git config file from git repository directory
 66 | func loadGitCfg(gitDirectory string) (*ini.File, error) {
 67 | 	cfg, err := ini.Load(path.Join(gitDirectory, gitRepoConfigFilename))
 68 | 	if err != nil {
 69 | 		return nil, err
 70 | 	}
 71 | 
 72 | 	return cfg, nil
 73 | }
 74 | 
 75 | // Extract the origin remote url from a git config file
 76 | func getGitOriginRemoteURL(gitDirectory string) (string, error) {
 77 | 	cfg, err := loadGitCfg(gitDirectory)
 78 | 	if err != nil {
 79 | 		return "", err
 80 | 	}
 81 | 
 82 | 	remote, err := cfg.GetSection("remote \"origin\"")
 83 | 	if err == nil && remote.HasKey("url") {
 84 | 		return remote.Key("url").String(), nil
 85 | 	}
 86 | 
 87 | 	return "", nil
 88 | }
 89 | 
 90 | // Transform a git remote url, that can be a full http ou ssh url, to a simple http FQDN host
 91 | // Returns the root URL, and the project path.
 92 | // e.g.: a remote "https://gitlab.com/orobardet/gitlab-ci-linter.git" or
 93 | // "git@gitlab.com:orobardet/gitlab-ci-linter.git" will both returns "https://gitlab.com", "orobardet/gitlab-ci-linter"
 94 | func parseGitRemoteURL(remoteURL string) (string, string) {
 95 | 	re := regexp.MustCompile(`^(https?://[^/]*)(.*?)(?:\.git)?$`)
 96 | 	if re.MatchString(remoteURL) { // http remote
 97 | 		matches := re.FindStringSubmatch(remoteURL)
 98 | 		if len(matches) >= 2 {
 99 | 			return matches[1], strings.TrimLeft(matches[2], "/")
100 | 		}
101 | 	} else { // ssh remote
102 | 		re = regexp.MustCompile(`^([^@]*@)?([^:]+):(.*?)(?:\.git)?$`)
103 | 		matches := re.FindStringSubmatch(remoteURL)
104 | 		if len(matches) >= 3 {
105 | 			return "https://" + matches[2], strings.TrimLeft(matches[3], "/")
106 | 		}
107 | 	}
108 | 
109 | 	return "", ""
110 | }
111 | 
112 | // GetCurrentBranch returns the current branch name of the git repository by reading the .git/HEAD file.
113 | // If the repository is in detached HEAD mode, it returns an empty string.
114 | func GetCurrentBranch(gitDirectory string) (string, error) {
115 | 	headFilePath := filepath.Join(gitDirectory, "HEAD")
116 | 	content, err := os.ReadFile(headFilePath)
117 | 	if err != nil {
118 | 		return "", err
119 | 	}
120 | 	headContent := strings.TrimSpace(string(content))
121 | 	if strings.HasPrefix(headContent, "ref: refs/heads/") {
122 | 		return strings.TrimPrefix(headContent, "ref: refs/heads/"), nil
123 | 	}
124 | 
125 | 	return "", nil
126 | }
127 | 


--------------------------------------------------------------------------------
/git_test.go:
--------------------------------------------------------------------------------
 1 | // Copyright © 2017-2020 Olivier Robardet
 2 | //
 3 | // Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | // of this software and associated documentation files (the "Software"), to deal
 5 | // in the Software without restriction, including without limitation the rights
 6 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | // copies of the Software, and to permit persons to whom the Software is
 8 | // furnished to do so, subject to the following conditions:
 9 | //
10 | // The above copyright notice and this permission notice shall be included in
11 | // all copies or substantial portions of the Software.
12 | //
13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 | // THE SOFTWARE.
20 | 
21 | package main
22 | 
23 | import (
24 | 	"testing"
25 | )
26 | 
27 | var httpiseRemoteURLData = [][]string{
28 | 	{"http://gitlab.com", "http://gitlab.com", ""},
29 | 	{"https://gitlab.com", "https://gitlab.com", ""},
30 | 	{"http://gitlab.com/my/project", "http://gitlab.com", "my/project"},
31 | 	{"https://gitlab.com/my/project", "https://gitlab.com", "my/project"},
32 | 	{"http://my.company-forge.com/", "http://my.company-forge.com", ""},
33 | 	{"https://my.company-forge.com", "https://my.company-forge.com", ""},
34 | 	{"http://my.company-forge.com/my/project", "http://my.company-forge.com", "my/project"},
35 | 	{"https://my.company-forge.com/my/project", "https://my.company-forge.com", "my/project"},
36 | 	{"git@gitlab.com:my/project", "https://gitlab.com", "my/project"},
37 | 	{"git@my.company-forge.com:my/project", "https://my.company-forge.com", "my/project"},
38 | 	{"gitlab.com:my/project", "https://gitlab.com", "my/project"},
39 | 	{"my.company-forge.com:my/project", "https://my.company-forge.com", "my/project"},
40 | 	{"https://gitlab.com/my/long/namespace/with/project", "https://gitlab.com", "my/long/namespace/with/project"},
41 | 	{"git@gitlab.com:my/long/namespace/with/project", "https://gitlab.com", "my/long/namespace/with/project"},
42 | 	{"https://gitlab.com/my/project.git", "https://gitlab.com", "my/project"},
43 | 	{"git@gitlab.com:my/project.git", "https://gitlab.com", "my/project"},
44 | 	{"https://gitlab.com/my/long/namespace/with/project.git", "https://gitlab.com", "my/long/namespace/with/project"},
45 | 	{"git@gitlab.com:my/long/namespace/with/project.git", "https://gitlab.com", "my/long/namespace/with/project"},
46 | 	{"", "", ""},
47 | }
48 | 
49 | func TestHttpiseRemoteUrl(t *testing.T) {
50 | 
51 | 	for _, testData := range httpiseRemoteURLData {
52 | 		params := testData[0]
53 | 		expectedRoot := testData[1]
54 | 		expectedPath := testData[2]
55 | 		t.Run("url="+params, func(t *testing.T) {
56 | 			root, path := parseGitRemoteURL(params)
57 | 			if root != expectedRoot {
58 | 				t.Errorf("received root URL '%s' while expecting '%s'", root, expectedRoot)
59 | 			}
60 | 			if path != expectedPath {
61 | 				t.Errorf("received path '%s' while expecting '%s'", path, expectedPath)
62 | 			}
63 | 		})
64 | 	}
65 | }
66 | 


--------------------------------------------------------------------------------
/gitlab.go:
--------------------------------------------------------------------------------
  1 | // Copyright © 2017-2020 Olivier Robardet
  2 | //
  3 | // Permission is hereby granted, free of charge, to any person obtaining a copy
  4 | // of this software and associated documentation files (the "Software"), to deal
  5 | // in the Software without restriction, including without limitation the rights
  6 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7 | // copies of the Software, and to permit persons to whom the Software is
  8 | // furnished to do so, subject to the following conditions:
  9 | //
 10 | // The above copyright notice and this permission notice shall be included in
 11 | // all copies or substantial portions of the Software.
 12 | //
 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 18 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 19 | // THE SOFTWARE.
 20 | 
 21 | package main
 22 | 
 23 | import (
 24 | 	"encoding/json"
 25 | 	"errors"
 26 | 	"fmt"
 27 | 	"io"
 28 | 	"net"
 29 | 	"net/http"
 30 | 	"net/url"
 31 | 	"os"
 32 | 	"path"
 33 | 	"path/filepath"
 34 | 	"strings"
 35 | 	"time"
 36 | 
 37 | 	"gitlab.com/orobardet/gitlab-ci-linter/config"
 38 | )
 39 | 
 40 | // Filename of a gitlab-ci file. Used to find the gitlab-ci file if no path are given at calls
 41 | const gitlabCiFileName = ".gitlab-ci.yml"
 42 | 
 43 | // Default Gitlab instance URL to use
 44 | const defaultGitlabRootURL = "https://gitlab.com"
 45 | 
 46 | // Path of the Gitlab CI lint API, to be used on the root url
 47 | const gitlabAPIProjectsPath = "/api/v4/projects/"
 48 | const gitlabAPICiLintPath = "/ci/lint"
 49 | 
 50 | // GitlabAPILintRequest struct represents the JSON body of a request sent to the Gitlab API /ci/lint
 51 | type GitlabAPILintRequest struct {
 52 | 	Content string `json:"content"`
 53 | 	DryRun  bool   `json:"dry_run"`
 54 | 	Ref     string `json:"ref"`
 55 | }
 56 | 
 57 | // GitlabAPILintResponse struct represents the JSON body of a response from the Gitlab API /ci/lint
 58 | type GitlabAPILintResponse struct {
 59 | 	MergedYaml string   `json:"merged_yaml,omitempty"`
 60 | 	Warnings   []string `json:"warnings,omitempty"`
 61 | 	Errors     []string `json:"errors,omitempty"`
 62 | 	Valid      bool     `json:"valid,omitempty"`
 63 | }
 64 | 
 65 | // Search in the given directory a git repository directory
 66 | // It goes up in the filesystem hierarchy until a repository is found, or the root is reach
 67 | func findGitlabCiFile(directory string) (string, error) {
 68 | 	candidate := path.Join(directory, gitlabCiFileName)
 69 | 
 70 | 	fileInfo, err := os.Stat(candidate)
 71 | 	if !os.IsNotExist(err) && !fileInfo.IsDir() {
 72 | 		return candidate, nil
 73 | 	}
 74 | 
 75 | 	// If we are at the root of the filesystem, it means we did not find any gitlab-ci file
 76 | 	if directory[len(directory)-1] == filepath.Separator {
 77 | 		return "", errors.New("not found")
 78 | 	}
 79 | 
 80 | 	return findGitlabCiFile(filepath.Dir(directory))
 81 | }
 82 | 
 83 | func initGitlabHTTPClientRequest(method string, gitlabURL string, content string) (*http.Client, *http.Request, error) {
 84 | 	var httpClient *http.Client
 85 | 	var req *http.Request
 86 | 
 87 | 	httpClient = &http.Client{
 88 | 		Transport: &http.Transport{
 89 | 			Proxy: http.ProxyFromEnvironment,
 90 | 			DialContext: (&net.Dialer{
 91 | 				Timeout:   30 * time.Second,
 92 | 				KeepAlive: 30 * time.Second,
 93 | 			}).DialContext,
 94 | 			ForceAttemptHTTP2:     false,
 95 | 			MaxIdleConns:          100,
 96 | 			IdleConnTimeout:       90 * time.Second,
 97 | 			TLSHandshakeTimeout:   10 * time.Second,
 98 | 			ExpectContinueTimeout: 1 * time.Second,
 99 | 		},
100 | 		Timeout: time.Second * time.Duration(httpRequestTimeout),
101 | 	}
102 | 
103 | 	req, err := http.NewRequest(method, gitlabURL, strings.NewReader(content))
104 | 	if err != nil {
105 | 		return nil, nil, err
106 | 	}
107 | 	req.Header.Add("Accept", "*/*")
108 | 	req.Header.Add("Content-Type", "application/json")
109 | 	req.Header.Add("User-Agent", fmt.Sprintf("%s/%s", config.APPNAME, config.VERSION))
110 | 	if personalAccessToken != "" {
111 | 		req.Header.Add("PRIVATE-TOKEN", personalAccessToken)
112 | 	} else if useNetrc {
113 | 		// Check if we can find a token in .netrc
114 | 		if verboseMode {
115 | 			fmt.Println("Checking .netrc for token...")
116 | 		}
117 | 		token, err := getGitlabTokenFromNetrc(gitlabURL)
118 | 
119 | 		if err != nil {
120 | 			return nil, nil, err
121 | 		} else if token != "" {
122 | 			if verboseMode {
123 | 				fmt.Println("Token found in .netrc")
124 | 			}
125 | 			req.Header.Add("PRIVATE-TOKEN", token)
126 | 		} else {
127 | 			fmt.Println("No token found in .netrc")
128 | 		}
129 | 	}
130 | 
131 | 	return httpClient, req, nil
132 | }
133 | 
134 | // Check if we can get a response with the rootUrl on the API CI Lint endpoint, and if a redirection occurs
135 | // If a redirection is detected, return the redirected URL.
136 | // This is needed as redirection response only occurs when the API is call using en HTTP GET, but in the en the API
137 | // has to be called in POST
138 | func checkGitlabAPIUrl(rootURL string, lintURL string, apiCIEndpoint string) (string, error) {
139 | 
140 | 	newLintURL := lintURL
141 | 
142 | 	if verboseMode {
143 | 		fmt.Printf("Checking '%s' (using '%s')...\n", rootURL, lintURL)
144 | 	}
145 | 
146 | 	httpClient, req, err := initGitlabHTTPClientRequest("GET", lintURL, "")
147 | 	if err != nil {
148 | 		return newLintURL, fmt.Errorf("unable to create an HTTP client: %w", err)
149 | 	}
150 | 
151 | 	resp, err := httpClient.Do(req)
152 | 
153 | 	if err != nil {
154 | 		fmt.Printf("%+v\n", req.Header)
155 | 		return newLintURL, fmt.Errorf("HTTP request error: %w", err)
156 | 	}
157 | 	defer resp.Body.Close()
158 | 
159 | 	// Getting the full URL used for the last query, after following potential redirection
160 | 	lastURL := resp.Request.URL.String()
161 | 
162 | 	// Let's try to get the redirected root URL by removing the gitlab API path from the last use URL
163 | 	lastRootURL := strings.TrimSuffix(lastURL, apiCIEndpoint)
164 | 	// If the result is not empty or unchanged, it means there were redirects
165 | 	if lastRootURL != "" && lastRootURL != lastURL {
166 | 		newLintURL, err = url.JoinPath(lastRootURL, apiCIEndpoint)
167 | 		if err != nil {
168 | 			return newLintURL, err
169 | 		}
170 | 	}
171 | 
172 | 	if resp.StatusCode != 200 {
173 | 		return newLintURL, fmt.Errorf("HTTP request failed with status %s", resp.Status)
174 | 	}
175 | 
176 | 	if verboseMode {
177 | 		fmt.Printf("Url '%s' validated\n", newLintURL)
178 | 	}
179 | 
180 | 	return newLintURL, nil
181 | }
182 | 
183 | // Send the content of a gitlab-ci file to a Gitlab instance lint API to check its validity
184 | // In case of invalid, lint error messages are returned in `msgs`
185 | func lintGitlabCIUsingAPI(lintURL string, ciFileContent string) (status bool, msgs []string, err error) {
186 | 
187 | 	msgs = []string{}
188 | 	status = false
189 | 
190 | 	// Prepare the JSON content of the POST request:
191 | 	// {
192 | 	//   "content": "<ESCAPED CONTENT OF THE GITLAB-CI FILE>"
193 | 	// }
194 | 	if dryRunRef == "" {
195 | 		if dryRunRef == "" {
196 | 			// Find git repository. First, start from gitlab-ci file location
197 | 			gitRepoPath, err := findGitRepo(filepath.Dir(gitlabCiFilePath))
198 | 			if err == nil {
199 | 				// if not found, search from directoryRoot
200 | 				gitRepoPath, _ = findGitRepo(directoryRoot)
201 | 			}
202 | 			dryRunRef, _ = GetCurrentBranch(gitRepoPath)
203 | 		}
204 | 	}
205 | 	var reqParams = GitlabAPILintRequest{
206 | 		Content: ciFileContent,
207 | 		DryRun:  dryRun,
208 | 		Ref:     dryRunRef,
209 | 	}
210 | 	reqBody, _ := json.Marshal(reqParams)
211 | 
212 | 	// Prepare requesting the API
213 | 	if verboseMode {
214 | 		fmt.Printf("Querying %s...\n", lintURL)
215 | 	}
216 | 	httpClient, req, err := initGitlabHTTPClientRequest("POST", lintURL, string(reqBody))
217 | 	if err != nil {
218 | 		err = fmt.Errorf("unable to create an HTTP client: %w", err)
219 | 		return
220 | 	}
221 | 
222 | 	// Make the request to the API
223 | 	resp, err := httpClient.Do(req)
224 | 	if err != nil {
225 | 		err = fmt.Errorf("HTTP request error: %w", err)
226 | 		return
227 | 	}
228 | 	defer resp.Body.Close()
229 | 
230 | 	if resp.StatusCode != 200 {
231 | 		err = fmt.Errorf("HTTP request failed with status %s", resp.Status)
232 | 		return
233 | 	}
234 | 
235 | 	// Get the results
236 | 	body, err := io.ReadAll(resp.Body)
237 | 	if err != nil {
238 | 		err = fmt.Errorf("unable to parse response: %w", err)
239 | 		return
240 | 	}
241 | 	var result GitlabAPILintResponse
242 | 	err = json.Unmarshal([]byte(body), &result)
243 | 	if err != nil {
244 | 		err = fmt.Errorf("unable to parse JSON response: %w", err)
245 | 		return
246 | 	}
247 | 
248 | 	if includeMergedYaml && result.MergedYaml != "" {
249 | 		fmt.Printf("Merged yaml: %s\n", result.MergedYaml)
250 | 	}
251 | 
252 | 	// Analyse the results
253 | 	if result.Valid {
254 | 		status = true
255 | 		err = nil
256 | 		return
257 | 	}
258 | 
259 | 	if !result.Valid {
260 | 		msgs = result.Errors
261 | 	}
262 | 
263 | 	return
264 | }
265 | 
266 | func computeGitlabProjectPath(path string) string {
267 | 	if projectID != "" {
268 | 		return projectID
269 | 	}
270 | 
271 | 	if projectPath != "" {
272 | 		return url.QueryEscape(projectPath)
273 | 	}
274 | 
275 | 	return url.QueryEscape(path)
276 | }
277 | 
278 | func guessGitlabAPIFromGitRemoteURL(remoteURL string) (lintURL string, err error) {
279 | 	rootURL, prjPath := parseGitRemoteURL(remoteURL)
280 | 
281 | 	prjPath = computeGitlabProjectPath(prjPath)
282 | 	if prjPath == "" {
283 | 		return "", errors.New("unable to determine Gitlab project path, you can use --project-path|-P|$GCL_PROJECT_PATH or --project-id|-I|$GCL_PROJECT_ID, to give the path or ID of your Gitlab project")
284 | 	}
285 | 
286 | 	apiCIEndpoint, err := url.JoinPath(gitlabAPIProjectsPath, prjPath, gitlabAPICiLintPath)
287 | 	if err != nil {
288 | 		return "", err
289 | 	}
290 | 
291 | 	lintURL, err = url.JoinPath(rootURL, apiCIEndpoint)
292 | 	if err != nil {
293 | 		return "", err
294 | 	}
295 | 
296 | 	lintURL, err = checkGitlabAPIUrl(rootURL, lintURL, apiCIEndpoint)
297 | 	if err != nil {
298 | 		return "", err
299 | 	}
300 | 	if lintURL != "" {
301 | 		if verboseMode {
302 | 			fmt.Printf("API url found: %s\n", lintURL)
303 | 		}
304 | 	} else {
305 | 		return "", errors.New("unknown error occurs")
306 | 	}
307 | 
308 | 	return
309 | }
310 | 


--------------------------------------------------------------------------------
/go.mod:
--------------------------------------------------------------------------------
  1 | module gitlab.com/orobardet/gitlab-ci-linter
  2 | 
  3 | go 1.24.1
  4 | 
  5 | require (
  6 | 	github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d
  7 | 	github.com/fatih/color v1.18.0
  8 | 	github.com/go-ini/ini v1.67.0
  9 | 	github.com/mitchellh/go-homedir v1.1.0
 10 | 	github.com/stretchr/testify v1.10.0
 11 | 	github.com/urfave/cli/v2 v2.27.5
 12 | )
 13 | 
 14 | require (
 15 | 	4d63.com/gocheckcompilerdirectives v1.3.0 // indirect
 16 | 	4d63.com/gochecknoglobals v0.2.2 // indirect
 17 | 	cel.dev/expr v0.19.0 // indirect
 18 | 	cloud.google.com/go v0.116.0 // indirect
 19 | 	cloud.google.com/go/auth v0.15.0 // indirect
 20 | 	cloud.google.com/go/auth/oauth2adapt v0.2.7 // indirect
 21 | 	cloud.google.com/go/compute/metadata v0.6.0 // indirect
 22 | 	cloud.google.com/go/iam v1.2.2 // indirect
 23 | 	cloud.google.com/go/kms v1.20.1 // indirect
 24 | 	cloud.google.com/go/longrunning v0.6.2 // indirect
 25 | 	cloud.google.com/go/monitoring v1.21.2 // indirect
 26 | 	cloud.google.com/go/storage v1.49.0 // indirect
 27 | 	code.gitea.io/sdk/gitea v0.20.0 // indirect
 28 | 	dario.cat/mergo v1.0.1 // indirect
 29 | 	github.com/42wim/httpsig v1.2.1 // indirect
 30 | 	github.com/4meepo/tagalign v1.4.2 // indirect
 31 | 	github.com/Abirdcfly/dupword v0.1.3 // indirect
 32 | 	github.com/AlekSi/pointer v1.2.0 // indirect
 33 | 	github.com/Antonboom/errname v1.1.0 // indirect
 34 | 	github.com/Antonboom/nilnil v1.1.0 // indirect
 35 | 	github.com/Antonboom/testifylint v1.6.0 // indirect
 36 | 	github.com/Azure/azure-sdk-for-go v68.0.0+incompatible // indirect
 37 | 	github.com/Azure/azure-sdk-for-go/sdk/azcore v1.14.0 // indirect
 38 | 	github.com/Azure/azure-sdk-for-go/sdk/azidentity v1.7.0 // indirect
 39 | 	github.com/Azure/azure-sdk-for-go/sdk/internal v1.10.0 // indirect
 40 | 	github.com/Azure/azure-sdk-for-go/sdk/keyvault/azkeys v0.10.0 // indirect
 41 | 	github.com/Azure/azure-sdk-for-go/sdk/keyvault/internal v0.7.1 // indirect
 42 | 	github.com/Azure/azure-sdk-for-go/sdk/storage/azblob v1.3.2 // indirect
 43 | 	github.com/Azure/go-autorest v14.2.0+incompatible // indirect
 44 | 	github.com/Azure/go-autorest/autorest v0.11.29 // indirect
 45 | 	github.com/Azure/go-autorest/autorest/adal v0.9.23 // indirect
 46 | 	github.com/Azure/go-autorest/autorest/azure/auth v0.5.12 // indirect
 47 | 	github.com/Azure/go-autorest/autorest/azure/cli v0.4.6 // indirect
 48 | 	github.com/Azure/go-autorest/autorest/date v0.3.0 // indirect
 49 | 	github.com/Azure/go-autorest/autorest/to v0.4.0 // indirect
 50 | 	github.com/Azure/go-autorest/logger v0.2.1 // indirect
 51 | 	github.com/Azure/go-autorest/tracing v0.6.0 // indirect
 52 | 	github.com/AzureAD/microsoft-authentication-library-for-go v1.2.2 // indirect
 53 | 	github.com/BurntSushi/toml v1.5.0 // indirect
 54 | 	github.com/Crocmagnon/fatcontext v0.7.1 // indirect
 55 | 	github.com/Djarvur/go-err113 v0.0.0-20210108212216-aea10b59be24 // indirect
 56 | 	github.com/GaijinEntertainment/go-exhaustruct/v3 v3.3.1 // indirect
 57 | 	github.com/GoogleCloudPlatform/opentelemetry-operations-go/detectors/gcp v1.25.0 // indirect
 58 | 	github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metric v0.48.1 // indirect
 59 | 	github.com/GoogleCloudPlatform/opentelemetry-operations-go/internal/resourcemapping v0.48.1 // indirect
 60 | 	github.com/Masterminds/goutils v1.1.1 // indirect
 61 | 	github.com/Masterminds/semver/v3 v3.3.1 // indirect
 62 | 	github.com/Masterminds/sprig/v3 v3.3.0 // indirect
 63 | 	github.com/Microsoft/go-winio v0.6.2 // indirect
 64 | 	github.com/OpenPeeDeeP/depguard/v2 v2.2.1 // indirect
 65 | 	github.com/ProtonMail/go-crypto v1.1.6 // indirect
 66 | 	github.com/agnivade/levenshtein v1.2.1 // indirect
 67 | 	github.com/alecthomas/go-check-sumtype v0.3.1 // indirect
 68 | 	github.com/alessio/shellescape v1.4.2 // indirect
 69 | 	github.com/alexkohler/nakedret/v2 v2.0.5 // indirect
 70 | 	github.com/alexkohler/prealloc v1.0.0 // indirect
 71 | 	github.com/alingse/asasalint v0.0.11 // indirect
 72 | 	github.com/alingse/nilnesserr v0.1.2 // indirect
 73 | 	github.com/anchore/bubbly v0.0.0-20241107060245-f2a5536f366a // indirect
 74 | 	github.com/anchore/go-logger v0.0.0-20241005132348-65b4486fbb28 // indirect
 75 | 	github.com/anchore/go-macholibre v0.0.0-20220308212642-53e6d0aaf6fb // indirect
 76 | 	github.com/anchore/quill v0.5.1 // indirect
 77 | 	github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2 // indirect
 78 | 	github.com/ashanbrown/forbidigo v1.6.0 // indirect
 79 | 	github.com/ashanbrown/makezero v1.2.0 // indirect
 80 | 	github.com/atc0005/go-teams-notify/v2 v2.13.0 // indirect
 81 | 	github.com/aws/aws-sdk-go v1.55.6 // indirect
 82 | 	github.com/aws/aws-sdk-go-v2 v1.36.1 // indirect
 83 | 	github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.3 // indirect
 84 | 	github.com/aws/aws-sdk-go-v2/config v1.29.6 // indirect
 85 | 	github.com/aws/aws-sdk-go-v2/credentials v1.17.59 // indirect
 86 | 	github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.28 // indirect
 87 | 	github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.17.10 // indirect
 88 | 	github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.32 // indirect
 89 | 	github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.32 // indirect
 90 | 	github.com/aws/aws-sdk-go-v2/internal/ini v1.8.2 // indirect
 91 | 	github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.15 // indirect
 92 | 	github.com/aws/aws-sdk-go-v2/service/ecr v1.40.3 // indirect
 93 | 	github.com/aws/aws-sdk-go-v2/service/ecrpublic v1.31.2 // indirect
 94 | 	github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.2 // indirect
 95 | 	github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.3.17 // indirect
 96 | 	github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.13 // indirect
 97 | 	github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.17.15 // indirect
 98 | 	github.com/aws/aws-sdk-go-v2/service/kms v1.35.7 // indirect
 99 | 	github.com/aws/aws-sdk-go-v2/service/s3 v1.58.3 // indirect
100 | 	github.com/aws/aws-sdk-go-v2/service/sso v1.24.15 // indirect
101 | 	github.com/aws/aws-sdk-go-v2/service/ssooidc v1.28.14 // indirect
102 | 	github.com/aws/aws-sdk-go-v2/service/sts v1.33.14 // indirect
103 | 	github.com/aws/smithy-go v1.22.2 // indirect
104 | 	github.com/awslabs/amazon-ecr-credential-helper/ecr-login v0.9.1 // indirect
105 | 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
106 | 	github.com/bahlo/generic-list-go v0.2.0 // indirect
107 | 	github.com/beorn7/perks v1.0.1 // indirect
108 | 	github.com/bkielbasa/cyclop v1.2.3 // indirect
109 | 	github.com/blacktop/go-dwarf v1.0.10 // indirect
110 | 	github.com/blacktop/go-macho v1.1.238 // indirect
111 | 	github.com/blakesmith/ar v0.0.0-20190502131153-809d4375e1fb // indirect
112 | 	github.com/blang/semver v3.5.1+incompatible // indirect
113 | 	github.com/blizzy78/varnamelen v0.8.0 // indirect
114 | 	github.com/bluesky-social/indigo v0.0.0-20240813042137-4006c0eca043 // indirect
115 | 	github.com/bombsimon/wsl/v4 v4.6.0 // indirect
116 | 	github.com/breml/bidichk v0.3.3 // indirect
117 | 	github.com/breml/errchkjson v0.4.1 // indirect
118 | 	github.com/buger/jsonparser v1.1.1 // indirect
119 | 	github.com/butuzov/ireturn v0.3.1 // indirect
120 | 	github.com/butuzov/mirror v1.3.0 // indirect
121 | 	github.com/caarlos0/ctrlc v1.2.0 // indirect
122 | 	github.com/caarlos0/env/v11 v11.3.1 // indirect
123 | 	github.com/caarlos0/go-reddit/v3 v3.0.1 // indirect
124 | 	github.com/caarlos0/go-shellwords v1.0.12 // indirect
125 | 	github.com/caarlos0/go-version v0.2.0 // indirect
126 | 	github.com/caarlos0/log v0.4.8 // indirect
127 | 	github.com/carlmjohnson/versioninfo v0.22.5 // indirect
128 | 	github.com/catenacyber/perfsprint v0.9.1 // indirect
129 | 	github.com/cavaliergopher/cpio v1.0.1 // indirect
130 | 	github.com/ccojocar/zxcvbn-go v1.0.2 // indirect
131 | 	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
132 | 	github.com/census-instrumentation/opencensus-proto v0.4.1 // indirect
133 | 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
134 | 	github.com/charithe/durationcheck v0.0.10 // indirect
135 | 	github.com/charmbracelet/bubbletea v1.3.0 // indirect
136 | 	github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc // indirect
137 | 	github.com/charmbracelet/lipgloss v1.1.0 // indirect
138 | 	github.com/charmbracelet/x/ansi v0.8.0 // indirect
139 | 	github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd // indirect
140 | 	github.com/charmbracelet/x/term v0.2.1 // indirect
141 | 	github.com/chavacava/garif v0.1.0 // indirect
142 | 	github.com/chrismellard/docker-credential-acr-env v0.0.0-20230304212654-82a0ddb27589 // indirect
143 | 	github.com/ckaznocha/intrange v0.3.1 // indirect
144 | 	github.com/cloudflare/circl v1.3.8 // indirect
145 | 	github.com/cncf/xds/go v0.0.0-20240905190251-b4127c9b8d78 // indirect
146 | 	github.com/containerd/stargz-snapshotter/estargz v0.16.3 // indirect
147 | 	github.com/cpuguy83/go-md2man/v2 v2.0.6 // indirect
148 | 	github.com/curioswitch/go-reassign v0.3.0 // indirect
149 | 	github.com/cyberphone/json-canonicalization v0.0.0-20231011164504-785e29786b46 // indirect
150 | 	github.com/cyphar/filepath-securejoin v0.3.6 // indirect
151 | 	github.com/daixiang0/gci v0.13.6 // indirect
152 | 	github.com/dave/dst v0.27.3 // indirect
153 | 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
154 | 	github.com/davidmz/go-pageant v1.0.2 // indirect
155 | 	github.com/denis-tingaikin/go-header v0.5.0 // indirect
156 | 	github.com/dghubble/go-twitter v0.0.0-20211115160449-93a8679adecb // indirect
157 | 	github.com/dghubble/oauth1 v0.7.3 // indirect
158 | 	github.com/dghubble/sling v1.4.0 // indirect
159 | 	github.com/dimchansky/utfbom v1.1.1 // indirect
160 | 	github.com/distribution/reference v0.6.0 // indirect
161 | 	github.com/docker/cli v27.5.0+incompatible // indirect
162 | 	github.com/docker/distribution v2.8.3+incompatible // indirect
163 | 	github.com/docker/docker v27.5.0+incompatible // indirect
164 | 	github.com/docker/docker-credential-helpers v0.8.2 // indirect
165 | 	github.com/docker/go-connections v0.5.0 // indirect
166 | 	github.com/docker/go-units v0.5.0 // indirect
167 | 	github.com/dustin/go-humanize v1.0.1 // indirect
168 | 	github.com/elliotchance/orderedmap/v2 v2.7.0 // indirect
169 | 	github.com/emirpasic/gods v1.18.1 // indirect
170 | 	github.com/envoyproxy/go-control-plane v0.13.1 // indirect
171 | 	github.com/envoyproxy/protoc-gen-validate v1.1.0 // indirect
172 | 	github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
173 | 	github.com/ettle/strcase v0.2.0 // indirect
174 | 	github.com/evanphx/json-patch/v5 v5.6.0 // indirect
175 | 	github.com/fatih/structtag v1.2.0 // indirect
176 | 	github.com/felixge/httpsnoop v1.0.4 // indirect
177 | 	github.com/firefart/nonamedreturns v1.0.5 // indirect
178 | 	github.com/fsnotify/fsnotify v1.8.0 // indirect
179 | 	github.com/fzipp/gocyclo v0.6.0 // indirect
180 | 	github.com/gabriel-vasile/mimetype v1.4.8 // indirect
181 | 	github.com/ghostiam/protogetter v0.3.12 // indirect
182 | 	github.com/github/smimesign v0.2.0 // indirect
183 | 	github.com/go-chi/chi v4.1.2+incompatible // indirect
184 | 	github.com/go-critic/go-critic v0.13.0 // indirect
185 | 	github.com/go-fed/httpsig v1.1.0 // indirect
186 | 	github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
187 | 	github.com/go-git/go-billy/v5 v5.6.1 // indirect
188 | 	github.com/go-git/go-git/v5 v5.13.1 // indirect
189 | 	github.com/go-jose/go-jose/v4 v4.0.5 // indirect
190 | 	github.com/go-logr/logr v1.4.2 // indirect
191 | 	github.com/go-logr/stdr v1.2.2 // indirect
192 | 	github.com/go-openapi/analysis v0.23.0 // indirect
193 | 	github.com/go-openapi/errors v0.22.0 // indirect
194 | 	github.com/go-openapi/jsonpointer v0.21.0 // indirect
195 | 	github.com/go-openapi/jsonreference v0.21.0 // indirect
196 | 	github.com/go-openapi/loads v0.22.0 // indirect
197 | 	github.com/go-openapi/runtime v0.28.0 // indirect
198 | 	github.com/go-openapi/spec v0.21.0 // indirect
199 | 	github.com/go-openapi/strfmt v0.23.0 // indirect
200 | 	github.com/go-openapi/swag v0.23.0 // indirect
201 | 	github.com/go-openapi/validate v0.24.0 // indirect
202 | 	github.com/go-restruct/restruct v1.2.0-alpha // indirect
203 | 	github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 // indirect
204 | 	github.com/go-toolsmith/astcast v1.1.0 // indirect
205 | 	github.com/go-toolsmith/astcopy v1.1.0 // indirect
206 | 	github.com/go-toolsmith/astequal v1.2.0 // indirect
207 | 	github.com/go-toolsmith/astfmt v1.1.0 // indirect
208 | 	github.com/go-toolsmith/astp v1.1.0 // indirect
209 | 	github.com/go-toolsmith/strparse v1.1.0 // indirect
210 | 	github.com/go-toolsmith/typep v1.1.0 // indirect
211 | 	github.com/go-viper/mapstructure/v2 v2.2.1 // indirect
212 | 	github.com/go-xmlfmt/xmlfmt v1.1.3 // indirect
213 | 	github.com/gobwas/glob v0.2.3 // indirect
214 | 	github.com/gofrs/flock v0.12.1 // indirect
215 | 	github.com/gogo/protobuf v1.3.2 // indirect
216 | 	github.com/golang-jwt/jwt/v4 v4.5.1 // indirect
217 | 	github.com/golang-jwt/jwt/v5 v5.2.1 // indirect
218 | 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
219 | 	github.com/golangci/dupl v0.0.0-20250308024227-f665c8d69b32 // indirect
220 | 	github.com/golangci/go-printf-func-name v0.1.0 // indirect
221 | 	github.com/golangci/gofmt v0.0.0-20250106114630-d62b90e6713d // indirect
222 | 	github.com/golangci/golangci-lint/v2 v2.0.2 // indirect
223 | 	github.com/golangci/golines v0.0.0-20250217134842-442fd0091d95 // indirect
224 | 	github.com/golangci/misspell v0.6.0 // indirect
225 | 	github.com/golangci/plugin-module-register v0.1.1 // indirect
226 | 	github.com/golangci/revgrep v0.8.0 // indirect
227 | 	github.com/golangci/unconvert v0.0.0-20240309020433-c5143eacb3ed // indirect
228 | 	github.com/google/go-cmp v0.7.0 // indirect
229 | 	github.com/google/go-containerregistry v0.20.3 // indirect
230 | 	github.com/google/go-github/v69 v69.2.0 // indirect
231 | 	github.com/google/go-querystring v1.1.0 // indirect
232 | 	github.com/google/ko v0.17.1 // indirect
233 | 	github.com/google/rpmpack v0.6.1-0.20240329070804-c2247cbb881a // indirect
234 | 	github.com/google/s2a-go v0.1.9 // indirect
235 | 	github.com/google/safetext v0.0.0-20220905092116-b49f7bc46da2 // indirect
236 | 	github.com/google/uuid v1.6.0 // indirect
237 | 	github.com/google/wire v0.6.0 // indirect
238 | 	github.com/googleapis/enterprise-certificate-proxy v0.3.4 // indirect
239 | 	github.com/googleapis/gax-go/v2 v2.14.1 // indirect
240 | 	github.com/gordonklaus/ineffassign v0.1.0 // indirect
241 | 	github.com/goreleaser/chglog v0.6.2 // indirect
242 | 	github.com/goreleaser/fileglob v1.3.0 // indirect
243 | 	github.com/goreleaser/goreleaser/v2 v2.8.1 // indirect
244 | 	github.com/goreleaser/nfpm/v2 v2.41.3 // indirect
245 | 	github.com/gorilla/websocket v1.5.1 // indirect
246 | 	github.com/gostaticanalysis/analysisutil v0.7.1 // indirect
247 | 	github.com/gostaticanalysis/comment v1.5.0 // indirect
248 | 	github.com/gostaticanalysis/forcetypeassert v0.2.0 // indirect
249 | 	github.com/gostaticanalysis/nilerr v0.1.1 // indirect
250 | 	github.com/hashicorp/errwrap v1.1.0 // indirect
251 | 	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
252 | 	github.com/hashicorp/go-immutable-radix/v2 v2.1.0 // indirect
253 | 	github.com/hashicorp/go-multierror v1.1.1 // indirect
254 | 	github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
255 | 	github.com/hashicorp/go-version v1.7.0 // indirect
256 | 	github.com/hashicorp/golang-lru v1.0.2 // indirect
257 | 	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
258 | 	github.com/hashicorp/hcl v1.0.1-vault-5 // indirect
259 | 	github.com/hexops/gotextdiff v1.0.3 // indirect
260 | 	github.com/huandu/xstrings v1.5.0 // indirect
261 | 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
262 | 	github.com/invopop/jsonschema v0.13.0 // indirect
263 | 	github.com/ipfs/bbloom v0.0.4 // indirect
264 | 	github.com/ipfs/go-block-format v0.2.0 // indirect
265 | 	github.com/ipfs/go-cid v0.4.1 // indirect
266 | 	github.com/ipfs/go-datastore v0.6.0 // indirect
267 | 	github.com/ipfs/go-ipfs-blockstore v1.3.1 // indirect
268 | 	github.com/ipfs/go-ipfs-ds-help v1.1.1 // indirect
269 | 	github.com/ipfs/go-ipfs-util v0.0.3 // indirect
270 | 	github.com/ipfs/go-ipld-cbor v0.1.0 // indirect
271 | 	github.com/ipfs/go-ipld-format v0.6.0 // indirect
272 | 	github.com/ipfs/go-log v1.0.5 // indirect
273 | 	github.com/ipfs/go-log/v2 v2.5.1 // indirect
274 | 	github.com/ipfs/go-metrics-interface v0.0.1 // indirect
275 | 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
276 | 	github.com/jbenet/goprocess v0.1.4 // indirect
277 | 	github.com/jedisct1/go-minisign v0.0.0-20230811132847-661be99b8267 // indirect
278 | 	github.com/jgautheron/goconst v1.7.1 // indirect
279 | 	github.com/jingyugao/rowserrcheck v1.1.1 // indirect
280 | 	github.com/jjti/go-spancheck v0.6.4 // indirect
281 | 	github.com/jmespath/go-jmespath v0.4.0 // indirect
282 | 	github.com/josharian/intern v1.0.0 // indirect
283 | 	github.com/julz/importas v0.2.0 // indirect
284 | 	github.com/karamaru-alpha/copyloopvar v1.2.1 // indirect
285 | 	github.com/kevinburke/ssh_config v1.2.0 // indirect
286 | 	github.com/kisielk/errcheck v1.9.0 // indirect
287 | 	github.com/kkHAIKE/contextcheck v1.1.6 // indirect
288 | 	github.com/klauspost/compress v1.18.0 // indirect
289 | 	github.com/klauspost/cpuid/v2 v2.2.7 // indirect
290 | 	github.com/klauspost/pgzip v1.2.6 // indirect
291 | 	github.com/kulti/thelper v0.6.3 // indirect
292 | 	github.com/kunwardeep/paralleltest v1.0.10 // indirect
293 | 	github.com/kylelemons/godebug v1.1.0 // indirect
294 | 	github.com/lasiar/canonicalheader v1.1.2 // indirect
295 | 	github.com/ldez/exptostd v0.4.2 // indirect
296 | 	github.com/ldez/gomoddirectives v0.6.1 // indirect
297 | 	github.com/ldez/grignotin v0.9.0 // indirect
298 | 	github.com/ldez/tagliatelle v0.7.1 // indirect
299 | 	github.com/ldez/usetesting v0.4.2 // indirect
300 | 	github.com/leonklingele/grouper v1.1.2 // indirect
301 | 	github.com/letsencrypt/boulder v0.0.0-20240620165639-de9c06129bec // indirect
302 | 	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
303 | 	github.com/macabu/inamedparam v0.2.0 // indirect
304 | 	github.com/magiconair/properties v1.8.7 // indirect
305 | 	github.com/mailru/easyjson v0.7.7 // indirect
306 | 	github.com/maratori/testableexamples v1.0.0 // indirect
307 | 	github.com/maratori/testpackage v1.1.1 // indirect
308 | 	github.com/matoous/godox v1.1.0 // indirect
309 | 	github.com/mattn/go-colorable v0.1.14 // indirect
310 | 	github.com/mattn/go-isatty v0.0.20 // indirect
311 | 	github.com/mattn/go-localereader v0.0.2-0.20220822084749-2491eb6c1c75 // indirect
312 | 	github.com/mattn/go-mastodon v0.0.9 // indirect
313 | 	github.com/mattn/go-runewidth v0.0.16 // indirect
314 | 	github.com/mgechev/revive v1.7.0 // indirect
315 | 	github.com/minio/sha256-simd v1.0.1 // indirect
316 | 	github.com/mitchellh/copystructure v1.2.0 // indirect
317 | 	github.com/mitchellh/mapstructure v1.5.0 // indirect
318 | 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
319 | 	github.com/moby/docker-image-spec v1.3.1 // indirect
320 | 	github.com/moricho/tparallel v0.3.2 // indirect
321 | 	github.com/mr-tron/base58 v1.2.0 // indirect
322 | 	github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect
323 | 	github.com/muesli/cancelreader v0.2.2 // indirect
324 | 	github.com/muesli/mango v0.1.0 // indirect
325 | 	github.com/muesli/mango-cobra v1.2.0 // indirect
326 | 	github.com/muesli/mango-pflag v0.1.0 // indirect
327 | 	github.com/muesli/roff v0.1.0 // indirect
328 | 	github.com/muesli/termenv v0.16.0 // indirect
329 | 	github.com/multiformats/go-base32 v0.1.0 // indirect
330 | 	github.com/multiformats/go-base36 v0.2.0 // indirect
331 | 	github.com/multiformats/go-multibase v0.2.0 // indirect
332 | 	github.com/multiformats/go-multihash v0.2.3 // indirect
333 | 	github.com/multiformats/go-varint v0.0.7 // indirect
334 | 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
335 | 	github.com/nakabonne/nestif v0.3.1 // indirect
336 | 	github.com/nishanths/exhaustive v0.12.0 // indirect
337 | 	github.com/nishanths/predeclared v0.2.2 // indirect
338 | 	github.com/nunnatsa/ginkgolinter v0.19.1 // indirect
339 | 	github.com/oklog/ulid v1.3.1 // indirect
340 | 	github.com/olekukonko/tablewriter v0.0.5 // indirect
341 | 	github.com/opencontainers/go-digest v1.0.0 // indirect
342 | 	github.com/opencontainers/image-spec v1.1.0 // indirect
343 | 	github.com/opencontainers/runc v1.2.0-rc.1 // indirect
344 | 	github.com/opentracing/opentracing-go v1.2.0 // indirect
345 | 	github.com/pelletier/go-toml v1.9.5 // indirect
346 | 	github.com/pelletier/go-toml/v2 v2.2.3 // indirect
347 | 	github.com/pjbgf/sha1cd v0.3.0 // indirect
348 | 	github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect
349 | 	github.com/pkg/errors v0.9.1 // indirect
350 | 	github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 // indirect
351 | 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
352 | 	github.com/polydawn/refmt v0.89.1-0.20221221234430-40501e09de1f // indirect
353 | 	github.com/polyfloyd/go-errorlint v1.7.1 // indirect
354 | 	github.com/prometheus/client_golang v1.20.5 // indirect
355 | 	github.com/prometheus/client_model v0.6.1 // indirect
356 | 	github.com/prometheus/common v0.60.1 // indirect
357 | 	github.com/prometheus/procfs v0.15.1 // indirect
358 | 	github.com/quasilyte/go-ruleguard v0.4.4 // indirect
359 | 	github.com/quasilyte/go-ruleguard/dsl v0.3.22 // indirect
360 | 	github.com/quasilyte/gogrep v0.5.0 // indirect
361 | 	github.com/quasilyte/regex/syntax v0.0.0-20210819130434-b3f0c404a727 // indirect
362 | 	github.com/quasilyte/stdinfo v0.0.0-20220114132959-f7386bf02567 // indirect
363 | 	github.com/raeperd/recvcheck v0.2.0 // indirect
364 | 	github.com/rivo/uniseg v0.4.7 // indirect
365 | 	github.com/rogpeppe/go-internal v1.14.1 // indirect
366 | 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
367 | 	github.com/ryancurrah/gomodguard v1.4.1 // indirect
368 | 	github.com/ryanrolds/sqlclosecheck v0.5.1 // indirect
369 | 	github.com/sagikazarmark/locafero v0.6.0 // indirect
370 | 	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
371 | 	github.com/sanposhiho/wastedassign/v2 v2.1.0 // indirect
372 | 	github.com/santhosh-tekuri/jsonschema/v6 v6.0.1 // indirect
373 | 	github.com/sashamelentyev/interfacebloat v1.1.0 // indirect
374 | 	github.com/sashamelentyev/usestdlibvars v1.28.0 // indirect
375 | 	github.com/sassoftware/relic v7.2.1+incompatible // indirect
376 | 	github.com/scylladb/go-set v1.0.3-0.20200225121959-cc7b2070d91e // indirect
377 | 	github.com/secure-systems-lab/go-securesystemslib v0.8.0 // indirect
378 | 	github.com/securego/gosec/v2 v2.22.2 // indirect
379 | 	github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
380 | 	github.com/shopspring/decimal v1.4.0 // indirect
381 | 	github.com/sigstore/cosign/v2 v2.4.1 // indirect
382 | 	github.com/sigstore/protobuf-specs v0.3.2 // indirect
383 | 	github.com/sigstore/rekor v1.3.6 // indirect
384 | 	github.com/sigstore/sigstore v1.8.9 // indirect
385 | 	github.com/sirupsen/logrus v1.9.3 // indirect
386 | 	github.com/sivchari/containedctx v1.0.3 // indirect
387 | 	github.com/skeema/knownhosts v1.3.0 // indirect
388 | 	github.com/slack-go/slack v0.16.0 // indirect
389 | 	github.com/sonatard/noctx v0.1.0 // indirect
390 | 	github.com/sourcegraph/conc v0.3.0 // indirect
391 | 	github.com/sourcegraph/go-diff v0.7.0 // indirect
392 | 	github.com/spaolacci/murmur3 v1.1.0 // indirect
393 | 	github.com/spf13/afero v1.12.0 // indirect
394 | 	github.com/spf13/cast v1.7.0 // indirect
395 | 	github.com/spf13/cobra v1.9.1 // indirect
396 | 	github.com/spf13/pflag v1.0.6 // indirect
397 | 	github.com/spf13/viper v1.19.0 // indirect
398 | 	github.com/ssgreg/nlreturn/v2 v2.2.1 // indirect
399 | 	github.com/stbenjam/no-sprintf-host-port v0.2.0 // indirect
400 | 	github.com/stretchr/objx v0.5.2 // indirect
401 | 	github.com/subosito/gotenv v1.6.0 // indirect
402 | 	github.com/tdakkota/asciicheck v0.4.1 // indirect
403 | 	github.com/tetafro/godot v1.5.0 // indirect
404 | 	github.com/theupdateframework/go-tuf v0.7.0 // indirect
405 | 	github.com/timakin/bodyclose v0.0.0-20241222091800-1db5c5ca4d67 // indirect
406 | 	github.com/timonwong/loggercheck v0.10.1 // indirect
407 | 	github.com/titanous/rocacheck v0.0.0-20171023193734-afe73141d399 // indirect
408 | 	github.com/tomarrell/wrapcheck/v2 v2.10.0 // indirect
409 | 	github.com/tommy-muehle/go-mnd/v2 v2.5.1 // indirect
410 | 	github.com/tomnomnom/linkheader v0.0.0-20180905144013-02ca5825eb80 // indirect
411 | 	github.com/ulikunitz/xz v0.5.12 // indirect
412 | 	github.com/ultraware/funlen v0.2.0 // indirect
413 | 	github.com/ultraware/whitespace v0.2.0 // indirect
414 | 	github.com/uudashr/gocognit v1.2.0 // indirect
415 | 	github.com/uudashr/iface v1.3.1 // indirect
416 | 	github.com/vbatts/tar-split v0.11.6 // indirect
417 | 	github.com/wagoodman/go-partybus v0.0.0-20230516145632-8ccac152c651 // indirect
418 | 	github.com/wagoodman/go-progress v0.0.0-20220614130704-4b1c25a33c7c // indirect
419 | 	github.com/whyrusleeping/cbor-gen v0.1.3-0.20240731173018-74d74643234c // indirect
420 | 	github.com/wk8/go-ordered-map/v2 v2.1.8 // indirect
421 | 	github.com/xanzy/ssh-agent v0.3.3 // indirect
422 | 	github.com/xen0n/gosmopolitan v1.3.0 // indirect
423 | 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
424 | 	github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
425 | 	github.com/yagipy/maintidx v1.0.0 // indirect
426 | 	github.com/yeya24/promlinter v0.3.0 // indirect
427 | 	github.com/ykadowak/zerologlint v0.1.5 // indirect
428 | 	gitlab.com/bosi/decorder v0.4.2 // indirect
429 | 	gitlab.com/digitalxero/go-conventional-commit v1.0.7 // indirect
430 | 	gitlab.com/gitlab-org/api/client-go v0.124.0 // indirect
431 | 	go-simpler.org/musttag v0.13.0 // indirect
432 | 	go-simpler.org/sloglint v0.9.0 // indirect
433 | 	go.mongodb.org/mongo-driver v1.14.0 // indirect
434 | 	go.opencensus.io v0.24.0 // indirect
435 | 	go.opentelemetry.io/auto/sdk v1.1.0 // indirect
436 | 	go.opentelemetry.io/contrib/detectors/gcp v1.32.0 // indirect
437 | 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.59.0 // indirect
438 | 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.59.0 // indirect
439 | 	go.opentelemetry.io/otel v1.34.0 // indirect
440 | 	go.opentelemetry.io/otel/metric v1.34.0 // indirect
441 | 	go.opentelemetry.io/otel/sdk v1.34.0 // indirect
442 | 	go.opentelemetry.io/otel/sdk/metric v1.32.0 // indirect
443 | 	go.opentelemetry.io/otel/trace v1.34.0 // indirect
444 | 	go.uber.org/atomic v1.11.0 // indirect
445 | 	go.uber.org/automaxprocs v1.6.0 // indirect
446 | 	go.uber.org/multierr v1.11.0 // indirect
447 | 	go.uber.org/zap v1.27.0 // indirect
448 | 	gocloud.dev v0.40.0 // indirect
449 | 	golang.org/x/crypto v0.36.0 // indirect
450 | 	golang.org/x/exp v0.0.0-20241009180824-f66d83c29e7c // indirect
451 | 	golang.org/x/exp/typeparams v0.0.0-20250210185358-939b2ce775ac // indirect
452 | 	golang.org/x/mod v0.24.0 // indirect
453 | 	golang.org/x/net v0.37.0 // indirect
454 | 	golang.org/x/oauth2 v0.28.0 // indirect
455 | 	golang.org/x/sync v0.12.0 // indirect
456 | 	golang.org/x/sys v0.31.0 // indirect
457 | 	golang.org/x/telemetry v0.0.0-20240522233618-39ace7a40ae7 // indirect
458 | 	golang.org/x/term v0.30.0 // indirect
459 | 	golang.org/x/text v0.23.0 // indirect
460 | 	golang.org/x/time v0.10.0 // indirect
461 | 	golang.org/x/tools v0.31.0 // indirect
462 | 	golang.org/x/vuln v1.1.4 // indirect
463 | 	golang.org/x/xerrors v0.0.0-20240716161551-93cc26a95ae9 // indirect
464 | 	google.golang.org/api v0.223.0 // indirect
465 | 	google.golang.org/genproto v0.0.0-20241118233622-e639e219e697 // indirect
466 | 	google.golang.org/genproto/googleapis/api v0.0.0-20241209162323-e6fa225c2576 // indirect
467 | 	google.golang.org/genproto/googleapis/rpc v0.0.0-20250219182151-9fdb1cabc7b2 // indirect
468 | 	google.golang.org/grpc v1.70.0 // indirect
469 | 	google.golang.org/protobuf v1.36.5 // indirect
470 | 	gopkg.in/alexcesaro/quotedprintable.v3 v3.0.0-20150716171945-2caba252f4dc // indirect
471 | 	gopkg.in/ini.v1 v1.67.0 // indirect
472 | 	gopkg.in/mail.v2 v2.3.1 // indirect
473 | 	gopkg.in/warnings.v0 v0.1.2 // indirect
474 | 	gopkg.in/yaml.v2 v2.4.0 // indirect
475 | 	gopkg.in/yaml.v3 v3.0.1 // indirect
476 | 	honnef.co/go/tools v0.6.1 // indirect
477 | 	lukechampine.com/blake3 v1.2.1 // indirect
478 | 	mvdan.cc/gofumpt v0.7.0 // indirect
479 | 	mvdan.cc/unparam v0.0.0-20250301125049-0df0534333a4 // indirect
480 | 	sigs.k8s.io/kind v0.24.0 // indirect
481 | 	sigs.k8s.io/yaml v1.4.0 // indirect
482 | 	software.sslmate.com/src/go-pkcs12 v0.5.0 // indirect
483 | )
484 | 
485 | tool (
486 | 	github.com/golangci/golangci-lint/v2/cmd/golangci-lint
487 | 	github.com/goreleaser/goreleaser/v2
488 | 	golang.org/x/vuln/cmd/govulncheck
489 | )
490 | 


--------------------------------------------------------------------------------
/hooks.go:
--------------------------------------------------------------------------------
  1 | // Copyright © 2017-2020 Olivier Robardet
  2 | //
  3 | // Permission is hereby granted, free of charge, to any person obtaining a copy
  4 | // of this software and associated documentation files (the "Software"), to deal
  5 | // in the Software without restriction, including without limitation the rights
  6 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7 | // copies of the Software, and to permit persons to whom the Software is
  8 | // furnished to do so, subject to the following conditions:
  9 | //
 10 | // The above copyright notice and this permission notice shall be included in
 11 | // all copies or substantial portions of the Software.
 12 | //
 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 18 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 19 | // THE SOFTWARE.
 20 | 
 21 | package main
 22 | 
 23 | import (
 24 | 	"fmt"
 25 | 	"os"
 26 | 	"path"
 27 | 	"path/filepath"
 28 | )
 29 | 
 30 | // Enum describing the hook creation state
 31 | const (
 32 | 	HookError = iota
 33 | 	HookCreated
 34 | 	HookAlreadyCreated
 35 | 	HookAlreadyExists
 36 | 	HookDeleted
 37 | 	HookNotExisting
 38 | 	HookNotMatching
 39 | )
 40 | 
 41 | func createGitHookLink(gitRepoPath string, hookName string) (int, error) {
 42 | 	currentExe, err := os.Executable()
 43 | 	if err != nil {
 44 | 		return HookError, err
 45 | 	}
 46 | 
 47 | 	err = os.MkdirAll(path.Join(gitRepoPath, "hooks"), 0755) // #nosec G301
 48 | 	if err != nil {
 49 | 		return HookError, err
 50 | 	}
 51 | 
 52 | 	hookPath := path.Join(gitRepoPath, "hooks", hookName)
 53 | 
 54 | 	// There is no hook already
 55 | 	fi, err := os.Lstat(hookPath)
 56 | 	if os.IsNotExist(err) {
 57 | 		err = os.Symlink(currentExe, hookPath)
 58 | 		if err != nil {
 59 | 			return HookError, err
 60 | 		}
 61 | 	} else {
 62 | 		// If there is a hook, maybe it's already ourself?
 63 | 		if fi.Mode()&os.ModeSymlink != os.ModeSymlink {
 64 | 			return HookAlreadyExists, nil
 65 | 		}
 66 | 
 67 | 		linkDest, err := os.Readlink(hookPath)
 68 | 		if err != nil {
 69 | 			return HookError, err
 70 | 		}
 71 | 
 72 | 		linkDest, err = filepath.Abs(linkDest)
 73 | 		if err != nil {
 74 | 			return HookError, err
 75 | 		}
 76 | 
 77 | 		if linkDest == currentExe {
 78 | 			return HookAlreadyCreated, nil
 79 | 		}
 80 | 
 81 | 		return HookAlreadyExists, nil
 82 | 	}
 83 | 
 84 | 	return HookCreated, nil
 85 | }
 86 | 
 87 | func deleteGitHookLink(gitRepoPath string, hookName string) (int, error) {
 88 | 	hookPath := path.Join(gitRepoPath, "hooks", hookName)
 89 | 
 90 | 	fi, err := os.Lstat(hookPath)
 91 | 	if os.IsNotExist(err) {
 92 | 		return HookNotExisting, nil
 93 | 	}
 94 | 
 95 | 	currentExe, err := os.Executable()
 96 | 	if err != nil {
 97 | 		return HookError, err
 98 | 	}
 99 | 	if fi.Mode()&os.ModeSymlink != os.ModeSymlink {
100 | 		return HookNotMatching, nil
101 | 	}
102 | 
103 | 	linkDest, err := os.Readlink(hookPath)
104 | 	if err != nil {
105 | 		return HookError, err
106 | 	}
107 | 
108 | 	linkDest, err = filepath.Abs(linkDest)
109 | 	if err != nil {
110 | 		return HookError, err
111 | 	}
112 | 
113 | 	if verboseMode {
114 | 		fmt.Println(linkDest)
115 | 	}
116 | 
117 | 	if linkDest == currentExe {
118 | 		err = os.Remove(hookPath)
119 | 		if err != nil {
120 | 			return HookError, err
121 | 		}
122 | 	} else {
123 | 		return HookNotMatching, nil
124 | 	}
125 | 
126 | 	return HookDeleted, nil
127 | }
128 | 


--------------------------------------------------------------------------------
/main.go:
--------------------------------------------------------------------------------
  1 | // Copyright © 2017-2020 Olivier Robardet
  2 | //
  3 | // Permission is hereby granted, free of charge, to any person obtaining a copy
  4 | // of this software and associated documentation files (the "Software"), to deal
  5 | // in the Software without restriction, including without limitation the rights
  6 | // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7 | // copies of the Software, and to permit persons to whom the Software is
  8 | // furnished to do so, subject to the following conditions:
  9 | //
 10 | // The above copyright notice and this permission notice shall be included in
 11 | // all copies or substantial portions of the Software.
 12 | //
 13 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 14 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 15 | // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 16 | // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 17 | // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 18 | // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 19 | // THE SOFTWARE.
 20 | 
 21 | package main
 22 | 
 23 | import (
 24 | 	"fmt"
 25 | 	"math"
 26 | 	"net/url"
 27 | 	"os"
 28 | 	"path/filepath"
 29 | 	"strings"
 30 | 
 31 | 	"github.com/fatih/color"
 32 | 	"github.com/urfave/cli/v2"
 33 | 	"gitlab.com/orobardet/gitlab-ci-linter/config"
 34 | )
 35 | 
 36 | // The Gitlab instance root URL to use.
 37 | var gitlabRootURL string
 38 | 
 39 | // The full path of the gitlab-ci file to check, if given at calls.
 40 | // If no path is given at call, the variable will be an empty string, and the program will search for the file
 41 | // using gitlabCiFileName.
 42 | // Search start on the directoryRoot, and goes up in the directory hierarchy until a file is found or the root is reach
 43 | var gitlabCiFilePath string
 44 | 
 45 | // Directory to start searching for gitlab-ci file and git repository
 46 | var directoryRoot string
 47 | 
 48 | // Personal access token for accessing the repository when you have two factor authentication (2FA) enabled.
 49 | var personalAccessToken string
 50 | 
 51 | // Try to get personal access token as 'account' from .netrc file
 52 | var useNetrc bool
 53 | 
 54 | // Path of .netrc file to use
 55 | var netrcFile string
 56 | 
 57 | // The project path (namespace + name) of the GitLab project that is used in the API endpoint to validate the CI configuration.
 58 | var projectPath string
 59 | 
 60 | // The identifier of the GitLab project that is used in the API endpoint to validate the CI configuration.
 61 | var projectID string
 62 | 
 63 | // Timeout in seconds for HTTP request to the Gitlab API
 64 | // Request will fail if lasting more than the timeout
 65 | var httpRequestTimeout int64 = 15
 66 | 
 67 | // Tells if output should be colorized or not
 68 | var colorMode = true //nolint:unused
 69 | 
 70 | // Tells if verbose mode is on or off
 71 | var verboseMode = false
 72 | 
 73 | // Tells if the response should include the merged yaml from the Gitlab API
 74 | var includeMergedYaml = false
 75 | 
 76 | // Tells if run pipeline creation simulation
 77 | var dryRun = false
 78 | 
 79 | // When dry_run is true, sets the branch or tag context to use to validate the CI/CD YAML configuration. Defaults to the project’s default branch when not set.
 80 | var dryRunRef string
 81 | 
 82 | // Analyse a PATH argument, that can be a directory or file, to use it as a gitlab-ci file a a directory
 83 | // where to start searching
 84 | func processPathArgument(path string) {
 85 | 	fileInfo, err := os.Stat(path)
 86 | 	if !os.IsNotExist(err) {
 87 | 		if fileInfo.IsDir() {
 88 | 			directoryRoot, _ = filepath.Abs(path)
 89 | 			if verboseMode {
 90 | 				fmt.Printf("%s directory used as repository root.\n", path)
 91 | 			}
 92 | 		} else {
 93 | 			gitlabCiFilePath, _ = filepath.Abs(path)
 94 | 			if verboseMode {
 95 | 				fmt.Printf("%s used as gitlab-ci.yml file.\n", path)
 96 | 			}
 97 | 		}
 98 | 	}
 99 | }
100 | 
101 | func main() {
102 | 	cli.VersionPrinter = func(_ *cli.Context) {
103 | 		fmt.Printf("version=%s revision=%s built on=%s\n", config.VERSION, config.REVISION, config.BUILDTIME)
104 | 	}
105 | 
106 | 	cli.AppHelpTemplate = `{{.Name}} - {{.Usage}}
107 | version {{if .Version}}{{.Version}}{{end}}
108 | {{if len .Authors}}{{range .Authors}}{{ . }}{{end}}{{end}} - https://gitlab.com/orobardet/gitlab-ci-linter
109 | 
110 | Usage:
111 |    {{.HelpName}} {{if .VisibleFlags}}[global options]{{end}}{{if .Commands}} [command [command options]]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}[arguments...]{{end}}
112 | 
113 |    The used Gitlab API is tied to a Gitlab project. Thus, the tools needs to know which Gitlab project (on which Gitlab instance) it has to target.
114 |    By default, it will try to autodetect from the 'origin' remote configured in the git repository (if any), by extracting the FQDN as the root URL, 
115 |    and the project path. Works for 'http'' or 'ssh' remotes. e.g.: a remote "https://gitlab.com/orobardet/gitlab-ci-linter.git" or
116 |    "git@gitlab.com:orobardet/gitlab-ci-linter.git" will target the API of the project "orobardet/gitlab-ci-linter" on "https://gitlab.com".
117 | 
118 |    In case the auto-detection does not work, or you don't have a compatible remote, or you want to target another project, you can specify the Gitlab
119 |    root URL using '-gitlab-url|-u' flag, and the project using '--project-path|-P' or '--project-id|-I' flags. '--project-id' has precedence over '--project-path'.
120 | 
121 |    If your gitlab instance or project needs an authentification (which is the case on gitlab.com), you have to specify a personal access token with '--personal-access-token|-p'.
122 |    You can also use the flag '--netrc|-n' to try getting the token from the .netrc file (by default ~/.netrc on *nix, $HOME/_netrc on Windows), but not the token must be set
123 |    on the 'account' field, not 'password' (to prevent conflict with basic auth). Also, the 'default' entry of .netrc is ignored.
124 |    e.g.: for gitlab.com, the .netrc entry should be:
125 |       machine gitlab.com
126 |         # possible login and password definition
127 |         account MY_PERSONAL_ACCESS_TOKEN
128 | 
129 | {{if .VisibleFlags}}Global options:
130 |    {{range .VisibleFlags}}{{.}}
131 |    {{end}}{{end}}
132 | {{if .Description}}Arguments:
133 |    {{.Description}}{{end}}
134 | 
135 | {{if .Commands}}Commands:
136 | {{range .Commands}}{{if not .HideHelp}}   {{join .Names ", "}}{{ "\t"}}{{.Usage}}{{ "\n" }}{{end}}{{end}}
137 |    If no command is given, 'check 'is used by default
138 | {{end}}`
139 | 
140 | 	app := cli.NewApp()
141 | 	app.Name = config.APPNAME
142 | 	app.Version = fmt.Sprintf("%s (%s)", config.VERSION, config.REVISION[:int(math.Min(float64(len(config.REVISION)), 7))])
143 | 	app.Authors = []*cli.Author{
144 | 		{Name: "Olivier ROBARDET"},
145 | 	}
146 | 	app.Usage = "lint your .gitlab-ci.yml using the Gitlab lint API"
147 | 	app.EnableBashCompletion = true
148 | 	app.UseShortOptionHandling = true
149 | 
150 | 	pathArgumentDescription := `If PATH if given, it will depending of its type on filesystem:
151 |     - if a file, it will be used as the gitlab-ci file to check (similar to global --ci-file option)
152 |     - if a directory, it will be used as the folder from where to search for a ci file and a git repository (similar to global --directory option)
153 |    PATH have precedence over --ci-file and --directory options.`
154 | 
155 | 	app.ArgsUsage = "[PATH]"
156 | 	app.Description = pathArgumentDescription
157 | 	app.Flags = []cli.Flag{
158 | 		&cli.StringFlag{
159 | 			Name:        "gitlab-url",
160 | 			Aliases:     []string{"u"},
161 | 			Value:       "",
162 | 			Usage:       fmt.Sprintf("root `URL` of the Gitlab instance to use API (default: auto-detect from remote origin, else \"%s\")", defaultGitlabRootURL),
163 | 			EnvVars:     []string{"GCL_GITLAB_URL"},
164 | 			Destination: &gitlabRootURL,
165 | 		},
166 | 		&cli.StringFlag{
167 | 			Name:        "ci-file",
168 | 			Aliases:     []string{"f"},
169 | 			Usage:       "`FILE` is the relative or absolute path to the gitlab-ci file",
170 | 			EnvVars:     []string{"GCL_GITLAB_CI_FILE"},
171 | 			Destination: &gitlabCiFilePath,
172 | 		},
173 | 		&cli.StringFlag{
174 | 			Name:        "directory",
175 | 			Aliases:     []string{"d"},
176 | 			Value:       ".",
177 | 			Usage:       "`DIR` is the directory from where to search for gitlab-ci file and git repository",
178 | 			EnvVars:     []string{"GCL_DIRECTORY"},
179 | 			Destination: &directoryRoot,
180 | 		},
181 | 		&cli.StringFlag{
182 | 			Name:        "personal-access-token",
183 | 			Aliases:     []string{"p"},
184 | 			Value:       "",
185 | 			Usage:       "personal access token `TOK` for accessing repositories when you have 2FA enabled. Has precedence over .netrc usage",
186 | 			EnvVars:     []string{"GCL_PERSONAL_ACCESS_TOKEN"},
187 | 			Destination: &personalAccessToken,
188 | 		},
189 | 		&cli.BoolFlag{
190 | 			Name:        "netrc",
191 | 			Aliases:     []string{"n"},
192 | 			Usage:       "Try to get personal access token as 'account' from .netrc file",
193 | 			EnvVars:     []string{"GCL_NETRC"},
194 | 			Destination: &useNetrc,
195 | 		},
196 | 		&cli.StringFlag{
197 | 			Name:        "netrc-file",
198 | 			Value:       "",
199 | 			Usage:       "Path of .netrc file to use. By default, try to detect it.",
200 | 			EnvVars:     []string{"GCL_NETRC_FILE"},
201 | 			Destination: &netrcFile,
202 | 		},
203 | 		&cli.StringFlag{
204 | 			Name:        "project-path",
205 | 			Aliases:     []string{"P"},
206 | 			Value:       "",
207 | 			Usage:       "`PATH` of the GitLab project that is used in the API for Gitlab >=13.6. Has precedence over path guessing from remote",
208 | 			EnvVars:     []string{"CI_PROJECT_PATH", "GCL_PROJECT_PATH"},
209 | 			Destination: &projectPath,
210 | 		},
211 | 		&cli.StringFlag{
212 | 			Name:        "project-id",
213 | 			Aliases:     []string{"I"},
214 | 			Value:       "",
215 | 			Usage:       "`ID` of the GitLab project that is used in the API for Gitlab >=13.6. Has precedence over --project-path",
216 | 			EnvVars:     []string{"CI_PROJECT_ID", "GCL_PROJECT_ID"},
217 | 			Destination: &projectID,
218 | 		},
219 | 		&cli.Int64Flag{
220 | 			Name:        "timeout",
221 | 			Aliases:     []string{"t"},
222 | 			Value:       httpRequestTimeout,
223 | 			Usage:       "timeout in second after which http request to Gitlab API will timeout (and the program will fails)",
224 | 			EnvVars:     []string{"GCL_TIMEOUT"},
225 | 			Destination: &httpRequestTimeout,
226 | 		},
227 | 		&cli.BoolFlag{
228 | 			Name:    "no-color",
229 | 			Usage:   "don't color output. By defaults the output is colorized if a compatible terminal is detected.",
230 | 			EnvVars: []string{"GCL_NOCOLOR"},
231 | 		},
232 | 		&cli.BoolFlag{
233 | 			Name:        "verbose",
234 | 			Aliases:     []string{"v"},
235 | 			Usage:       "verbose mode",
236 | 			EnvVars:     []string{"GCL_VERBOSE"},
237 | 			Destination: &verboseMode,
238 | 		},
239 | 		&cli.BoolFlag{
240 | 			Name:        "merged-yaml",
241 | 			Aliases:     []string{"m"},
242 | 			Usage:       "include merged yaml in response",
243 | 			EnvVars:     []string{"GCL_INCLUDE_MERGED_YAML"},
244 | 			Destination: &includeMergedYaml,
245 | 		},
246 | 		&cli.BoolFlag{
247 | 			Name:        "dry-run",
248 | 			Aliases:     []string{"s"},
249 | 			Usage:       "run pipeline creation simulation",
250 | 			EnvVars:     []string{"GCL_DRY_RUN"},
251 | 			Destination: &dryRun,
252 | 		},
253 | 		&cli.StringFlag{
254 | 			Name:        "dry-run-ref",
255 | 			Usage:       "when dry_run is true, sets the branch or tag to validate ci yml, defaults to current detected branch",
256 | 			EnvVars:     []string{"GCL_DRY_RUN_REF"},
257 | 			Destination: &dryRunRef,
258 | 		},
259 | 	}
260 | 	cli.VersionFlag = &cli.BoolFlag{
261 | 		Name:  "version, V",
262 | 		Usage: "print the version information",
263 | 	}
264 | 
265 | 	app.Commands = []*cli.Command{
266 | 		{
267 | 			Name:        "check",
268 | 			Aliases:     []string{"c"},
269 | 			Usage:       "Check the .gitlab-ci.yml (default command if none is given)",
270 | 			Action:      commandCheck,
271 | 			ArgsUsage:   "[PATH]",
272 | 			Description: pathArgumentDescription,
273 | 		},
274 | 		{
275 | 			Name:        "install",
276 | 			Aliases:     []string{"i"},
277 | 			Usage:       "install as git pre-commit hook",
278 | 			Action:      commandInstall,
279 | 			ArgsUsage:   "[PATH]",
280 | 			Description: pathArgumentDescription,
281 | 		},
282 | 		{
283 | 			Name:        "uninstall",
284 | 			Aliases:     []string{"u"},
285 | 			Usage:       "uninstall the git pre-commit hook",
286 | 			Action:      commandUninstall,
287 | 			ArgsUsage:   "[PATH]",
288 | 			Description: pathArgumentDescription,
289 | 		},
290 | 		{
291 | 			Name:    "version",
292 | 			Aliases: []string{"v"},
293 | 			Usage:   "Print the version information",
294 | 			Action: func(c *cli.Context) error {
295 | 				cli.ShowVersion(c)
296 | 				return nil
297 | 			},
298 | 		},
299 | 	}
300 | 
301 | 	app.Before = func(c *cli.Context) error {
302 | 		if c.Bool("no-color") {
303 | 			colorMode = false
304 | 			color.NoColor = true
305 | 		}
306 | 
307 | 		// Check if the given directory path exists
308 | 		if directoryRoot != "" {
309 | 			directoryRoot, _ = filepath.Abs(directoryRoot)
310 | 			fileInfo, err := os.Stat(directoryRoot)
311 | 			if os.IsNotExist(err) {
312 | 				return cli.Exit(fmt.Sprintf("'%s' does not exists", directoryRoot), 1)
313 | 			}
314 | 			if !fileInfo.IsDir() {
315 | 				return cli.Exit(fmt.Sprintf("'%s' is not a directory", directoryRoot), 1)
316 | 			}
317 | 		}
318 | 
319 | 		// Check if the given gitlab-ci file path exists
320 | 		if gitlabCiFilePath != "" {
321 | 			gitlabCiFilePath, _ = filepath.Abs(gitlabCiFilePath)
322 | 			fileInfo, err := os.Stat(gitlabCiFilePath)
323 | 			if os.IsNotExist(err) {
324 | 				return cli.Exit(fmt.Sprintf("'%s' does not exists", gitlabCiFilePath), 1)
325 | 			}
326 | 			if fileInfo.IsDir() {
327 | 				return cli.Exit(fmt.Sprintf("'%s' is a directory, not a file", gitlabCiFilePath), 1)
328 | 			}
329 | 		}
330 | 
331 | 		gitlabRootURL = strings.TrimSpace(gitlabRootURL)
332 | 		if gitlabRootURL != "" {
333 | 			u, err := url.Parse(gitlabRootURL)
334 | 			if err != nil {
335 | 				return cli.Exit(fmt.Sprintf("Unable to parse gitlab root URL '%s': %s", gitlabRootURL, err), 1)
336 | 			}
337 | 			if u.Scheme == "" {
338 | 				u.Scheme = "https"
339 | 			}
340 | 			gitlabRootURL = u.String()
341 | 		}
342 | 
343 | 		projectPath = strings.TrimSpace(projectPath)
344 | 		projectID = strings.TrimSpace(projectID)
345 | 
346 | 		return nil
347 | 	}
348 | 
349 | 	app.Action = func(c *cli.Context) error {
350 | 		return commandCheck(c)
351 | 	}
352 | 
353 | 	err := app.Run(os.Args)
354 | 	if err != nil {
355 | 		panic(err)
356 | 	}
357 | }
358 | 


--------------------------------------------------------------------------------
/netrc.go:
--------------------------------------------------------------------------------
 1 | package main
 2 | 
 3 | import (
 4 | 	"net/url"
 5 | 	"os"
 6 | 	"runtime"
 7 | 
 8 | 	"github.com/bgentry/go-netrc/netrc"
 9 | 	"github.com/mitchellh/go-homedir"
10 | )
11 | 
12 | // Search for a token in netrc
13 | // A gitlab token is used from the account of named machine (NOT the "default" entry), and only if the login is empty
14 | // or not defined.
15 | // e.g.: for gitlab.com, the .netrc entry should be:
16 | //
17 | //	 machine gitlab.com
18 | //	   # possible login and password
19 | //		account MY_PERSONAL_ACCESS_TOKEN
20 | //
21 | // This is because Gitlab does not allow token in basic auth, so token must be sent as HTTP Header.
22 | // To allow someone to use basic auth in other tools using .netrc, without conflicting with access token
23 | func getGitlabTokenFromNetrc(gitlabURL string) (string, error) {
24 | 	u, err := url.Parse(gitlabURL)
25 | 	if err != nil {
26 | 		return "", err
27 | 	}
28 | 	fqdn := u.Hostname()
29 | 	if fqdn == "" {
30 | 		return "", nil
31 | 	}
32 | 
33 | 	path, err := getNetrcFilePath()
34 | 	if err != nil {
35 | 		return "", err
36 | 	}
37 | 
38 | 	if path == "" {
39 | 		return "", nil
40 | 	}
41 | 
42 | 	machine, err := netrc.FindMachine(path, fqdn)
43 | 	if err != nil {
44 | 		return "", nil
45 | 	}
46 | 	if !machine.IsDefault() && machine.Account != "" {
47 | 		return machine.Account, nil
48 | 	}
49 | 
50 | 	return "", nil
51 | }
52 | 
53 | // Returns the .netrc file path to load
54 | // If an empty string is returned with no error, it means
55 | func getNetrcFilePath() (string, error) {
56 | 	path := netrcFile
57 | 	if path == "" {
58 | 		path = os.Getenv("NETRC")
59 | 		if path == "" {
60 | 			filename := ".netrc"
61 | 			if runtime.GOOS == "windows" {
62 | 				filename = "_netrc"
63 | 			}
64 | 
65 | 			var err error
66 | 			path, err = homedir.Expand("~/" + filename)
67 | 			if err != nil {
68 | 				return "", err
69 | 			}
70 | 		}
71 | 	}
72 | 
73 | 	// If the path is not a file, then do nothing
74 | 	if fi, err := os.Stat(path); err != nil {
75 | 		// File doesn't exist, do nothing
76 | 		if os.IsNotExist(err) {
77 | 			return "", nil
78 | 		}
79 | 
80 | 		// Some other error!
81 | 		return "", err
82 | 	} else if fi.IsDir() {
83 | 		// File is directory, ignore
84 | 		return "", nil
85 | 	}
86 | 
87 | 	return path, nil
88 | }
89 | 


--------------------------------------------------------------------------------