gitlab-ci-lint 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 801f9398596102e9cda05d2610654fe293a27bbf9a4befa6d7797e16c13514af
-  data.tar.gz: 7e0950e63f65162ec3c5075b306c626d701a9478069778688a1d2c7fcb3f02d2
+  metadata.gz: cffebdc201d489ae951e0f6761e0c4ca27664aaf596fd3e30a1eef1339a7b3d0
+  data.tar.gz: 882456be9df1cf3dc63bf09e4b7ff1e377a30fe7a277af23818294605e011272
 SHA512:
-  metadata.gz: 6cb1b77b14b8f640fe781971e10b2774fa2c55ccea07e2b05b1796c8ff117fea07982a916cf2aceab74942a4ec6164eb59356b8d7f075cfe7ddb9f2d4990dc89
-  data.tar.gz: 0323f576a3eda307e30445dd5781fcca8c814d7e1113700236d330e495dda37540853bd2581c0312d023367e96c6818fb69726721b07b4b4f29659e67d089303
+  metadata.gz: 84f369a18d824a09c94dff43f04c48580fa5b82fb6f4899899bd37a07b8162111c4fecca45ae4eb39d09600de70f0289bec2a1c9ad95b4c9111e32d33cd958af
+  data.tar.gz: 000c527aeabbf728deaa1fa291cd85a52ec918b2d87b6a70a09da4561decfbb36c5180deac72d35c4c9d9504af14d6f476893ac07258941bd0797676993fc4b8

data/CHANGELOG.md

