gitlab-ci-lint 0.1.1 → 0.1.2

data/Makefile

@@ -0,0 +1,50 @@
+# =============================================================================
+# DECLARING VARIABLES
+# =============================================================================
+
+# DOCKERFILE PATH
+PATH_DOCKERFILE=./Dockerfile
+
+# DOCKERFILE CONTENTX
+CONTEXT_DOCKERFILE=./
+
+# CONTAINERS
+DOCKER_CONTAINER_LIST:=$(shell docker ps -aq)
+
+# =============================================================================
+# DOCKER BUILD
+# =============================================================================
+
+build:
+	docker image build --no-cache -t gitlab-ci-lint -f ${PATH_DOCKERFILE} ${CONTEXT_DOCKERFILE}
+
+system:
+	docker system prune -af
+
+volume:
+	docker volume prune -f
+
+network:
+	docker network prune -f
+
+stop:
+	docker stop ${DOCKER_CONTAINER_LIST}
+
+remove:
+	docker rm ${DOCKER_CONTAINER_LIST}
+
+# =============================================================================
+# DOCKER-COMPOSE
+# =============================================================================
+
+compose:
+	docker-compose up --build
+
+back:
+	docker-compose up --build -d
+
+down:
+	docker-compose down
+
+delete:
+	docker-compose down --rmi all

data/README.md

@@ -1 +1,49 @@
-# GitLab CI Linter 
+# GitLab CI Linter
+
+## 🎒 How to contribute
+
+1. Make a **Fork**.
+2. Follow the project organization.
+3. Add the file to the appropriate level folder - If the folder does not exist, create according to the standard.
+4. Make the **Commit**.
+5. Open a **Pull Request**.
+6. Wait for your pull request to be accepted.. 🚀
+
+Remember: There is no bad code, there are different views/versions of solving the same problem. 😊
+
+## 🔔 Add to git and push
+
+You must send the project to your GitHub after the modifications
+
+```bash
+git add -f .
+git commit -m "Added - Fixing somethings"
+git push origin master
+```
+
+## 📋 Versioning
+
+- [CHANGELOG](CHANGELOG.md)
+
+## 📜 License
+
+Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
+
+## ☎️ Contacts
+
+Hey!! If you like this project or if you find some bugs feel free to contact me in my channels:
+
+* **Email**: luccapsm@gmail.com
+* **Linkedin**: www.linkedin.com/in/lucca-pessoa-4abb71138/
+
+[![Facebook](https://github.frapsoft.com/social/facebook.png)](https://www.facebook.com/lucca.pessoa.9)
+[![Github](https://github.frapsoft.com/social/github.png)](https://github.com/lpmatos)
+
+
+## Project Status
+
+* 🔛 In production
+
+---
+
+Feito com ❤️ by **Lucca Pessoa**

data/bin/gitlab_ci_lint

@@ -1,11 +1,16 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "/../lib"))
-require "gitlab/ci/lint"
-
-infile = ARGV.shift
-
-unless infile
-  $stderr.puts("Usage #{$0} <path/to/.gitlab-ci.yml>")
-  exit 1
-end
-
-Gitlab::Ci::Lint.validate(infile)
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "/../lib"))
+
+require "gitlab/ci/lint"
+require "gitlab/ci/lint/arguments"
+require "gitlab/ci/lint/configuration"
+
+arguments = GitLab::CI::Lint::Arguments.new
+options = arguments.command_line_parser()
+
+configuration = GitLab::CI::Lint::Configuration.new
+
+values = options["values"] ?
+  options["values"] : (configuration.values ?
+  configuration.values : "values.yml")
+
+Gitlab::Ci::Lint.validate(values, configuration, options)

data/docker-compose.yml

