gitlab-mirror-pull 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e343e194f74fb9e356de661a414b703f42071fdd1ff381b8b6bf8b08ab3721f
-  data.tar.gz: cbcf48554695a76c1dde6079332275a20db59a2ed9c188999b6df74c348a48c4
+  metadata.gz: 8557f20c19f73f034576cde8d4dc3ed225ea955300d531039c6b98c60f54c3d6
+  data.tar.gz: 2912222346f47b693d93343c819e080abef2f393d0c4d225bee7c5ee2aa16126
 SHA512:
-  metadata.gz: 0bdfa1755e8395ff06e64b8e7986c3764a0973cb047cb720389fc670570e0067cc697ffc5f54e4636b60646ec02fcdab96d29f94fa7a05d95ae6b124bffcf206
-  data.tar.gz: 4690df4b67c1375dbf5ac055c0983a338d6205a97fb27d9508dced64f63b9d29d6ef16fbc4e25b9cb486b0316c35a93ffb94a2cf899e95b1139d613f1a04f0ed
+  metadata.gz: f0a6af061d5c4fe1404fa04b759655021df928b21cc2deb326544791a2823a0986aad86ac7a8f9fbebf53034825222f8fa2828d26d48d708ae3b27cedc6367f8
+  data.tar.gz: 6a817d57bb0d439611db9c44e76be08f31c2709064532464d2175fa27d106d0e5ff37879d655179464620e4c3776443a47d9bd37cfa715e1b7a6f44290a872e7

data/README.md

@@ -9,6 +9,7 @@ Update your git repositories automatically when `remote` is set
 * Adds a command to fetch repositories
 * Run a tiny Webserver to integrate with Gitlabs webhooks
 * Adds init script to `/etc/init.d/gitlab-mirror-server`
+* Send mail on error or just for reporting
 
 # Install (for development)
 
@@ -32,6 +33,28 @@ gem install gitlab-mirror-pull
 
 :warning: Make sure you run the script/server as `git` user. This is default for omnibus installation but may differ. In case you run the binary directly use this command `sudo -u git -H gitlab-mirror-pull`
 