@@ -2,14 +2,37 @@
 
 All important changes to this project will be added to this file! This changelog will be based on [Keep a change log](http://keepachangelog.com/)
 
-## 1.0.1 - Rakefile - [28-04-2020]
+## 0.1.2 - Core Project - [29-04-2020]
+
+### Added
+
+* Many, many features have been added.
+* Dockerfile and Docker Compose support.
+* Class:
+  * GitLab::CI::Lint::Actions.
+  * GitLab::CI::Lint::Arguments.
+  * GitLab::CI::Lint::Client.
+  * GitLab::CI::Lint::Configuration.
+  * GitLab::CI::Lint::Log.
+  * GitLab::CI::Lint::MultIO.
+  * GitLab::CI::Lint::Serializer.
+  * GitLab::CI::Lint::System.
+  * GitLab::CI::Lint::YMLReader.
+* Create a CLI to get values from bash.
+* Create a YMLReader to get values from yml files.
+* Create Client Request GitLab CI to post the content of .gitlab to the API.
+* Actions to evaluate the result.
+* Request validations.
+* YAML validations
+
+## 0.1.1 - Rakefile - [28-04-2020]
 
 ### Added
 
 * Rake file modules.
 * Taks in Rakefile.
 
-## 1.0.0 - Just Initial Adding Files - [27-04-2020]
+## 0.1.0 - Just Initial Adding Files - [27-04-2020]
 
 ### Added
 

data/Gemfile

@@ -12,4 +12,5 @@ group :development do
   gem "OptionParser"
   gem "yaml"
   gem "colorize"
+  gem "pry"
 end

data/README.md

@@ -1,4 +1,153 @@
-# GitLab CI Linter
+<p align="center">
+  <img alt="gitlab" src="https://encrypted-tbn0.gstatic.com/images?q=tbn%3AANd9GcQYfhC8pImPXqjjQkZfOH2bAMltzPE5w9QMQJd8dUVqGCICbpF1&usqp=CAU" width="250px" float="center"/>
+</p>
+
+<h1 align="center">GitLab CI Lint your CI/CD File</h1>
+
+<p align="center">
+  <strong>This is a simple project that help when you want check your GitLab CI File</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/lpmatos/gitlab-ci-lint">
+    <img alt="Open Source" src="https://badges.frapsoft.com/os/v1/open-source.svg?v=102">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/graphs/contributors">
+    <img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint">
+    <img alt="GitHub Language Count" src="https://img.shields.io/github/languages/count/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint">
+    <img alt="GitHub Top Language" src="https://img.shields.io/github/languages/top/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/stargazers">
+    <img alt="GitHub Stars" src="https://img.shields.io/github/stars/lpmatos/gitlab-ci-lint?style=social">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/commits/master">
+    <img alt="GitHub Last Commit" src="https://img.shields.io/github/last-commit/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint">
+    <img alt="Repository Size" src="https://img.shields.io/github/repo-size/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/issues">
+    <img alt="Repository Issues" src="https://img.shields.io/github/issues/lpmatos/gitlab-ci-lint">
+  </a>
+
+  <a href="https://github.com/lpmatos/gitlab-ci-lint/blob/master/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/lpmatos/gitlab-ci-lint">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#pre-requisites">Pre-Requisites</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#description">Description</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#environment-variables">Environment Variables</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
+  <a href="#how-to-contribute">How to contribute</a>
+</p>
+
+## ▶️ Getting Started
+
+Starting with **git clone**:
+
+```bash
+git clone --depth 1 https://github.com/lpmatos/gitlab-ci-lint.git -b master
+```
+
+This will give access on your local machine to this project.
+
+## ☕ Buy me a coffee
+
+Pull requests are welcome. If you'd like to support the work and buy me a ☕, I greatly appreciate it!
+
+<a href="https://www.buymeacoffee.com/EatdMck" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 100px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
+
+## 🚏 Pre-requisites
+
+To this project you yeed:
+
+- Ruby.
+- Docker.
+- Docker Compose.
+- Install all Dependencies.
+
+## Gem Steps
+
+```bash
+gem build .\gitlab.gemspec
+gem install .\gitlab-ci-lint-0.1.2.gem
+gem push .\gitlab-ci-lint-0.1.2.gem
+```
+
+## Environment variables
+
+**Name**  |  **Description**
+:---:  |  :---:
+**GITLAB_ENDPOINT**  |  GitLab API Lint Endpoint
+**GITLAB_CI_FILE**  |  GitLab CI File
+**VALUES**  |  Values File
+**LOG_FILE**  |  Log File
+
+## 🐋 Development with Docker
+
+Steps to build the Docker Image.
+
+### Build
+
+```bash
+docker image build -t <IMAGE_NAME> -f <PATH_DOCKERFILE> <PATH_CONTEXT_DOCKERFILE>
+docker image build -t <IMAGE_NAME> . (This context)
+```
+
+### Run
+
+Steps to run the Docker Container.
+
+* **Linux** running:
+
+```bash
+docker container run -d -p <LOCAL_PORT:CONTAINER_PORT> <IMAGE_NAME> <COMMAND>
+docker container run -it --rm --name <CONTAINER_NAME> -p <LOCAL_PORT:CONTAINER_PORT> <IMAGE_NAME> <COMMAND>
+```
+
+* **Windows** running:
+
+```
+winpty docker.exe container run -it --rm <IMAGE_NAME> <COMMAND>
+```
+
+For more information, access the [Docker](https://docs.docker.com/) documentation or [this](docs/annotations/docker.md).
+
+## 🐋 Development with Docker Compose
+
+Build and run a docker-compose.
+
+```bash
+docker-compose up --build
+```
+
+Down all services deployed by docker-compose.
+
+```bash
+docker-compose down
+```
+
+Down all services and delete all images.
+
+```bash
+docker-compose down --rmi all
+```
+
+## 📣 Usage
+
+<kbd>gitlab_ci_lint --help</kbd> - Helper
 
 ## 🎒 How to contribute
 
@@ -39,6 +188,21 @@ Hey!! If you like this project or if you find some bugs feel free to contact me
 [![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)
 
+## ✨ Contributors
+
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/lpmatos"><img src="https://avatars2.githubusercontent.com/u/58797390?s=400&v=4" width="100px;" alt=""/><br /><sub><b>Lucca Pessoa</b></sub></a><br /><a href="https://github.com/lpmatos/gitlab-ci-lint/commits?author=lpmatos" title="Code">💻</a></a></td>
+  <tr>
+</table>
+
+## 🐯 Autor
+
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/lpmatos"><img src="https://avatars2.githubusercontent.com/u/58797390?s=400&v=4" width="100px;" alt=""/><br /><sub><b>Lucca Pessoa</b></sub></a><br /><a href="https://github.com/lpmatos/gitlab-ci-lint/commits?author=lpmatos" title="Code">💻</a> <a href="https://github.com/lpmatos/gitlab-ci-lint/commits?author=lpmatos" title="Design">🎨</a></td>
+  <tr>
+</table>
 
 ## Project Status
 
@@ -46,4 +210,4 @@ Hey!! If you like this project or if you find some bugs feel free to contact me
 
 ---
 
-Feito com ❤️ by **Lucca Pessoa**
+<p align="center">Feito com ❤️ by <strong>Lucca Pessoa :wave:</p>

data/bin/console

@@ -0,0 +1,6 @@
+require "bundler/setup"
+require "pry"
+
+require File.expand_path('../lib/telegram/bot', __dir__)
+
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/{bin/gitlab_ci_lint → exemple/lint.rb}

@@ -1,5 +1,3 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "/../lib"))
-
 require "gitlab/ci/lint"
 require "gitlab/ci/lint/arguments"
 require "gitlab/ci/lint/configuration"

data/gitlab.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.platform       = Gem::Platform::RUBY
   spec.authors        = ["Lucca Pessoa da Silva Matos"]
   spec.email          = "luccapsm@gmail.com"
-  spec.summary        = %q{Validate your gitlab-ci.yml files}
+  spec.summary        = %q{Validate your gitlab-ci.yml file}
   spec.description    = "Gitlab CI Lint"
   spec.homepage       = "https://github.com/lpmatos/gitlab-ci-lint"
   spec.metadata["homepage_uri"] = spec.homepage
@@ -22,9 +22,13 @@ Gem::Specification.new do |spec|
   spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.bindir        = "bin"
   spec.require_paths = ["lib"]
-  spec.license       = 'MIT'
-  spec.add_development_dependency "httparty", "~> 0.18.0"
-  spec.add_development_dependency "OptionParser", "~> 0.5.1"
-  spec.add_development_dependency "yaml", "~> 0.1.0"
-  spec.add_development_dependency "colorize", "~> 0.8.1"
+  spec.license       = "MIT"
+
+  spec.add_dependency  "httparty", "~> 0.18.0"
+  spec.add_dependency  "OptionParser", "~> 0.5.1"
+  spec.add_dependency  "yaml", "~> 0.1.0"
+  spec.add_dependency  "colorize", "~> 0.8.1"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 3.4"
 end

data/lib/gitlab/ci/lint.rb

@@ -1,14 +1,14 @@
+require "gitlab/ci/lint/yml"
+require "gitlab/ci/lint/log"
+require "gitlab/ci/lint/system"
+require "gitlab/ci/lint/actions"
+
 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
+        actions = GitLab::CI::Lint::Actions.new
 
         system.file_exist?(values, "Error: You must specify the values.yml file")
 
@@ -31,16 +31,9 @@ module Gitlab
             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)
