git-restart 0.0.3.pre.dev → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca21776a5dfec662c8579062b6d8f773cbc7d4b8
-  data.tar.gz: e50e4161d7396c3c21df74a73823d038f98a2ce7
+  metadata.gz: a6e1ed81be5f1e1b88b5f03998ed168bb3cea967
+  data.tar.gz: 64ecf291feb17510fdaf4e95eb310da327bfa0dd
 SHA512:
-  metadata.gz: f1ea9b99280652a6be8f4f9689366170b461015dad88bac71bfc260307984b03ae5609492dd64e6eeabae0443aa6236a640eb2196a60897cfec76278d4037595
-  data.tar.gz: 91541aa4bfde2aa0afacd46c1a1fc830e808a6eebc5d115519e3b4b745ba7f59c0019c4b183c77964c07d643c8124ed3c5cfd7de04bba0d0004c04481f8fd933
+  metadata.gz: 5fed7452a908ac52db44e2b32ae5d5c773d839ffdeb7f956b44f1dbbbd409fc3e1a7bf4ce8d8587c05bd1a4ee14c5b1acd6c29eaf77c633c98b3c3aa340c7191
+  data.tar.gz: d1779c9e0efedceeb64fc65c34901d659beec6ab3c1cbb80734328a2f9754a76f106343ff7b04f76bd80f79b74a5cef62b4d0d6b2886e28cb1063609ae118e8e

data/bin/git-restart

@@ -5,10 +5,18 @@ require 'git-restart/runner.rb'
 
 puts "Starting runner ..."
 
-target = ARGV[0] | ".gitrun"
+$taskfiles = Array.new();
+target = ".gitrun"
+ARGV.each do |t|
+	if(t =~ /\.gitrun$/)
+		target = t;
+	else
+		$taskfiles << t;
+	end
+end
 
-raise ArgumentError, "No valid task file specified!" unless File.exist? target
+raise ArgumentError, "No valid runner file specified!" unless File.exist? target
 
 load target
 
-GitRestart::Task.runner.mqtt.lock_and_listen
+GitRestart::Task.runner.mqtt.lockAndListen

data/lib/git-restart/runner.rb

@@ -1,6 +1,8 @@
 
 require 'mqtt/sub_handler'
+
 require 'git'
+require 'octokit'
 
 require_relative "task.rb"
 
@@ -9,12 +11,16 @@ module GitRestart
 		attr_accessor :name
 
 		attr_accessor :repo, :branches, :exclude_branches, :start_on
+		attr_accessor :allowed_tasks
 
 		attr_reader	  	:next_tasks
 		attr_reader		:current_task_file
 
+		attr_reader		:mqtt
+		attr_accessor	:octokit
+
 		def current_commit()
-			@git.object("HEAD^").sha;
+			@git.object("HEAD").sha;
 		end
 		def current_branch()
 			@git.current_branch();
@@ -23,9 +29,15 @@ module GitRestart
 			@current_modified;
 		end
 
-		def initialize()
+		def initialize(fileList = nil)
+			raise ArgumentError, "File list needs to be nil or an Array!" unless (fileList.is_a? Array or fileList.nil?)
+
 			GitRestart::Task.runner = self;
 
+			@allowed_tasks = Array.new();
+			@allowed_tasks << fileList if(fileList);
+			@allowed_tasks << $taskfiles unless($taskfiles.empty?)
+
 			@current_tasks = Hash.new();
 			@next_tasks		= Hash.new();
 
@@ -38,16 +50,15 @@ module GitRestart
 
 			yield(self);
 
+			@allowed_tasks.flatten!
+
 			@listenedSub = @mqtt.subscribe_to "GitHub/#{@repo}" do |data|
-				puts "Received data: #{data}"
 				begin
 					data = JSON.parse(data, symbolize_names: true);
 				rescue
 					next;
 				end
 
-				puts "Processing data #{data}"
-
 				next unless data[:branch];
 				if(not @branches.empty?)
 					next unless @branches.include? data[:branch];
@@ -55,16 +66,29 @@ module GitRestart
 					next if @exclude_branches.include? data[:branch];
 				end
 
-				puts "Queueing data!"
-
 				@branchQueue << data;
 			end
 
 			autostart();
 			_start_task_thread();
