git-maintain 0.12.0 → 0.14.2

data/lib/git-maintain/travis.rb

@@ -0,0 +1,179 @@
+# Main module for git-maintain repository maintenance tool.
+module GitMaintain
+    # CI adapter class for Travis CI integration.
+    class TravisCI < CI
+        # Base URL for Travis CI API.
+        TRAVIS_URL='https://api.travis-ci.com/'
+
+        # Initialize TravisCI adapter.
+        #
+        # @param repo [Repo] The Repo instance
+        def initialize(repo)
+            super(repo)
+            @url = TRAVIS_URL
+        end
+
+        private
+        # Get the Travis build status string for a specific commit SHA.
+        #
+        # @param sha1 [String] Commit SHA
+        # @param resp [Hash] API response payload containing branch builds
+        # @return [String] Build status string (e.g. 'passed', 'failed')
+        def getState(sha1, resp)
+            br = findBranch(sha1, resp)
+            return "not found" if br == nil
+
+            return br["state"]
+        end
+
+        # Fetch the build logs from Travis CI for a specific commit SHA.
+        #
+        # @param sha1 [String] Commit SHA
+        # @param resp [Hash] API response payload
+        # @return [String] Build log output text
+        # @raise [GitMaintainError] If no build is found for the commit
+        def getLog(sha1, resp)
+            br = findBranch(sha1, resp)
+            raise GitMaintainError.new("Travis build not found") if br == nil
+            job_id = br["job_ids"].last().to_s()
+            return getJson(@url, "travis_log_" + job_id, 'jobs/' + job_id + '/log', false)
+        end
+
+        # Get the Travis build timestamp for a specific commit SHA.
+        #
+        # @param sha1 [String] Commit SHA
+        # @param resp [Hash] API response payload
+        # @return [String] Build started-at timestamp string
+        # @raise [GitMaintainError] If no build is found for the commit
+        def getTS(sha1, resp)
+            br = findBranch(sha1, resp)
+            raise GitMaintainError.new("Travis build not found") if br == nil
+            return br["started_at"]
+        end
+
+        # Check if the build status string represents success.
+        #
+        # @param sha1 [String] Commit SHA
+        # @param resp [Hash] API response payload
+        # @return [Boolean] True if build passed
+        def checkState(sha1, resp)
+            return getState(sha1, resp) == "passed"
+        end
+
+        # Fetch validation branch builds JSON payload from Travis CI API.
+        #
+        # @return [Hash] JSON API response
+        # @raise [GitMaintainError] If API request fails
+        def getBrValidJson()
+            return getJson(@url, :travis_br_valid, 'repos/' + @repo.remote_valid + '/branches')
+        end
+
+        # Fetch stable branch builds JSON payload from Travis CI API.
+        #
+        # @return [Hash] JSON API response
+        # @raise [GitMaintainError] If API request fails
+        def getBrStableJson()
+            return getJson(@url, :travis_br_stable, 'repos/' + @repo.remote_stable + '/branches')
+        end
+
+        # Find the specific branch build matching the given commit SHA.
+        #
+        # @param sha1 [String] Commit SHA
+        # @param resp [Hash] API response branches payload
+        # @return [Hash, nil] Branch build dictionary, or nil if not found
+        # @raise [GitMaintainError] If API response is missing expected commit keys
+        def findBranch(sha1, resp)
+            log(:DEBUG_CI, "Looking for build for #{sha1}")
+            resp["branches"].each(){|br|
+                commit=resp["commits"].select(){|e| e["id"] == br["commit_id"]}.first()
+                raise GitMaintainError.new("Incomplete JSON received from Travis") if commit == nil
+                log(:DEBUG_CI, "Found entry for sha #{commit["sha"]}")
+                next if commit["sha"] != sha1
+                return br
+            }
+            return nil
+        end
+
+        public
+        # Retrieve the validation build state for a specific branch and commit.
+        #
+        # @param br [Branch] The Branch instance
+        # @param sha1 [String] Commit SHA
+        # @return [String] Build status string (e.g. 'passed')
+        def getValidState(br, sha1)
+            return getState(sha1, getBrValidJson())
+        end
+
+        # Check if the validation build is successful.
+        #
+        # @param br [Branch] The Branch instance
+        # @param sha1 [String] Commit SHA
+        # @return [Boolean] True if build passed
+        def checkValidState(br, sha1)
+            return checkState(sha1, getBrValidJson())
+        end
+
+        # Retrieve the validation build log.
+        #
+        # @param br [Branch] The Branch instance
+        # @param sha1 [String] Commit SHA
+        # @return [String] Build log output text
+        def getValidLog(br, sha1)
+            return getLog(sha1, getBrValidJson())
+        end
+
+        # Retrieve the validation build timestamp.
+        #
+        # @param br [Branch] The Branch instance
+        # @param sha1 [String] Commit SHA
+        # @return [String] Build timestamp
+        def getValidTS(br, sha1)
+            return getTS(sha1, getBrValidJson())
+        end
+
+        # Retrieve the stable build state for a specific branch and commit.
+        #
+        # @param br [Branch] The Branch instance
+        # @param sha1 [String] Commit SHA
+        # @return [String] Build status string (e.g. 'passed')
+        def getStableState(br, sha1)
+            return getState(sha1, getBrStableJson())
+        end
+
+        # Check if the stable build is successful.
+        #
+        # @param br [Branch] The Branch instance
+        # @param sha1 [String] Commit SHA
+        # @return [Boolean] True if build passed
+        def checkStableState(br, sha1)
+            return checkState(sha1, getBrStableJson())
+        end
+
+        # Retrieve the stable build log.
+        #
+        # @param br [Branch] The Branch instance
+        # @param sha1 [String] Commit SHA
+        # @return [String] Build log output text
+        def getStableLog(br, sha1)
+            return getLog(sha1, getBrStableJson())
+        end
+
+        # Retrieve the stable build timestamp.
+        #
+        # @param br [Branch] The Branch instance
+        # @param sha1 [String] Commit SHA
+        # @return [String] Build timestamp
+        def getStableTS(br, sha1)
+            return getTS(sha1, getBrStableJson())
+        end
+
+        # Check if the CI build status represents an error/failure.
+        #
+        # @param br [Branch] The Branch instance
+        # @param status [String] CI status string
+        # @return [Boolean] True if build errored or failed
+        def isErrored(br, status)
+            return status == "failed" || status == "errored"
+        end
+    end
+end