@@ -0,0 +1,45 @@
+# =============================================================================
+# BASE CONFIGURATION
+# =============================================================================
+
+version: "3.7"
+
+# =============================================================================
+# SERVICES
+# =============================================================================
+
+services:
+
+# =============================================================================
+# GITLAB CI LINT
+# =============================================================================
+
+  gitlab-ci-lint:
+    container_name: ${CONTAINER_NAME}
+    env_file: ./.env
+    build:
+      context: ./${PATH_DOCKERFILE}
+      dockerfile: Dockerfile
+    entrypoint: >
+      /bin/sh -c "
+        set -e
+        ruby ./bin/gitlab_ci_lint
+        /bin/bash || exit 0
+      "
+    restart: unless-stopped
+    stdin_open: true
+    tty: true
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "500k"
+        max-file: "20"
+    networks:
+      - gitlab-ci-lint
+
+# =============================================================================
+# NETWORKS
+# =============================================================================
+
+networks:
+  gitlab-ci-lint:

data/docs/annotations/replace.md

@@ -0,0 +1,128 @@
+# Ruby Sub and Gsub - Replace String
+
+Em Ruby, quando estamos falando da classe String, no geral, podemos fazer o replace do conteúdo de uma string de duas formas:
+
+* Utilizando o método sub().
+* Utilizando o método gsub().
+
+Expressões Regulares também são utilizadas, porém para casos um pouco mais complexos.
+
+## Description
+
+Portanto, as substituições de string podem ser feitas com os métodos sub() e gsub(). Eles são métodos de substituição da classe String. A grande diferença entre os dois é que o gsub() aplicará a substituição globalmente.
+
+Nesses métodos podemos utilizar Expressões Regulares ou Strings como argumentos.
+
+## Exemples
+
+Vamos iniciar com um exemplo. Usamos o sub! para substituirmos inline e o sub para substituir retornando uma outra string. Nessa chamadas o primeiro argumento é substituído pelo segundo.
+
+```ruby
+animal = "gato"
+
+# Replace string at with ote.
+animal.sub!("at", "ote")
+puts animal
+
+animal = "passarinho"
+
+# This version of sub does not change the string in-place.
+animal = animal.sub("inho", "ado")
+puts animal
+```
+
+## Gsub and Sub
+
+O método sub() substitui apenas a primeira instância de uma string por outra. Enquanto isso, o gsub, substitui todas as instâncias.
+
+Assim, o gsub() é mais próximo de um método replace string. Sub é conceitualmente um mpetodo de substituir a primeira string.
+
+```ruby
+value = "abc abc"
+puts value
+
+# Sub replaces just the first instance.
+value = value.sub("abc", "---")
+puts value
+
+# Gsub replaces all instances.
+value = value.gsub("abc", "---")
+puts value
+```
+
+## Substring
+
+Podemos atribuir uma substring dentro de uma string. Essa sintaxe tem o mesmo efeito de chamar o método sub em uma string. Irá ser substituído apenas a primeira ocorrência.
+
+Dicas: Expressões Regulares, intervalos e índices podem ser usados. A atribuição de substring é versátil e fácil de executar.
+
+```ruby
+value = "abc abc"
+puts value
+
+# A substring can be changed within a string.
+# ... Only the first instance is replaced.
+value["abc"] = "def"
+puts value
+```
+
+## Regex - Sub
+
+Podemos especificar uma Regex como primeiro argumento para sub() e gsub(). Qualquer metacaractere de expressão regular pode ser utilizado aqui.
+
+```ruby
+value = "cat and dog"
+
+# Replaced at a matching the regexp with another string.
+value.sub!(/c\w\w/, "bird")
+puts value
+```
+
+Regexp pattern:
+
+* c    The lowercase letter "c".
+* \w   A word character (letter or digit).
+
+## Regex - Gsub
+
+O método gsub também pode ser utilizado com expressão regular. Ao contrário do sub, ele irá substituir todas as ocorrências.
+
+```ruby
+value = "quickly, slowly or happily"
+
+# Replace all word sending with "ly" with a string.
+value.gsub!(/\w+ly/, "REP")
+puts value
+```
+
+Regexp pattern:
+
+
+Ruby program that uses gsub with regexp
+
+value = "quickly, slowly or happily"
+
+# Replace all word sending with "ly" with a string.
+value.gsub!(/\w+ly/, "REP")
+puts value
+
+Output
+
+REP, REP or REP
+
+Regexp pattern
+
+* \w+    One or more word characters.
+* ly     The lowercase substring "ly".
+
+## Methods Block
+
+Os métodos sub e gsub podem ser usados com blocos de métodos.
+
+```ruby
+value = "bird and fish"
+
+# Replace all four-letter words with an uppercase version.
+value.gsub!(/\w{4}/) {|word| "[" + word.upcase() + "]"}
+puts value
+```