+
+			at_exit {
+				_stop_all_tasks();
+			}
 		end
 
 		def update_status(name, newStatus, message = nil)
+			puts "Task #{@name} assumed a new status: #{newStatus}#{message ? " MSG:#{message}" : ""}"
+
+			return unless @octokit;
+
+			begin
+			@octokit.create_status(@repo, current_commit(), newStatus, {
+					context: "#{@name}/#{name}".gsub(" ", "_"),
+					description: message,
+				})
+			rescue
+			end
 		end
 
 		def _start_task_thread()
@@ -72,8 +96,6 @@ module GitRestart
 				loop do
 					newData = @branchQueue.pop;
 
-					puts "Popped data: #{newData}"
-
 					@current_modified = newData[:touched];
 					_switch_to(newData[:branch], newData[:head_commit]);
 				end
@@ -106,23 +128,28 @@ module GitRestart
 				t.gsub!(/^\.\//,"");
 				@current_task_file = t;
 
-				# TODO Add proper error reporting
+				unless(@allowed_tasks.empty?)
+					next unless @allowed_tasks.include? @current_task_file
+				end
+
 				begin
 					load(t);
 				rescue ScriptError, StandardError
+					update_status("File #{t}", :failure, "File could not be parsed!")
 					puts("File #{t} could not be loaded!");
 				rescue GitRestart::TaskValidityError
+					update_status("File #{t}", :failure, "Task-file not configured properly!")
 					puts("Task-File #{t} is not configured properly!");
 				end
 			end
 
-			puts "Finished loading! Next tasks are: #{@next_tasks}"
+			puts "Finished loading! Next tasks: #{@next_tasks.keys}"
 		end
 
 		def _start_next_tasks()
 			_generate_next_tasks();
 
-			puts "Starting next tasks!"
+			puts "\nStarting next tasks!"
 			@next_tasks.each do |name, t|
 				next unless t.active;
 				next unless t.triggered?
@@ -133,19 +160,24 @@ module GitRestart
 		end
 
 		def _switch_to(branch, commit = nil)
-			puts "Switching to branch: #{branch}, commit: #{commit}"
-			@git.fetch();
+			puts "\n\nSwitching to branch: #{branch}#{commit ? ",commit: #{commit}" : ""}"
+
+			begin
+				@git.fetch();
+			rescue
+			end
 
 			if(branch != current_branch())
 				_stop_all_tasks();
 			else
 				_stop_triggered_tasks();
 			end
+			@git.reset_hard();
 			@git.checkout(branch);
-			@git.reset_hard(commit);
-
 			@git.merge("origin/#{branch}");
 
+			@git.reset_hard(commit);
+
 			_start_next_tasks();
 		end
 

data/lib/git-restart/task.rb

@@ -1,27 +1,58 @@
 
+# @author Xasin
 module GitRestart
+	# The Error-Class used to signal when a Task is set up wrong
 	class TaskValidityError < StandardError
 	end
 
+	# This class is used to define "Tasks". Each task represents
+	# a set of commands, which it executes in chronological order, or until
+	# a task errors.
+	# Additionally, it will kill execution of tasks with a specified kill-signal
+	# when an update was detected from GitHub.
+	# The failure-status of the tasks can also be reported via Octokit, allowing this
+	# to be used as a simple CI or Test system for various languages.
 	class Task
+		# The array of tasks to execute. Each target will be executed in the given
+		# order via `Process.spawn`.
+		# @return [Array<String>]
 		attr_reader 	:targets
 
+		# The signal (as String, like Signal.list) to use to kill the process.
+		# Can be nil to disable killing
 		attr_accessor 	:signal
+		# Whether or not to report failure if the currently running target
+		# has a non-zero exit status after having been killed. Only makes sense
+		# together with report_status
 		attr_accessor	:expect_clean_exit
+		# Whether or not to report failure/success status to GitHub using Octokit
 		attr_accessor	:report_status
+		# Defines this as a "CI_Task". Such a task will always run on an update,
+		# regardless what files changed. Useful if you always want a status report
+		# on GitHub.
 		attr_accessor  :ci_task
-		attr_accessor	:name, :status_file
-
+		# Name of the Task. *Required*. Used as *unique* ID, and to report status to GitHub
+		attr_accessor	:name
+		# The file to use to retrieve a single-line status info for the "description"
+		# string of the GitHub status. Only the last *non-indented* line is used,
+		# which allows the output of Minitest to be used directly.
+		attr_accessor  :status_file
+
+		# Whether or not this task is active. Usually set via #on_branches,
+		# but can be used to manually disable or enable this task based on
+		# config files, ENV variables etc.
 		attr_accessor	:active
 
+		# The last status-code of this Task. Used internally.
 		attr_reader		:lastStatus
+		# The last status-message of this task. Used internally.
 		attr_reader		:status_message
 
-		attr_reader		:mqtt
-
+		# @api private
 		def self.runner=(runner)
 			@runner = runner;
 		end
+		# @api private
 		def self.runner()
 			return @runner;
 		end
@@ -32,6 +63,10 @@ module GitRestart
 		def branch()
 			runner().current_branch();
 		end
+		def current_commit()
+			runner().current_commit();
+		end
+
 		def modified()
 			runner().current_modified();
 		end
@@ -69,6 +104,8 @@ module GitRestart
 
 			valid?
 
+			@status_file ||= "/tmp/TaskLog_#{@name}_#{current_commit()}";
+
 			if(runner().next_tasks[@name])
 				raise TaskValidityError, "A task of name #{@name} already exists!"
 			else
@@ -82,8 +119,12 @@ module GitRestart
 
 			@watched.each do |regEx|
 				modified().each do |f|
-					next unless f =~ /#{Regexp.quote(@chdir)}(.*)/
-					return true if $1 =~ regEx;
+					if regEx.to_s =~ /^\(\?\-mix:\\\/(.*)\)$/ then
+						return true if f =~ Regexp.new($1);
+					else
+						next unless f =~ /#{Regexp.quote(@chdir)}(.*)/
+						return true if $1 =~ regEx;
+					end
 				end
 			end
 
@@ -100,30 +141,55 @@ module GitRestart
 			end
 		end
 
+		def _rm_logfile()
+			if File.exist?("/tmp/TaskLog_#{@name}_#{current_commit()}") then
+				File.delete("/tmp/TaskLog_#{@name}_#{current_commit()}");
+			end
+		end
+		def _get_statusline()
+			return "No status specified" unless File.exist? @status_file
+
+			sMsg = ""
+			File.open(@status_file, "r") do |sFile|
+				sFile.each_line do |l|
+					l.chomp!
+					next if l == "";
+					next if l =~ /^\s+/;
+
+					sMsg = l;
+				end
+			end
+
+			return sMsg;
+		end
+
 		def _report_status(status, message = nil)
-			@status_message = ""
+			message ||= _get_statusline();
+			@status_message = message;
 
 			return unless @report_status
 
 			runner().update_status(@name, status, message);
-			puts "Task #{@name} assumed a new status: #{status}#{message ? " MSG:#{message}" : ""}"
 		end
 		private :_report_status
 
 		def start()
 			puts "Starting Task: #{@name}"
 
-			return if @targets.empty?
-			sleep 0.01
+			if @targets.empty?
+				_report_status(:success, "No tasks to run!");
+				return
+			end
 
 			@executionThread = Thread.new do
 				_report_status(:pending);
 
+				_rm_logfile();
 				@targets.each do |target|
 					@statuschange_mutex.synchronize {
 						break if @exiting
 						options = {
-							[:in, :out, :err] => "/dev/null"
+							[:out, :err] => "/tmp/TaskLog_#{@name}_#{current_commit()}"
 						}
 						options[:chdir] = @chdir if @chdir
 
@@ -139,11 +205,14 @@ module GitRestart
 
 				if(@lastStatus == 0)
 					_report_status(:success);
+					_rm_logfile();
 				elsif(!@exiting || @expect_clean_exit)
 					_report_status(:failure);
 				end
 			end
 			@executionThread.abort_on_exception = true;
+
+			sleep 0.01
 		end
 
 		def stop()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-restart
 version: !ruby/object:Gem::Version
-  version: 0.0.3.pre.dev
+  version: 0.0.3
 platform: ruby
 authors:
 - Xasin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-05 00:00:00.000000000 Z
+date: 2018-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt-sub_handler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -107,12 +121,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: "(Re)start scripts and monitor them on a GitHub push"