git-maintain 0.7.0 → 0.9.0rc1

data/README.md

@@ -16,9 +16,9 @@ The idea is to script most of the maintenance tasks so the maintainer can focus
 - **list_stable**: List commit present in the stable branch but not in the latest associated relase
 - **merge**: Merge branch with suffix specified in -m <suff> into the main branch
 - **push**: Push branches to github for validation
-- **monitor**: Check the travis state of all branches
+- **monitor**: Check the CI state of all branches
 - **push_stable**: Push to stable repo
-- **monitor_stable**: Check the travis state of all stable branches
+- **monitor_stable**: Check the CI state of all stable branches
 - **release**: Create new release on all concerned branches
 - **reset**: Reset branch against upstream
 - **submit_release**: Push the to stable and create the release packages
@@ -157,7 +157,7 @@ Apply them to the appropriate branches
 
 ```git maintain cp -s deadbeef --version '1[789]'```
 
-And push them to my own github repo so that Travis will check everything out
+And push them to my own github repo so that CI will check everything out
 
 ```git maintain push --version '1[789]'```
 
@@ -179,7 +179,7 @@ Push it to my own github too.
 
 ```git maintain push --version '1[789]' -b pending```
 
-Once this gets accepted (and Travis is OK too), I merge this branch back to my 'master'
+Once this gets accepted (and CI is OK too), I merge this branch back to my 'master'
 
 ```git maintain merge --version '1[789]' -m pending```
 
@@ -239,7 +239,7 @@ The tag will not have been propagated anywhere else and can be deleted manually.
 
 ```git maintain push_stable --version '1[789]'```
 
-You can then monitor the status on Travis
+You can then monitor the status on CI
 
 ```git maintain monitor_stable --version '1[789]'```
 
@@ -258,6 +258,8 @@ Enjoy, and feel free to report bugs, missing features and/or send patches
 
 This is a summary of all the settings that can be set in the git config:
 
+- `maintain.valid-repo`: Remote github repo to test out branches before submitting. Default = `github`
+- `maintain.stable-repo`: Remote stable github repository t submit validated branches and new releases. Default = `stable`
 - `maintain.autofetch`: Enable/Disable auto fetching.  
    Can be overriden by the --[no-]fetch option on the CLI.  
    If unset, autofetch is enabled
@@ -274,3 +276,22 @@ This is a summary of all the settings that can be set in the git config:
  - `maintain.mail-format`: Specify how release annoucement emails are sent. Can be:
    - `imap_send`: Store prepared email in an IMAP folder. See `main git-imap-send` for more infos. This is the default value.
    - `send_email`: Generates a file which is compatible with git send-email
+
+# License
+
+Unless otherwise stated, everything in this repo is covered by the following
+copyright notice:
+
+    Copyright (c) 2022 SUSE
+
+    This program is free software: you can redistribute it and/or modify it
+    under the terms of the GNU General Public License version 3, as
+    published by the Free Software Foundation.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/bin/git-maintain

@@ -11,17 +11,17 @@ $LOAD_PATH.pop()
 
 opts = {
     :br_suff => "master",
-    :no => false,
+    :yn_default => nil,
 }
-
+ACTION_HELPS = GitMaintain::getActionAttr("ACTION_HELP")
 actionParser = OptionParser.new(nil, 60)
 actionParser.banner = "Usage: #{__FILE__} <action> [action options]"
 actionParser.separator ""
 actionParser.separator "Options:"
 actionParser.on("-h", "--help", "Display usage.") { |val| puts actionParser.to_s; exit 0 }
 actionParser.separator "Possible actions:"
-GitMaintain::getActionAttr("ACTION_HELP").sort.each(){|x|
-    actionParser.separator "\t " + x
+ACTION_HELPS.each(){|k, x|
+    actionParser.separator "\t * " + k.to_s() + ": " + x
 }
 rest = actionParser.order!(ARGV);
 if rest.length <= 0 then
@@ -38,13 +38,16 @@ ARGV.shift()
 
 optsParser = OptionParser.new(nil, 60)
 optsParser.banner = "Usage: #{__FILE__} #{action_s} "
+optsParser.separator "# " + ACTION_HELPS[action].to_s()
 optsParser.separator ""
 optsParser.separator "Options:"
 optsParser.on("-h", "--help", "Display usage.") { |val| puts optsParser.to_s; exit 0 }
 optsParser.on("-b", "--branch-suffix [SUFFIX]", "Branch suffix. Default is 'master'.") {
     |val| opts[:br_suff] = val}
 optsParser.on("-n", "--no", "Assume no to all questions.") {
-    |val| opts[:no] = true}
+    |val| opts[:yn_default] = :no}
+optsParser.on("-y", "--yes", "Assume yes to all questions.") {
+    |val| opts[:yn_default] = :yes}
 optsParser.on("--verbose", "Displays more informations.") {
     |val| GitMaintain::setVerbose(true)}
 GitMaintain::setOpts(action, optsParser, opts)