data/gitlab.gemspec

@@ -23,9 +23,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.require_paths = ["lib"]
   spec.license       = 'MIT'
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "httparty", "~> 0.18.0"
   spec.add_development_dependency "OptionParser", "~> 0.5.1"
   spec.add_development_dependency "yaml", "~> 0.1.0"

data/lib/gitlab/ci/lint.rb

@@ -1,50 +1,50 @@
-module Gitlab
-  module Ci
-    module Lint
-      require File.expand_path("lint/reader/yml", File.dirname(__FILE__))
-      require File.expand_path("lint/settings/arguments", File.dirname(__FILE__))
-      require File.expand_path("lint/settings/configuration", File.dirname(__FILE__))
-      require File.expand_path("lint/settings/log", File.dirname(__FILE__))
-      require File.expand_path("lint/client", File.dirname(__FILE__))
-
-      def self.validate gitlab_ci_config
-        unless gitlab_ci_config
-          $stderr.puts('Error: You must specify the path to a .gitlab-ci.yml')
-          return 1
-        end
-        gitlab_ci_config = File.absolute_path(gitlab_ci_config)
-        unless File.readable?(gitlab_ci_config)
-          $stderr.puts("Error: Could not find file at '#{gitlab_ci_config}'")
-          return 1
-        end
-        begin
-          configuration = Configuration.new
-          logger = Log.instance
-          yml_reader = ReaderYMLFile.new(gitlab_ci_config)
-          options = command_line_parser()
-          values = yml_reader.get_content
-          gitlab = values["gitlab"]
-
-          gitlab_endpoint = options["endpoint"] ?
-            options["endpoint"] : ((!gitlab["endpoint"].to_s.empty? && !gitlab["endpoint"].nil?) ?
-            gitlab["endpoint"] : configuration.gitlab_endpoint)
-
-          gitlab_token = options["token"] ?
-            options["token"] : ((!gitlab["token"].to_s.empty? && !gitlab["token"].nil?) ?
-            gitlab["token"] : configuration.gitlab_token)
-
-          logger.info("Starting...")
-
-          puts "\nEndpoint: #{gitlab_endpoint}"
-          puts "Token: #{gitlab_token}\n"
-        rescue StandardError => e
-          $stderr.puts("Invalid: #{gitlab_ci_config}")
-          $stderr.puts("  * #{e}")
-          return 1
-        end
-        $stdout.puts("OK: #{gitlab_ci_config}")
-        return 0
-      end
-    end
-  end
-end
+module Gitlab
+  module Ci
+    module Lint
+      require File.expand_path("lint/yml", File.dirname(__FILE__))
+      require File.expand_path("lint/log", File.dirname(__FILE__))
+      require File.expand_path("lint/system", File.dirname(__FILE__))
+      require File.expand_path("lint/client", File.dirname(__FILE__))
+
+      def self.validate values, configuration, options
+        system = GitLab::CI::Lint::System.new
+        client = GitLab::CI::Lint::Client.new
+
+        system.file_exist?(values, "Error: You must specify the values.yml file")
+
+        values = File.absolute_path(values)
+
+        system.file_is_readable?(values, "Error: Could not find file at '#{values}'")
+
+        yml_reader = GitLab::CI::Lint::YMLReader.new(values)
+        content = yml_reader.get_content
+
+        gitlab = content["gitlab"]
+
+        logger = GitLab::CI::Lint::Log.instance
+
+        gitlab_endpoint = options["endpoint"] ?
+            options["endpoint"] : ((!gitlab["endpoint"].to_s.empty? && !gitlab["endpoint"].nil?) ?
+            gitlab["endpoint"] : configuration.gitlab_endpoint)
+
+        gitlab_ci_file = options["file"] ?
+            options["file"] : ((!gitlab["file"].to_s.empty? && !gitlab["file"].nil?) ?
+            gitlab["file"] : configuration.gitlab_ci_file)
+
+        logger.info("Starting - 1.0.0...")
+
+        result = client.get_gitlab_ci_lint(gitlab_endpoint, gitlab_ci_file)
+
+        if result["status"] == "valid"
+          puts "\nYour GitLab CI File is Okay: #{result}".colorize(:green)
+        else
+          puts "\nYour GitLab CI File is Invalid. Information:\n".colorize(:red)
+          puts result["errors"]
+        end
+
+        return 0
+      end
+
+    end
+  end
+end

