yes_ship_it 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0a3bdc9066a3756da3d10312af339a670ebb3b5
-  data.tar.gz: f0c52e701d5bc7ede706a76cdc1550d9d9199cfd
+  metadata.gz: 4392d3f5e95dc46ee07c90f82060e192d450961c
+  data.tar.gz: fca85312702536c2f0a3bdf4e85d87d293be352b
 SHA512:
-  metadata.gz: 881cc76db9867a69368e18a8e0f45ab05c8de8c008160897806d01cf3ed425600bfefe9ad2c388c73e458d859eb5298b396d08e709293148b1fe959b51ce3a10
-  data.tar.gz: 8593fe6bd2e0369073444351c81dfda0ba02c0728ace57d53401b97427c23c8c8a58e8d94ffd4d33d9d9397cea0c6e09f525c3a24a426159c57e16075a25f34b
+  metadata.gz: f40cf52945fc8beeac7f925bf14613a2defb151d4d800b0224da6458a41a5ff36d8cd5e0d1c65f328e4949d7cdcdeaecafeb6f3a6184858a6ec91de3c7622dd4
+  data.tar.gz: 0fcb4cc163dc5e891c95e73bc6cbb61b22d79d0562615ca831de7ceb0f964ef2279c067615ed10aa3a769df564161a63fb4c187a066e59aafb62f778c14333c7

data/.gitignore

@@ -1 +1,3 @@
 Gemfile.lock
+*.gem
+tmp

data/.rspec

@@ -1 +1,2 @@
 --color
+-fd

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change log of yes_ship_it
 
+## Version 0.0.3
+
+* Implement minimal version of `yes_ship_it init`. The init command is supposed
+  to analyze an existing directory with code and create a suitable initial
+  configuration for yes_ship_it. The current implementation simply assumes that
+  it is a Ruby gem we are going to ship.
+* Add assertion for submitting RPMs to the Open Build Service
+* Add assertion for creating a release archive as tarball
+* Support parsing version from a Go project
+* Add assertion for clean working directory, which checks unstaged commits and
+  untracked files
+* Add assertion which checks that the local checkout is on the release branch.
+  The default release branch is master.
+
 ## Version 0.0.2
 
 * Don't run assertions when dependent assertions have failed

data/README.md

@@ -96,7 +96,15 @@ You get basic documentation from the tool itself by executing
 `yes_ship_it help`. There also is a simple man page with some pointers.
 
 The main documentation with details about different scenarios how `yes_ship_it`