+### Configuration (config.yml)
+
+```yaml
+git:
+  path: "/usr/bin/git"
+  repos: "/var/opt/gitlab/git-data/repositories" # Default path of gitlab omnibus installation
+ignore:
+  - "group-name/project-name" # Ignore single repo
+  - "group-name" # Ignore entire group
+provider: # provider equals to "remote" set in your repository
+  - "github"
+  - "gitlab"
+server:
+  port: 8088
+  bind: "localhost"
+mail:
+  sender: "example@gmail.com"
+  receiver: "example@gmail.com"
+  send_on_error: false
+  send_report: false
+```
+
 ### Run
 
 ```bash

data/config.example.yml

@@ -7,6 +7,23 @@ ignore:
 provider: # provider equals to "remote" set in your repository
   - "github"
   - "gitlab"
+api:
+  url: "https://gitlab.example.org/"
+  token: "XXXXXXXXXXX"
+pipeline:
+  enabled: false
+  trigger:
+    -
+      repo: "user_group/repo_1" # Run pipeline for single project
+      branch: "master" # Branch to trigger pipeline
+    -
+      repo: "user_group/repo_1" # Run pipeline for single project
+      branch: "user_group" # Branch to trigger pipeline
 server:
   port: 8088
   bind: "localhost"
+mail:
+  sender: "example@gmail.com"
+  receiver: "example@gmail.com"
+  send_on_error: false
+  send_report: false

data/lib/gitlab_mirror_pull.rb

@@ -2,6 +2,7 @@ require 'optparse'
 require 'git'
 require 'logger'
 require 'yaml'
+require 'mail'
 
 # Fetch Gitlab repositories
 class GitlabMirrorPull
@@ -19,6 +20,33 @@ class GitlabMirrorPull
     @log = Logger.new(STDOUT)
     @log.level = log_level
     @config = YAML.load_file(config)
+
+  end
+
+  def clean_html(email_body = '')
+    email_body.gsub(/<\/?[^>]*>/, ' ').gsub(/\n\n+/, '\n').gsub(/^\n|\n$/, ' ')
+  end
+
+  def send_mail(text)
+    email_body_text = self.clean_html(text)
+    email_body_html = text
+    sender = "#{@config['mail']['sender']}"
+    receiver = "#{@config['mail']['receiver']}"
+    mail = Mail.new do
+      from "#{sender}"
+      to "#{receiver}"
+      subject 'Gitlab Mirror Pull'
+      text_part do
+        body "#{email_body_text}"
+      end
+
+      html_part do
+        content_type 'text/html; charset=UTF-8'
+        body "#{email_body_html}"
+      end
+    end
+    mail.delivery_method :sendmail
+    mail.deliver!
   end
 
   # Prepare list of repositories
@@ -41,6 +69,33 @@ class GitlabMirrorPull
 
   end
 
+  # Trigger Pipeline if changes fetched and repo set in @confif['pipeline']['trigger']
+  #
+  # @param <String> fetch contains returned value of 'git fetch'
+  # @param <String> namespace of the project e.g. group-name/your-project
+  def trigger_pipeline(fetch, namespace)
+    to_trigger = self.pipeline_to_trigger(namespace)
+
+    if !fetch.to_s.empty? && to_trigger != false
+      repo_encoded = url_encode(namespace)
+      gitlab_api_project = Gitlab.client(endpoint: "#{@config['api']['url']}/api/v4", private_token: @config['api']['token'])
+      gitlab_api_project.create_pipeline("#{repo_encoded}", "#{to_trigger}")
+    end
+  end
+
+  # Check config if pipeline should trigger
+  #
+  # @param <String> repo_namespace of the project e.g. group-name/your-project
+  # @return <Boolean> true/false
+  def pipeline_to_trigger(repo_namespace)
+    @config['pipeline']['trigger'].each do |trigger|
+      if repo_namespace.include?("#{trigger["repo"]}")
+        return trigger['branch']
+      end
+    end
+    return false
+  end
+
   # Fetch repositories return by `repositories_to_fetch`
   #
   # @param [Array<String>] repos with absolute path to repositories you want to fetch
@@ -51,7 +106,9 @@ class GitlabMirrorPull
     Git.configure do |config|
       config.binary_path = "#{@config['git']['path']}"
     end
+
     @return_repos = []
+    @error_repos = ""
     # Loop through repos and fetch it
     repos_to_fetch = repos.nil? ? self.repositories_to_fetch : repos
     repos_to_fetch.each do |repo|
@@ -62,13 +119,33 @@ class GitlabMirrorPull
           # Determine which "remote" to fetch e.g. "git fetch github"
           if @config['provider'].include?("#{remote}")
             @log.info("Fetching remote #{remote} in #{repo}")
-            g.remote(remote).fetch
-            @return_repos << repo
+            begin
+              g.remote(remote).fetch
+              @return_repos << repo
+            rescue => e
+              @error_repos << "<b>Failed to fetch remote #{remote} in #{repo}</b>\n"
+              @error_repos << "<pre>#{e.message}</pre>"
+            end
           end
         end
       end
     end
+
+    # Prepare text for error mail
+    if !@error_repos.empty? && @config['mail']['send_on_error'] == true
+      mail = @error_repos.to_s
+      text = "<h1>Failed to fetch some repositories:</h1>\n#{mail}"
+      self.send_mail(text)
+    end
+
+    # Prepare text for report mail
+    if @config['mail']['send_report'] == true
+      mail = @return_repos.join("<br>")
+      mail_error = @error_repos.empty? ? '<br><br>Yey, no update failed!..' : "<h1>Repos failed to fetch:</h1>\n #{@error_repos.to_s}"
+      text = "<h1>Repos updated:</h1>\n#{mail} #{mail_error}"
+      self.send_mail(text)
+    end
+
     @return_repos
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-mirror-pull
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - ochorocho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -50,8 +50,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.3
-description: Checks for repositories with a set remote and run git fetch on these
-  ...
+description: 'Checks for gitlab repositories with a set remote and run git fetch on
+  these. Features: send mail for reports/error, webhook integration, trigger pipeline'
 email: rothjochen@gmail.com
 executables:
 - gitlab-mirror-pull