data/lib/git-maintain.rb

@@ -0,0 +1,2 @@
+require_relative 'git-maintain/error'
+require_relative 'git-maintain/common'

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: git-maintain
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.2
 platform: ruby
 authors:
 - Nicolas Morey-Chaisemartin
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-09-11 00:00:00.000000000 Z
+date: 2026-09-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cli_class_tool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -38,19 +51,23 @@ files:
 - README.md
 - bin/git-maintain
 - git-maintain-completion.sh
-- lib/addons/RDMACore.rb
-- lib/addons/git-maintain.rb
-- lib/azure.rb
-- lib/branch.rb
-- lib/ci.rb
-- lib/common.rb
-- lib/repo.rb
-- lib/travis.rb
+- lib/git-maintain.rb
+- lib/git-maintain/addons/RDMACore.rb
+- lib/git-maintain/addons/git-maintain.rb
+- lib/git-maintain/addons/healthd.rb
+- lib/git-maintain/addons/hpc-testing.rb
+- lib/git-maintain/azure.rb
+- lib/git-maintain/branch.rb
+- lib/git-maintain/branch_iterator.rb
+- lib/git-maintain/ci.rb
+- lib/git-maintain/common.rb
+- lib/git-maintain/error.rb
+- lib/git-maintain/repo.rb
+- lib/git-maintain/travis.rb
 homepage: https://github.com/nmorey/git-maintain
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Your ultimate script for maintaining stable branches and releasing your project.
 test_files: []

data/lib/azure.rb