-can be used is maintained in the Wiki. You are welcome to contribute there.
+can be used is maintained in the
+[Wiki](https://github.com/cornelius/yes_ship_it/wiki). You are welcome to
+contribute there.
+
+## Users
+
+There is a list of [users of yes_ship_it](https://github.com/cornelius/yes_ship_it/blob/master/USERS.md).
+I'm happy to add you there. Just send me a pull requests for the `USERS.md`
+file.
 
 ## License
 

data/USERS.md

@@ -0,0 +1,13 @@
+# Users of yes_ship_it
+
+This is a list of projects using yes_ship_it to do releases. If you want to get
+your project added please send a pull request. If you include a contact email,
+you will get notified when changes happen in yes_ship_it which are likely to
+affect you.
+
+* [yes_ship_it](https://github.com/cornelius/yes_ship_it)
+* [Trollolo](https://github.com/openSUSE/trollolo)
+* [Inqlude](https://github.com/cornelius/inqlude) ([Contact](mailto:schumacher@kde.org))
+* [cli_tester](https://github.com/cornelius/cli_tester)
+* [Mycroft](https://github.com/cornelius/mycroft)
+* [Httpotemkin](https://github.com/cornelius/httpotemkin)

data/assertions/built_gem.rb

@@ -1,11 +1,5 @@
 module YSI
   class BuiltGem < Assertion
-    attr_accessor :error
-
-    def initialize(engine)
-      @engine = engine
-    end
-
     def display_name
       "built gem"
     end

data/assertions/change_log.rb

@@ -2,12 +2,6 @@ module YSI
   class ChangeLog < Assertion
     needs "version"
 
-    attr_reader :error
-
-    def initialize(engine)
-      @engine = engine
-    end
-
     def display_name
       "change log"
     end

data/assertions/published_gem.rb

@@ -2,12 +2,6 @@ module YSI
   class PublishedGem < Assertion
     needs "built_gem"
 
-    attr_accessor :error
-
-    def initialize(engine)
-      @engine = engine
-    end
-
     def display_name
       "published gem"
     end
@@ -18,7 +12,7 @@ module YSI
 
     def check
       begin
-        json = RestClient.get("http://rubygems.org/api/v1/versions/#{engine.project_name}.json")
+        json = RestClient.get("https://rubygems.org/api/v1/versions/#{engine.project_name}.json")
       rescue RestClient::ResourceNotFound
         return nil
       end

data/assertions/release_archive.rb

@@ -0,0 +1,43 @@
+module YSI
+  class ReleaseArchive < Assertion
+    def display_name
+      "release archive"
+    end
+
+    def git_revision
+      `git rev-parse HEAD`.chomp
+    end
+
+    def filename
+      "#{engine.project_name}-#{engine.version}.tar.gz"
+    end
+
+    def release_archive
+      File.join(engine.data_dir, "release_archives", engine.project_name,
+        git_revision, filename)
+    end
+
+    def check
+      engine.release_archive = release_archive
+      if File.exist?(release_archive)
+        return filename
+      end
+      nil
+    end
+
+    def assert(dry_run: false)
+      if !dry_run
+        Dir.mktmpdir do |tmp_dir|
+          archive_dir = "#{engine.project_name}-#{engine.version}"
+          cmd = "git clone #{Dir.pwd} #{File.join(tmp_dir, archive_dir)} 2>/dev/null"
+          system(cmd)
+          FileUtils.mkdir_p(File.dirname(release_archive))
+          excludes = [".git", ".gitignore", "yes_ship_it.conf"]
+          exclude_options = excludes.map { |e| "--exclude '#{e}'" }.join(" ")
+          system("cd #{tmp_dir}; tar czf #{release_archive} #{exclude_options} #{archive_dir}")
+        end
+      end
+      filename
+    end
+  end
+end

data/assertions/release_branch.rb

@@ -0,0 +1,37 @@
+module YSI
+  class ReleaseBranch < Assertion
+    def display_name
+      "release branch"
+    end
+
+    def branch
+      "master"
+    end
+
+    def current_branch
+      git_branch.each_line do |line|
+        if line =~ /\* (.*)/
+          return $1
+        end
+      end
+      nil
+    end
+
+    def git_branch
+      `git branch`
+    end
+
+    def check
+      if current_branch != branch
+        @error = "Not on release branch '#{branch}'"
+        return nil
+      else
+        return branch
+      end
+    end
+
+    def assert(dry_run: false)
+      branch
+    end
+  end
+end

data/assertions/submitted_rpm.rb

@@ -0,0 +1,134 @@
+module YSI
+  class SubmittedRpm < Assertion
+    parameter :obs_project
+
+    attr_reader :obs_user, :obs_password
+    attr_reader :obs_package_files
+
+    def display_name
+      "submitted RPM"
+    end
+
+    def read_obs_credentials(file_name)
+      oscrc = IniFile.load(file_name)
+      @obs_user = oscrc["https://api.opensuse.org"]["user"]
+      @obs_password = oscrc["https://api.opensuse.org"]["pass"]
+    end
+
+    def archive_file_name
+      engine.release_archive_file_name
+    end
+
+    class RpmSpecHelpers
+      def initialize(engine)
+        @engine = engine
+      end
+
+      def get_binding
+        binding
+      end
+
+      def version
+        @engine.version
+      end
+
+      def release_archive
+        @engine.release_archive_file_name
+      end
+
+      def release_directory
+        "#{@engine.project_name}-#{@engine.version}"
+      end
+    end
+
+    def create_spec_file(template)
+      erb = ERB.new(File.read(template))
+      erb.result(RpmSpecHelpers.new(engine).get_binding)
+    end
+
+    def check
+      if !obs_project
+        @error = "OBS project is not set"
+        return nil
+      end
+      if !engine.release_archive
+        @error = "Release archive is not set. Assert release_archive before submitted_rpm"
+        return nil
+      end
+
+      read_obs_credentials(File.expand_path("~/.oscrc"))
+
+      begin
+        url = "https://#{obs_user}:#{obs_password}@api.opensuse.org/source/home:cschum:go/#{engine.project_name}"
+        xml = RestClient.get(url)
+      rescue RestClient::Exception => e
+        if e.is_a?(RestClient::ResourceNotFound)
+          return nil
+        elsif e.is_a?(RestClient::Unauthorized)
+          @error = "No credentials set for OBS. Use osc to do this."
+          return nil
+        else
+          @error = e.to_s
+          return nil
+        end
+      end
+
+      @obs_package_files = []
+      doc = REXML::Document.new(xml)
+      doc.elements.each("directory/entry") do |element|
+        file_name = element.attributes["name"]
+        @obs_package_files.push(file_name)
+      end
+      if @obs_package_files.include?(archive_file_name)
+        return archive_file_name
+      end
+      nil
+    end
+
+    def assert(dry_run: false)
+      engine.out.puts "..."
+
+      old_files = []
+      @obs_package_files.each do |file|
+        next if file == "#{engine.project_name}.spec"
+        next if file == archive_file_name
+        old_files.push(file)
+      end
+
+      engine.out.puts "  Uploading release archive '#{archive_file_name}'"
+      if !dry_run
+        url = "https://#{obs_user}:#{obs_password}@api.opensuse.org/source/home:cschum:go/#{engine.project_name}/#{archive_file_name}"
+        file = File.new(engine.release_archive, "rb")
+        begin
+          RestClient.put(url, file, content_type: "application/x-gzip")
+        rescue RestClient::Exception => e
+          STDERR.puts e.inspect
+        end
+      end
+
+      spec_file = engine.project_name + ".spec"
+      engine.out.puts "  Uploading spec file '#{spec_file}'"
+      if !dry_run
+        url = "https://#{obs_user}:#{obs_password}@api.opensuse.org/source/home:cschum:go/#{engine.project_name}/#{spec_file}"
+        content = create_spec_file("rpm/#{spec_file}.erb")
+        begin
+          RestClient.put(url, content, content_type: "text/plain")
+        rescue RestClient::Exception => e
+          STDERR.puts e.inspect
+        end
+      end
+
+      old_files.each do |file|
+        engine.out.puts "  Removing '#{file}'"
+        if !dry_run
+          url = "https://#{obs_user}:#{obs_password}@api.opensuse.org/source/home:cschum:go/#{engine.project_name}/#{file}"
+          RestClient.delete(url)
+        end
+      end
+
+      engine.out.print "... "
+
+      "#{obs_project}/#{engine.project_name}"
+    end
+  end
+end

data/assertions/version.rb

@@ -1,27 +1,21 @@
 module YSI
   class Version < Assertion
-    attr_accessor :error
-
-    def initialize(engine)
-      @engine = engine
-    end
+    parameter :version_file, "lib/version.rb"
 
     def display_name
       "version number"
     end
 
     def check
-      version_file = "lib/version.rb"
       if !File.exist?(version_file)
         @error = "Expected version in #{version_file}"
         return nil
       end
 
-      File.read(version_file).each_line do |line|
-        if line =~ /VERSION = "(.*)"/
-          @engine.version = $1
-          return @engine.version
-        end
+      version = parse_version(version_file)
+      if version
+        @engine.version = version
+        return @engine.version
       end
       @error = "Couldn't find version in #{version_file}"
       nil
@@ -29,5 +23,22 @@ module YSI
 
     def assert(dry_run: false)
     end
+
+    def parse_version(file_name)
+      if file_name =~ /\.rb$/
+        File.read(file_name).each_line do |line|
+          if line =~ /VERSION = "(.*)"/
+            return $1
+          end
+        end
+      elsif file_name =~ /\.go$/
+        File.read(file_name).each_line do |line|
+          if line =~ /Version = "(.*)"/
+            return $1
+          end
+        end
+      end
+      nil
+    end
   end
 end

data/assertions/working_directory.rb

@@ -0,0 +1,42 @@
+module YSI
+  class WorkingDirectory < Assertion
+    def display_name
+      "working directory"
+    end
+
+    def git_status
+      `git status`
+    end
+
+    def status
+      if !@status
+        g = git_status
+        if g =~ /working directory clean/
+          @status = "clean"
+        elsif g =~ /Changes to be committed/
+          @status = "uncommitted changes"
+        elsif g =~ /Untracked files/
+          @status = "untracked files"
+        elsif g =~ /Changes not staged/
+          @status = "unstaged changes"
+        else
+          @status = nil
+        end
+      end
+      @status
+    end
+
+    def check
+      if status == "clean"
+        return status
+      else
+        @error = status
+        return nil
+      end
+    end
+
+    def assert(dry_run: false)
+      "clean"
+    end
+  end
+end

data/bin/yes_ship_it

@@ -9,6 +9,7 @@ option_parser = OptionParser.new do |opts|
   opts.separator ""
   opts.separator "Commands:"
   opts.separator "  changelog - show change log since last release"
+  opts.separator "  init      - initialize directory for shipping with yes_ship_it"
   opts.separator ""
   opts.separator "Specific options:"
 
@@ -16,6 +17,10 @@ option_parser = OptionParser.new do |opts|
     options[:dry_run] = v
   end
 
+  opts.on("--data-dir=DIR", "Set directory for storing internal data") do |v|
+    options[:data_dir] = v
+  end
+
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
@@ -25,23 +30,35 @@ option_parser.parse!
 
 config_file = "yes_ship_it.conf"
 
-if !File.exist?(config_file)
-  STDERR.puts("Unable to find file `yes_ship_it.conf`. I need it.")
-  exit 1
-end
-
 if ARGV == ["changelog"]
   engine = YSI::Engine.new
   engine.check_assertion(YSI::Version)
   tag = `git tag`.split("\n").last
   system("git log #{tag}..HEAD")
   exit 0
+elsif ARGV == ["init"]
+  File.open("yes_ship_it.conf", "w") do |file|
+    file.puts "# Experimental release automation. See https://github.com/cornelius/yes_ship_it."
+    file.puts "include:"
+    file.puts "  ruby_gem"
+  end
+  puts "Initialized directory for shipping."
+  puts
+  puts "Check the file `yes_ship_it.conf` and adapt it to your needs."
+  puts
+  puts "Happy shipping!"
 elsif ARGV.empty?
+  if !File.exist?(config_file)
+    STDERR.puts("Unable to find file `yes_ship_it.conf`. I need it.")
+    exit 1
+  end
+
   puts "Shipping..."
   puts
 
   engine = YSI::Engine.new
   engine.dry_run = options[:dry_run]
+  engine.data_dir = options[:data_dir] if options[:data_dir]
 
   begin
     engine.read(config_file)