+        logger.info("Starting GitLab CI YML Validation...")
 
-        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
+        actions.validate_gitlab_ci_yml(gitlab_endpoint, gitlab_ci_file)
 
         return 0
       end

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

@@ -1,10 +1,19 @@
 require "gitlab/ci/lint/client"
+require "gitlab/ci/lint/serializer"
 
 module GitLab
   module CI
     module Lint
       class Actions < GitLab::CI::Lint::Client
-
+        def validate_gitlab_ci_yml url, content
+          result = post(url, content)
+          message = GitLab::CI::Lint::Serializer.new(result)
+          if result["status"] == "valid"
+            message.success()
+          else
+            message.failure()
+          end
+        end
       end
     end
   end

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

@@ -63,6 +63,7 @@ module GitLab
           puts string
           exit
         end
+
       end
     end
   end

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

@@ -1,33 +1,39 @@
-require "httparty"
 require "json"
-require_relative "./yml.rb"
+require "httparty"
+require "gitlab/ci/lint/yml.rb"
 
 module GitLab
   module CI
     module Lint
       class Client
-        def get_gitlab_ci_lint url, content
+        include HTTParty
+
+        def initialize
+          @headers = { "Content-Type" => "application/json" }
+        end
+
+        def post url, content
           begin
-            if url.kind_of? String
-                content = GitLab::CI::Lint::YMLReader.new(content).get_json_content()
-                if content
-                  request = HTTParty.post(url, :body => { content: content }.to_json, :headers => { "Content-Type" => "application/json" })
-                  if request.code == 200
-                    return JSON.parse(request.body)
-                  else
-                    puts "Error - Bad Request #{request.code}"
-                    exit
-                  end
-                else
-                  puts "Error - No Content..."
-                  exit
-                end
+            if content = GitLab::CI::Lint::YMLReader.new(content).get_json_content()
+              body = { content: content }.to_json
+              request = self.class.post(url, :body => body, :headers => @headers)
+              if request.code == 200
+                puts "\nSuccessful request!"
+                return JSON.parse(request.body)
+              else
+                puts "Error - Bad Request #{request.code}"
+                exit
+              end
+            else
+              puts "\nError - No Content..."
+              exit
             end
           rescue => error
-              puts "\nError - #{error}"
+            puts "\nError Post - #{error}"
           end
         end
       end