data/lib/addons/RDMACore.rb

@@ -1,6 +1,7 @@
 module GitMaintain
     class RDMACoreBranch < Branch
         REPO_NAME = "rdma-core"
+        AZURE_MIN_VERSION = 18
 
         def self.set_opts(action, optsParser, opts)
             opts[:rel_type] = nil
@@ -15,8 +16,14 @@ module GitMaintain
         end
         def self.check_opts(opts)
             if opts[:action] == :release then
-                if opts[:rel_type] == nil then
+                case opts[:rel_type]
+                when nil
                     raise "No release type specified use --stable or --major"
+                when :major
+                    if opts[:manual_branch] == nil then
+                        GitMaintain::log(:INFO, "Major release selected. Auto-forcing branch to master")
+                        opts[:manual_branch] = "master"
+                    end
                 end
             end
         end
@@ -64,16 +71,19 @@ module GitMaintain
             tag_file.puts `git log HEAD ^#{git_prev_ver} --no-merges --format='   * %s'`
             tag_file.close()
 
+            edit_flag = ""
+            edit_flag = "--edit" if opts[:no_edit] == false
+
             if opts[:rel_type] == :major
                 # For major, tag the current version first
-                @repo.runGitInteractive("tag -a -s v#{rel_ver} --edit -F #{tag_path}")
+                @repo.runGitInteractive("tag -a -s v#{rel_ver} #{edit_flag} -F #{tag_path}")
                 if $? != 0 then
                     raise("Failed to tag branch #{local_branch}")
                 end
             end
 
             # Update version number in relevant files
-            @repo.run("sed -i -e 's/\\(Version:[[:space:]]*\\)[0-9.]\\+/\\1#{new_ver}/g' redhat/rdma-core.spec suse/rdma-core.spec")
+            @repo.run("sed -i -e 's/\\(Version:[[:space:]]*\\)[0-9.]\\+/\\1#{new_ver}/g' */*.spec")
             @repo.run("sed -i -e 's/\\([sS][eE][tT](PACKAGE_VERSION[[:space:]]*\"\\)[0-9.]*\"/\\1#{new_ver}\"/g' CMakeLists.txt")
 
             case opts[:rel_type]
@@ -93,14 +103,14 @@ mv debian/changelog.new debian/changelog")
             end
 
             # Add and commit
-            @repo.runGit("add  redhat/rdma-core.spec suse/rdma-core.spec CMakeLists.txt debian/changelog")
-            @repo.runGitInteractive("commit -m '#{commit_msg} #{new_ver}' --verbose --edit --signoff")
+            @repo.runGit("add  */*.spec CMakeLists.txt debian/changelog")
+            @repo.runGitInteractive("commit -m '#{commit_msg} #{new_ver}' --verbose #{edit_flag} --signoff")
             if $? != 0 then
                 raise("Failed to commit on branch #{local_branch}")
             end
 
             if opts[:rel_type] == :stable
-                @repo.runGitInteractive("tag -a -s v#{rel_ver} --edit -F #{tag_path}")
+                @repo.runGitInteractive("tag -a -s v#{rel_ver} #{edit_flag} -F #{tag_path}")
                 if $? != 0 then
                     raise("Failed to tag branch #{local_branch}")
                 end
@@ -108,7 +118,57 @@ mv debian/changelog.new debian/changelog")
             `rm -f #{tag_path}`
         end
     end
+    class RDMACoreRepo < Repo
+        AZURE_MIN_VERSION = 18
+        def submitReleases(opts, new_tags)
+            new_tags.each(){|tag|
+                next if tag !~ /v([0-9]*)\.[0-9]*/
+                major=$1.to_i
+                # Starting from v27, do not create the github release ourself as this is done by Azure
+                createRelease(opts, tag, major < AZURE_MIN_VERSION)
+            }
+        end
+    end
+
+    class RDMACoreCI < CI
+        AZURE_MIN_VERSION = 18
+        def initialize(repo)
+            super(repo)
+            @travis = GitMaintain::TravisCI.new(repo)
+            @azure = GitMaintain::AzureCI.new(repo, 'ucfconsort', 'ucfconsort')
 