data/lib/gitlab/ci/lint/actions.rb

@@ -0,0 +1,11 @@
+require "gitlab/ci/lint/client"
+
+module GitLab
+  module CI
+    module Lint
+      class Actions < GitLab::CI::Lint::Client
+
+      end
+    end
+  end
+end

data/lib/gitlab/ci/lint/arguments.rb

@@ -0,0 +1,69 @@
+require "optparse"
+require "colorize"
+require "gitlab/ci/lint/version"
+
+module GitLab
+  module CI
+    module Lint
+      class Arguments
+        attr_reader :program_name
+
+        def initialize
+          @program_name = File.basename(__FILE__).colorize(:yellow)
+          @program_version = Gitlab::Ci::Lint::VERSION.colorize(:yellow)
+          @options = {
+            verbose: false
+          }
+        end
+
+        def command_line_parser
+          OptionParser.new do |opts|
+            opts.banner = "Usage: example.rb [options]"
+            opts.on("-h", "--helper", "Show helper documentation") { |value| @options[:help] = helper() }
+            opts.on("-e", "--endpoint [GITLAB ENDPOINT]", "GitLab Endpoint") { |value| @options[:endpoint] = value }
+            opts.on("-t", "--token [GITLAB TOKEN]", "GitLab Token") { |value| @options[:token] = value }
+            opts.on("-f", "--file [GITLAB CI FILE]", "GitLab CI File") { |value| @options[:file] = value }
+            opts.on("-v", "--values [VALUES FILE]", "Values File") { |value| @options[:values] = value }
+            opts.on("-l", "--log [LOG GILE]", "Log File") { |value| @options[:log] = value }
+            opts.on("--verbose", "If set, print verbose output") { |value| @options[:verbose] = true }
+            opts.on("--version", "Show GitLab CI Lint Version") { |value| @options[:help] = version() }
+          end.parse!
+          return @options
+        end
+
+        private
+
+        def helper
+          string = """
+
+        Command Line Helper to the Program - #{@program_name}
+        Usage Exemple: ruby example.rb [global options] [command [command options]] [PATH]
+
+        Global options:
+        -h          | --helper                show GitLab CI help.
+        -e          | --endpoint              root URL of the GitLab instance to use API (default: 'https://gitlab.com')
+        -f          | --file                  FILE is the relative or absolute path to the gitlab-ci file
+        -d          | --directory             DIR is the directory from where to search for gitlab-ci file and git repository (default: '.')
+        -t          | --timeout               timeout in second after which http request to GitLab API will timeout (and the program will fails) (default: 5)
+        -n          | --no-color              don't color output. By defaults the output is colorized if a compatible terminal is detected.
+        -v          | --values                Values file with information.
+        -l          | --log                   LOG is the log file path.
+        -v          | --verbose               verbose mode.
+        -V          | --version               print the version information.
+        """
+          puts string
+          exit 1
+        end
+
+        def version
+          string = """
+
+          GitLab CI Lint Version: #{@program_version}
+          """
+          puts string
+          exit
+        end
+      end
+    end
+  end
+end