@@ -1,98 +0,0 @@
-module GitMaintain
-    class AzureCI < CI
-        AZURE_URL='https://dev.azure.com/'
-
-        def initialize(repo, stable='', valid='')
-            super(repo)
-            @url = AZURE_URL
-            @stable_org=stable
-            @valid_org=valid
-        end
-
-        private
-        def getState(sha1, resp)
-            br = findBranch(sha1, resp)
-            return "not found" if br == nil
-            return "started" if br["result"] == nil
-            return br["result"].to_s()
-        end
-        def getLog(sha1, resp)
-            str=""
-            # br = findBranch(sha1, resp)
-            # raise("Travis build not found") if br == nil
-            # job_id = br["id"].to_s()
-            # logs= getJson(@url, "azure_log_list" + job_id,
-            #               @repo.name + "/_apis/build/builds/#{job_id}/logs?api-version=5.1")
-            # 1.upto(logs["count"]) { |x|
-            #     log(:DEBUG_CI, "Downloading log file #{x}/#{logs["count"]}")
-            #      nzstr = getJson(@url, "azure_log_" + job_id + '_' + x.to_s(),
-            #               @repo.name + "/_apis/build/builds/#{job_id}/logs/#{x}?api-version=5.1", false)
-            # # This is zipped. We need to extract it
-            # }
-            return str
-        end
-        def getTS(sha1, resp)
-            br = findBranch(sha1, resp)
-            raise("Travis build not found") if br == nil
-            return br["startTime"]
-        end
-        def checkState(sha1, resp)
-            st = getState(sha1, resp)
-            return  st == "passed"  || st == "succeeded"
-        end
-
-        def getBrValidJson()
-            raise("Validation organisation not provided") if @valid_org == ''
-            return getJson(@url + @valid_org + '/',
-                           :azure_br_valid, @repo.name + '/_apis/build/builds?api-version=5.1')
-        end
-        def getBrStableJson()
-            raise("Stable organisation not provided") if @stable_org == ''
-            return getJson(@url + @stable_org + '/',
-             :azure_br_stable, @repo.name + '/_apis/build/builds?api-version=5.1')
-        end
-        def findBranch(sha1, resp)
-            log(:DEBUG_CI, "Looking for build for #{sha1}")
-            resp["value"].each(){|br|
-                commit= br["sourceVersion"]
-                raise("Incomplete JSON received from Travis") if commit == nil
-                log(:DEBUG_CI, "Found entry for sha #{commit}")
-                next if commit != sha1
-                return br
-            }
-            return nil
-        end
-
-        public
-        def getValidState(br, sha1)
-            return getState(sha1, getBrValidJson())
-        end
-        def checkValidState(br, sha1)
-            return checkState(sha1, getBrValidJson())
-        end
-        def getValidLog(br, sha1)
-            return getLog(sha1, getBrValidJson())
-        end
-        def getValidTS(br, sha1)
-            return getTS(sha1, getBrValidJson())
-        end
-
-        def getStableState(br, sha1)
-            return getState(sha1, getBrStableJson())
-        end
-        def checkStableState(br, sha1)
-            return checkState(sha1, getBrStableJson())
-        end
-        def getStableLog(br, sha1)
-            return getLog(sha1, getBrStableJson())
-        end
-        def getStableTS(br, sha1)
-            return getTS(sha1, getBrStableJson())
-        end
-        def isErrored(br, status)
-            # https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/list?
-            # view=azure-devops-rest-5.1#buildresult
-            return status == "failed"
-        end
-    end
-end

data/lib/ci.rb

@@ -1,88 +0,0 @@
-module GitMaintain
-    class CI
-
-        def self.load(repo)
-            repo_name = File.basename(repo.path)
-            return GitMaintain::loadClass(CI, repo_name, repo)
-        end
-
-        def initialize(repo)
-            GitMaintain::checkDirectConstructor(self.class)
-
-            @repo = repo
-            @cachedJson={}
-        end
-
-        private
-        def log(lvl, str)
-            GitMaintain::log(lvl, str)
-        end
-
-        def fetch(uri_str, limit = 10)
-            # You should choose a better exception.
-            raise ArgumentError, 'too many HTTP redirects' if limit == 0
-
-            response = Net::HTTP.get_response(URI(uri_str))
-
-            case response
-            when Net::HTTPSuccess then
-                response
-            when Net::HTTPRedirection then
-                location = response['location']
-                fetch(location, limit - 1)
-            else
-                response.value
-            end
-        end
-        def getJson(base_url, query_label, query, json=true)
-            return @cachedJson[query_label] if @cachedJson[query_label] != nil
-            url = base_url + query
-            uri = URI(url)
-            log(:INFO, "Querying CI...")
-            log(:DEBUG_CI, url)
-            response = fetch(uri)
-            raise("CI request failed '#{url}'") if response.code.to_s() != '200'
-
-            if json == true
-                @cachedJson[query_label] = JSON.parse(response.body)
-            else
-                @cachedJson[query_label] = response.body
-            end
-            return @cachedJson[query_label]
-        end
-
-        public
-        def getValidState(br, sha1)
-            raise("Unimplemented")
-        end
-        def checkValidState(br, sha1)
-            raise("Unimplemented")
-        end
-        def getValidLog(br, sha1)
-            raise("Unimplemented")
-        end
-        def getValidTS(br, sha1)
-            raise("Unimplemented")
-        end
-
-        def getStableState(br, sha1)
-            raise("Unimplemented")
-        end
-        def checkStableState(br, sha1)
-            raise("Unimplemented")
-        end
-        def getStableLog(br, sha1)
-            raise("Unimplemented")
-        end
-        def getStableTS(br, sha1)
-            raise("Unimplemented")
-        end
-        def emptyCache()
-            @cachedJson={}
-        end
-
-        def isErrored(br, status)
-            raise("Unimplemented")
-        end
-    end
-end