+            # Auto generate all CI required methods
+            # Wicked ruby tricker to find all the public methods of CI but not of inherited classes
+            # to dynamically define these method in the object being created
+            (GitMaintain::CI.new(repo).public_methods() - Object.new.public_methods()).each(){|method|
+                # Skip specific emptyCache method
+                next if method == :emptyCache
+
+                self.define_singleton_method(method) { |br, *args|
+                    if br.version =~ /([0-9]+)/
+                        major=$1.to_i
+                    elsif br.version == "master" 
+                        major=99999
+                    else
+                        raise("Unable to monitor branch #{br} on a CI")
+                    end
+                    if major < AZURE_MIN_VERSION
+                        @travis.send(method, br, *args)
+                    else
+                        @azure.send(method, br, *args)
+                    end
+                }
+            }
+        end
+        def emptyCache()
+            @travis.emptyCache()
+            @azure.emptyCache()
+        end
+    end
     GitMaintain::registerCustom(RDMACoreBranch::REPO_NAME,
-                                { GitMaintain::Branch => RDMACoreBranch })
+                                {
+                                    GitMaintain::Branch => RDMACoreBranch,
+                                    GitMaintain::Repo => RDMACoreRepo,
+                                    GitMaintain::CI => RDMACoreCI,
+                                })
 end

data/lib/addons/git-maintain.rb

@@ -0,0 +1,66 @@
+module GitMaintain
+    class GitMaintainBranch < Branch
+        REPO_NAME = "git-maintain"
+
+        def release(opts)
+            prev_ver=@repo.runGit("show HEAD:CHANGELOG | grep -A 1 -- '---------'  | head -n 2 | tail -n 1 | awk '{ print $1}'").chomp()
+            ver_nums = prev_ver.split(".")
+
+            if opts[:manual_branch] == nil then
+                new_ver =  (ver_nums[0 .. -2] + [ver_nums[-1].to_i() + 1 ]).join(".")
+                git_prev_ver = "v" + (ver_nums[-1] == "0" ? ver_nums[0 .. -2].join(".") : prev_ver)
+            else
+                new_ver =  (ver_nums[0 .. -3] + [ver_nums[-2].to_i() + 1 ] + [ "0" ]).join(".")
+                git_prev_ver = "v" + prev_ver
+            end
+
+            changes=@repo.runGit("show HEAD:CHANGELOG |  awk ' BEGIN {count=0} {if ($1 == \"------------------\") count++; if (count == 0) print $0}'")
+
+            puts "Preparing release #{prev_ver} => #{new_ver}"
+            rep = GitMaintain::checkLog(opts, @local_branch, git_prev_ver, "release")
+            if rep != "y" then
+                puts "Skipping release"
+                return
+            end
+
+            # Prepare tag message
+            tag_path=`mktemp`.chomp()
+            puts tag_path
+            tag_file = File.open(tag_path, "w+")
+            tag_file.puts "git-maintain-#{new_ver}"
+            tag_file.puts ""
+            tag_file.puts changes
+            tag_file.close()
+
+            @repo.run("cat <<EOF > CHANGELOG.new
+------------------
+#{new_ver} #{`date '+ (%Y-%m-%d)'`.chomp()}
+------------------
+
+$(cat CHANGELOG)
+EOF
+mv CHANGELOG.new CHANGELOG")
+
+            # Add and commit
+            @repo.runGit("add  CHANGELOG")
+            @repo.runGitInteractive("commit -F #{tag_path} --verbose --edit --signoff")
+            if $? != 0 then
+                raise("Failed to commit on branch #{local_branch}")
+            end
+            @repo.runGitInteractive("tag -a -s v#{new_ver} --edit -F #{tag_path}")
+            if $? != 0 then
+                raise("Failed to tag branch #{local_branch}")
+            end
+            `rm -f #{tag_path}`
+        end
+    end
+    class GitMaintainRepo < Repo
+        def initialize(path)
+            super(path)
+            @NOTIFY_RELEASE = false
+        end
+    end
+    GitMaintain::registerCustom(GitMaintainBranch::REPO_NAME,
+                                { GitMaintain::Branch => GitMaintainBranch,
+                                  GitMaintain::Repo => GitMaintainRepo})
+end

data/lib/azure.rb

@@ -0,0 +1,98 @@
+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 "running" 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["started_at"]
+        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