+
     end
   end
 end

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

@@ -19,6 +19,7 @@ module GitLab
         def self.colorize(message, color="default", backgroud_color="default")
           return "\033[#{BACKGROUD_COLORS[backgroud_color]};#{COLORS[color]}m#{message}\033[0m"
         end
+
       end
     end
   end

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

@@ -21,6 +21,7 @@ module GitLab
             "log_file" => @log_file
           }
         end
+
       end
     end
   end

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

@@ -47,6 +47,7 @@ module GitLab
         def warn message
           @logger.warn(message)
         end
+
       end
     end
   end

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

@@ -13,6 +13,7 @@ module GitLab
         def close
           @targets.each(&:close)
         end
+
       end
     end
   end

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

@@ -0,0 +1,55 @@
+module GitLab
+  module CI
+    module Lint
+      class Serializer
+        attr_reader :content
+
+        def initialize content
+          @content = content
+          @sucess_message = "Your GitLab CI File is Okay.".colorize(:green)
+          @failure_message = "Your GitLab CI File is Invalid.".colorize(:red)
+          @serialize = serialize
+        end
+
+        def success
+          puts """
+Result: #{@sucess_message}
+
+Information:
+
+* Status: #{@serialize[:status]}
+* Erros: #{@serialize[:errors]}
+
+Yeaaaah!!!! Congrats!!!!
+          """
+        end
+
+        def failure
+          puts """
+Result: #{@failure_message}
+
+#{"Information".colorize(:yellow)}
+
+* Status: #{@serialize[:status].colorize(:red)}
+* Erros: #{@serialize[:errors].to_s.colorize(:red)}
+
+Baaaaaad GitLab CI! Fuck man, you're a idiot...
+          """
+          puts "Error Details:\n".colorize(:yellow)
+          @content["errors"].each_with_index do |value, index|
+            puts "Error #{index} - #{value}"
+          end
+          puts
+        end
+
+        def serialize
+          {
+            :status => @content["status"],
+            :error => @content["errors"]
+          }
+        end
+
+      end
+    end
+  end
+end

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

@@ -15,6 +15,7 @@ module GitLab
             return 1
           end
         end
+
       end
     end
   end

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

@@ -1,7 +1,7 @@
 module Gitlab
   module Ci
     module Lint
-      VERSION = "0.1.2".freeze
+      VERSION = "0.1.3".freeze
     end
   end
 end

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

@@ -8,6 +8,13 @@ module GitLab
         attr_reader :file
         def initialize file
           @file = file
+          validate!
+        end
+
+        def validate!
+          unless @file.chars.last(4).join == ".yml" or @file.chars.last(5).join == ".yaml"
+            raise ArgumentError.new("We need a YML File...")
+          end
         end
 
         def get_content

data/values.yml

@@ -5,7 +5,6 @@
 ---
 gitlab:
   endpoint: "https://gitlab.com/api/v4/ci/lint"
-  token: "9q41a8mmjAs4zjxmY6sm"
   file: ".gitlab-ci.yml"
 log:
   file: "file.log"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-ci-lint
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Lucca Pessoa da Silva Matos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -17,7 +17,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.0
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -31,7 +31,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,7 +45,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,17 +59,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 description: Gitlab CI Lint
 email: luccapsm@gmail.com
 executables:
-- gitlab_ci_lint
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -77,6 +106,7 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".rspec_status"
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
@@ -84,12 +114,14 @@ files:
 - Makefile
 - README.md
 - Rakefile
-- bin/gitlab_ci_lint
+- bin/console
+- bin/setup
 - docker-compose.yml
 - docs/annotations/docker.md
 - docs/annotations/rake.md
 - docs/annotations/replace.md
 - docs/annotations/structure.md
+- exemple/lint.rb
 - gitlab.gemspec
 - lib/gitlab/ci/lint.rb
 - lib/gitlab/ci/lint/actions.rb
@@ -99,6 +131,7 @@ files:
 - lib/gitlab/ci/lint/configuration.rb
 - lib/gitlab/ci/lint/log.rb
 - lib/gitlab/ci/lint/multio.rb
+- lib/gitlab/ci/lint/serializer.rb
 - lib/gitlab/ci/lint/system.rb
 - lib/gitlab/ci/lint/version.rb
 - lib/gitlab/ci/lint/yml.rb
@@ -129,5 +162,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Validate your gitlab-ci.yml files
+summary: Validate your gitlab-ci.yml file
 test_files: []