data/lib/common.rb

@@ -1,259 +0,0 @@
-$LOAD_PATH.push(BACKPORT_LIB_DIR)
-
-require 'ci'
-require 'travis'
-require 'azure'
-require 'repo'
-require 'branch'
-
-$LOAD_PATH.pop()
-
-class String
-    # colorization
-    @@is_a_tty = nil
-    def colorize(color_code)
-        @@is_a_tty = STDOUT.isatty() if @@is_a_tty == nil
-        if @@is_a_tty then
-            return "\e[#{color_code}m#{self}\e[0m"
-        else
-            return self
-        end
-    end
-
-    def red
-        colorize(31)
-    end
-
-    def green
-        colorize(32)
-    end
-
-    def brown
-        colorize(33)
-    end
-
-    def blue
-        colorize(34)
-    end
-
-    def magenta
-        colorize(35)
-    end
-end
-
-module GitMaintain
-    class Common
-        ACTION_LIST = [ :list_actions ]
-        ACTION_HELP = {}
-        def self.execAction(opts, action)
-            puts GitMaintain::getActionAttr("ACTION_LIST").join("\n")
-        end
-    end
-
-    ACTION_CLASS = [ Common, Branch, Repo ]
-    @@custom_classes = {}
-    @@load_class = []
-    @@verbose_log = false
-
-    def registerCustom(repo_name, classes)
-        raise("Multiple class for repo #{repo_name}") if @@custom_classes[repo_name] != nil
-        classes[:name] = repo_name if classes[:name] == nil
-        @@custom_classes[repo_name] = classes
-    end
-    module_function :registerCustom
-
-    def getClass(default_class, repo_name = File.basename(Dir.pwd()))
-        custom = @@custom_classes[repo_name]
-        if custom != nil && custom[default_class] != nil then
-            log(:DEBUG,"Detected custom #{default_class} class for repo '#{repo_name}'")
-            return custom[default_class]
-        else
-            log(:DEBUG,"Detected NO custom #{default_class} classes for repo '#{repo_name}'")
-            return default_class
-        end
-    end
-    module_function :getClass
-
-    def getCustomClasses()
-        return @@custom_classes
-    end
-    module_function :getCustomClasses
-
-    def loadClass(default_class, repo_name, *more)
-        @@load_class.push(default_class)
-        obj = GitMaintain::getClass(default_class, repo_name).new(*more)
-        @@load_class.pop()
-        return obj
-    end
-    module_function :loadClass
-
-    # Check that the constructor was called through loadClass
-    def checkDirectConstructor(theClass)
-        curLoad= @@load_class.last()
-        cl = theClass
-        while cl != Object
-            return if cl == curLoad
-            cl = cl.superclass
-        end
-        raise("Use GitMaintain::loadClass to construct a #{theClass} class")
-    end
-    module_function :checkDirectConstructor
-
-    def getActionAttr(attr)
-        if Common.const_get(attr).class == Hash
-            return ACTION_CLASS.inject({}){|h, x| h.merge(getClass(x).const_get(attr))}
-        else
-            return ACTION_CLASS.map(){|x| getClass(x).const_get(attr)}.flatten()
-        end
-    end
-    module_function :getActionAttr
-
-    def setOpts(action, optsParser, opts)
-         ACTION_CLASS.each(){|x|
-            if x::ACTION_LIST.index(action) != nil &&
-               x.singleton_methods().index(:set_opts) != nil then
-                matched=true
-                x.set_opts(action, optsParser, opts)
-            end
-            # Try to add repo specific opts
-            y = getClass(x)
-            if x != y && y::ACTION_LIST.index(action) != nil &&
-               y.singleton_methods().index(:set_opts) != nil then
-                matched=true
-                x.set_opts(action, optsParser, opts) if x.singleton_methods().index(:set_opts) != nil
-                y.set_opts(action, optsParser, opts)
-            end
-            break if matched == true
-        }
-    end
-    module_function :setOpts
-
-    def checkOpts(opts)
-        ACTION_CLASS.each(){|x|
-            if x::ACTION_LIST.index(opts[:action]) != nil &&
-               x.singleton_methods().index(:check_opts) != nil then
-                matched=true
-                x.check_opts(opts)
-            end
-
-            # Try to add repo specific opts
-            y = getClass(x)
-            if x != y && y::ACTION_LIST.index(opts[:action]) != nil &&
-               y.singleton_methods().index(:check_opts) != nil then
-                matched=true
-                x.check_opts(opts) if x.singleton_methods().index(:check_opts) != nil
-                y.check_opts(opts)
-            end
-            break if matched == true
-       }
-    end
-    module_function :checkOpts
-
-    def execAction(opts, action)
-        ACTION_CLASS.each(){|x|
-            if x::ACTION_LIST.index(action) != nil
-                return x.execAction(opts, action)
-            end
-           # Try to add repo specific opts
-            y = getClass(x)
-            if x != y && y::ACTION_LIST.index(opts[:action]) != nil then
-                return y.execAction(opts, action)
-            end
-        }
-    end
-    module_function :execAction
-
-    def confirm(opts, msg, ignore_default=false)
-        rep = 't'
-        while rep != "y" && rep != "n" && rep != '' do
-            puts "Do you wish to #{msg} ? (y/N): "
-            case (ignore_default == true ? nil : opts[:yn_default])
-            when :no
-                puts "Auto-replying no due to --no option"
-                rep = 'n'
-            when :yes
-                puts "Auto-replying yes due to --yes option"
-                rep = 'y'
-            else
-                rep = STDIN.gets.chomp()
-            end
-        end
-        return rep
-    end
-    module_function :confirm
-
-    def checkLog(opts, br1, br2, action_msg)
-        puts "Diff between #{br1} and #{br2}"
-        puts `git log --format=oneline #{br1} ^#{br2}`
-        return "n" if action_msg.to_s() == ""
-        rep = confirm(opts, "#{action_msg} this branch")
-        return rep
-    end
-    module_function :checkLog
-
-    def showLog(opts, br1, br2)
-        log(:INFO, "Diff between #{br1} and #{br2}")
-        puts `git log --format=oneline #{br1} ^#{br2}`
-        return "n"
-    end
-    module_function :showLog
-
-    def _log(lvl, str, out=STDOUT)
-        puts("# " + lvl.to_s() + ": " + str)
-    end
-    module_function :_log
-
-    def log(lvl, str)
-        case lvl
-        when :DEBUG
-            _log("DEBUG".magenta(), str) if ENV["DEBUG"].to_s() != ""
-        when :DEBUG_CI
-            _log("DEBUG_CI".magenta(), str) if ENV["DEBUG_CI"].to_s() != ""
-        when :VERBOSE
-            _log("INFO".blue(), str) if @@verbose_log == true
-        when :INFO
-            _log("INFO".green(), str)
-        when :WARNING
-            _log("WARNING".brown(), str)
-        when :ERROR
-            _log("ERROR".red(), str, STDERR)
-        else
-            _log(lvl, str)
-        end
-    end
-    module_function :log
-
-    def crit(msg)
-        log(:ERROR, msg)
-        raise msg
-    end
-    module_function :crit
-
-    def setVerbose(val)
-        @@verbose_log = val
-    end
-    module_function :setVerbose
-end
-$LOAD_PATH.pop()
-
-
-# Load all custom classes
-$LOAD_PATH.push(BACKPORT_LIB_DIR + "/addons/")
-Dir.entries(BACKPORT_LIB_DIR + "/addons/").each(){|entry|
-    next if (!File.file?(BACKPORT_LIB_DIR + "/addons/" + entry) || entry !~ /\.rb$/ );
-    require entry.sub(/.rb$/, "")
-}
-$LOAD_PATH.pop()
-
-if ENV["GIT_MAINTAIN_ADDON_DIR"].to_s() != "" then
-    ADDON_DIR=ENV["GIT_MAINTAIN_ADDON_DIR"].to_s()
-    if Dir.exist?(ADDON_DIR) then
-        $LOAD_PATH.push(ADDON_DIR)
-        Dir.entries(ADDON_DIR).each(){|entry|
-            next if (!File.file?(ADDON_DIR + "/" + entry) || entry !~ /\.rb$/ );
-            require entry.sub(/.rb$/, "")
-        }
-        $LOAD_PATH.pop()
-    end
-end
-