releasinator 0.1.0

data/lib/validator.rb

@@ -0,0 +1,312 @@
+require 'colorize'    
+require 'fileutils'
+require_relative 'command_processor'
+require_relative 'downstream_repo'
+require_relative 'github_repo'
+require_relative 'printer'
+require_relative 'validator_changelog'
+
+module Releasinator
+  class Validator
+
+    def initialize(releasinator_config)
+      @releasinator_config = releasinator_config
+    end
+
+    def get_changelog_contents(base_dir)
+      Dir.chdir(base_dir) do
+        open('CHANGELOG.md').read
+      end
+    end
+
+    def validate_git_version
+      version_output = CommandProcessor.command("git version")
+      # version where the parallel git fetch features were added
+      expected_git_version = "2.8.0"
+      actual_git_version = version_output.split[2]
+
+      if Gem::Version.new(expected_git_version) > Gem::Version.new(actual_git_version)
+        Printer.fail("Actual git version " + actual_git_version.bold + " is smaller than expected git version " + expected_git_version.bold)
+        abort()
+      else
+        Printer.success("Git version " + actual_git_version.bold + " found, and is higher than or equal to expected git version " + expected_git_version.bold)
+      end
+    end
+
+    def validate_changelog(base_dir, downstream_dir)
+      validate_exist(base_dir, "CHANGELOG.md", downstream_dir, ["release_notes.md"])
+
+      changelog_contents = get_changelog_contents(base_dir)
+      ValidatorChangelog.new.validate_changelog_contents(changelog_contents)
+    end
+
+    def validate_is_type(obj, type)
+      if !obj.is_a? type
+        Printer.fail("#{obj} is not a #{type}.")
+        abort()
+      end 
+    end
+
+    def validate_method_convention(hash)
+      hash.each do |key, value|
+        if key.to_s.end_with? "_methods" 
+          # validate that anything ending in _methods is a list of methods
+          if !value.respond_to? :each
+            Printer.fail("#{key} is not a list.")
+            abort()
+          end
+          value.each do |list_item|
+            validate_is_type list_item, Method
+          end
+        elsif key.to_s.end_with? "_method"
+          # anything ending in _method is a method
+          validate_is_type value, Method
+        else
+          # ignore everything else
+        end
+      end
+    end
+
+    def validate_required_configatron_key(key)
+      if !@releasinator_config.has_key?(key)
+        Printer.fail("No #{key} found in configatron.")
+        abort()
+      end
+    end
+
+    def validate_config()
+      validate_required_configatron_key(:product_name)
+      validate_required_configatron_key(:prerelease_checklist_items)
+      validate_required_configatron_key(:build_method)
+      validate_required_configatron_key(:publish_to_package_manager_method)
+      validate_required_configatron_key(:wait_for_package_manager_method)
+      validate_required_configatron_key(:release_to_github)
+
+      validate_method_convention(@releasinator_config)
+
+      if @releasinator_config.has_key? :downstream_repos
+        @releasinator_config[:downstream_repos].each do |downsteam_repo|
+          validate_is_type downsteam_repo, DownstreamRepo
+
+          validate_method_convention(downsteam_repo.options)
+        end
+      end
+    end
+
+    def validate_github_permissions(repo_url)
+      github_repo = GitHubRepo.new(repo_url)
+      github_client = github_repo.client
+
+      begin
+        # get the list of collaborators.
+        puts "Checking collaborators on #{repo_url}." if @releasinator_config[:verbose]
+        github_collaborators = github_client.collaborators "#{github_repo.org}/#{github_repo.repo}"
+        if ! github_collaborators
+          Printer.fail("request failed with code:#{res.code}\nbody:#{res.body}")
+          abort()
+        end
+        puts github_collaborators.inspect if @releasinator_config[:trace]
+        Printer.success("User has push permissions on #{repo_url}.")
+      rescue => error
+        #This will fail if the user does not have push permissions.
+        Printer.fail(error.inspect)
+        abort()
+      end
+    end
+
+    def validate_gitignore(line, is_downstream_present)
+      if !File.exist?(".gitignore")
+        FileUtils.touch('.gitignore')
+        CommandProcessor.command("git add . && git commit -m \"#{@releasinator_config[:releasinator_name]}: add .gitignore\"")
+      end
+
+      if is_downstream_present
+        if !line_match_in_file?(line, ".gitignore")
+          is_git_already_clean = GitUtil.new().is_clean_git?
+          File.open('.gitignore', 'a') do |f|
+            f.puts "# #{@releasinator_config[:releasinator_name]}"
+            f.puts line
+          end
+
+          if is_git_already_clean
+            CommandProcessor.command("git add . && git commit -m \"#{@releasinator_config[:releasinator_name]}: add downstream dir to .gitignore\"")
+          end
+        end
+      end
+    end
+
+    def line_match_in_file?(contains_string, filename)
+      File.open("#{filename}", "r") do |f|
+        f.each_line do |line|
+          if line.match /^#{Regexp.escape(contains_string)}$/
+            Printer.success("#{filename} contains #{contains_string}")
+            return true
+          end
+        end
+      end
+      false
+    end
+
+    def validate_referenced_in_readme(base_dir, filename)
+      Dir.chdir(base_dir) do
+        File.open("README.md", "r") do |f|
+          f.each_line do |line|
+            if line.include? "(#{filename})"
+              Printer.success("#{filename} referenced in #{base_dir}/README.md")
+              return
+            end
+          end
+        end
+      end
+      Printer.fail("Please link to the #{filename} file somewhere in #{base_dir}/README.md.")
+      abort()
+    end
+
+    def validate_exist(base_dir, expected_file_name, downstream_dir, alternate_names=[])
+      Dir.chdir(base_dir) do
+        if !File.exist?(expected_file_name)
+          puts "#{base_dir}/#{expected_file_name} not found. Searching for similar files.".yellow
+        
+          # search for files that are somewhat similar to the file being searched, ignoring case
+          filename_prefix = expected_file_name[0,5]
+          similar_files = CommandProcessor.command("find . -type f -not -path \"./#{downstream_dir}/*\" -iname '#{filename_prefix}*'| sed 's|./||'").strip
+          num_similar_files = similar_files.split.count
+          puts similar_files
+          if num_similar_files == 1
+            Printer.check_proceed("Found a single similar file: #{similar_files}.  Do you want to rename this to the expected #{expected_file_name}?","Please place #{base_dir}/#{expected_file_name}")
+            rename_file(similar_files, expected_file_name)
+          elsif num_similar_files > 1
+            Printer.fail("Found more than 1 file similar to #{expected_file_name}.  Please rename one, and optionally remove the others to not confuse users.")
+            abort()
+          elsif !rename_alternate_name(expected_file_name, alternate_names)
+            Printer.fail("Please place #{base_dir}/#{expected_file_name}.") 
+            abort()
+          end
+        end
+        Printer.success("#{base_dir}/#{expected_file_name} found.")
+      end
+    end
+
+    def validate_clean_git
+      untracked_files = GitUtil.untracked_files
+      diff = GitUtil.diff
+      diff_cached = GitUtil.cached
+
+      if '' != untracked_files
+        puts untracked_files.red if @releasinator_config[:verbose]
+        error = true
+        Printer.fail("Untracked files found.")
+      else
+        Printer.success("No untracked files found.")
+      end
+
+      if '' != diff
+        puts diff.red if @releasinator_config[:verbose]
+        error = true
+        Printer.fail("Unstaged changes found.")
+      else
+        Printer.success("No unstaged changes found.")
+      end
+
+      if '' != diff_cached
+        puts diff_cached.red if @releasinator_config[:verbose]
+        error = true
+        Printer.fail("Uncommitted changes found.")
+      else
+        Printer.success("No uncommitted changes found.")
+      end
+
+      abort() if error
+    end
+
+    class Submodule
+      attr_reader :name, :path, :url
+      
+      def initialize(name, path, url)
+        @name=name
+        @path=path
+        @url=url
+      end
+    end
+
+    def validate_submodules
+      if File.exist?(".gitmodules")
+        submodules = Array.new
+
+        current_name = nil
+        current_path = nil
+        current_url = nil
+        File.open(".gitmodules", "r") do |f|
+          f.each_line do |line|
+
+            if line.include? "\""
+              current_name = line.strip.split(' ').last.to_s.split("\"").at(1)
+            elsif line.include? "path = "
+              current_path = line.strip.split(' ').last.to_s
+            elsif line.include? "url = "
+              current_url = line.strip.split(' ').last.to_s
+              submodules << Submodule.new(current_name, current_path, current_url)
+            end
+          end
+        end
+
+        Printer.success("Found " + submodules.count.to_s.bold + " submodules in .gitmodules.")
+        submodules.each do |submodule|
+          Dir.chdir(submodule.path) do
+            validate_matches_branch("master", "Submodule")
+          end
+        end
+      else
+        Printer.success("No submodules found.")
+      end
+    end
+
+    def validate_matches_branch(branch_name, console_prefix="Root")
+      current_dir = Dir.pwd
+
+      # Don't fetch the submodules, as they should already be fetched by the initial recursive fetch.
+      if console_prefix == "Root"
+        puts "fetching #{current_dir}" if @releasinator_config[:verbose]
+
+        # silently fails if it can't connect because sometimes we want to release even if 
+        # corp GitHub is down.  
+        `git fetch --recurse-submodules -j9`
+      end
+
+      validate_clean_git()
+
+      head_sha1 = `git rev-parse --verify head`.strip
+      origin_branch_sha1 = `git rev-parse --verify origin/#{branch_name}`.strip
+      if head_sha1 != origin_branch_sha1
+        abort_string = "#{console_prefix} #{current_dir} at #{head_sha1}, but origin/#{branch_name} is #{origin_branch_sha1}."\
+        "\nIf you received this error on the root project, you may need to:"\
+        "\n  1. pull the latest changes from the remote,"\
+        "\n  2. push changes up to the remote,"\
+        "\n  3. back out a current release in progress."
+        Printer.fail(abort_string)
+        abort()
+      else
+        Printer.success("#{console_prefix} #{current_dir} matches origin/#{branch_name}.")
+      end
+    end
+
+    def rename_file(old_name, new_name)
+      puts "Renaming #{old_name} to expected filename: #{new_name}".yellow
+      CommandProcessor.command("mv #{old_name} #{new_name}")
+      # fix any references to file in readme
+      replace_string("README.md", "(#{old_name})", "(#{new_name})")
+      CommandProcessor.command("git add . && git commit -m \"#{@config[:releasinator_name]}: rename #{old_name} to #{new_name}\"")
+    end
+
+    def rename_alternate_name(expected_file_name, alternate_names)
+      alternate_names.each do |name|
+        if '' != CommandProcessor.command("ls #{name}")
+          puts "Found similar file: #{name}."
+          rename_file(name, expected_file_name)
+          return true
+        end
+      end
+      false
+    end
+  end
+end

data/lib/validator_changelog.rb

@@ -0,0 +1,82 @@
+require 'colorize'
+require 'Vandamme'
+require 'semantic'
+require_relative "current_release"
+require_relative 'printer'
+
+module Releasinator
+  class ValidatorChangelog
+
+    def validate_semver(changelog_hash, prefix="")
+      newer_version = nil
+      changelog_hash.each do |key,value|
+        if !key.start_with? prefix
+          Printer.fail("version #{key} does not start with prefix '#{prefix}'.")
+          abort()
+        end
+        older_version = Semantic::Version.new key[prefix.length..-1]
+
+        if nil != newer_version
+          version_comp = newer_version <=> older_version
+          if version_comp < 1
+            Printer.fail("Semver releases out of order: #{older_version} should be smaller than #{newer_version}")
+            abort()
+          end
+
+          error_suffix = "version increment error - comparing #{newer_version} to #{older_version} does not pass semver validation."
+          # validate the next sequence in semver
+          if newer_version.major == older_version.major
+            if newer_version.minor == older_version.minor
+              check_semver_criteria(newer_version.patch == older_version.patch + 1, "patch #{error_suffix}") 
+            else
+              check_semver_criteria(newer_version.minor == older_version.minor + 1 && newer_version.patch == 0, "minor #{error_suffix}") 
+            end
+          else
+            check_semver_criteria(newer_version.major == older_version.major + 1 && newer_version.minor == 0 && newer_version.patch == 0, "major #{error_suffix}")
+          end
+        end
+        newer_version = older_version
+      end
+    end
+
+    def check_semver_criteria(condition, message)
+      if !condition
+        Printer.fail(message)
+        abort()
+      end
+    end
+
+    def validate_changelog_contents(changelog_contents, prefix="")
+      version_header_regexes = [
+        ## h2 using --- separator.  Example:
+        #  1.0.0
+        #  -----
+        #  First release!
+        '(^\d+\.\d+\.\d+).*\n----.*',
+
+        # h1/h2 header retrieved from https://github.com/tech-angels/vandamme/#format
+        '^#{0,3} ?([\w\d\.-]+\.[\w\d\.-]+[a-zA-Z0-9])(?: \/ (\w+ \d{1,2}(?:st|nd|rd|th)?,\s\d{4}|\d{4}-\d{2}-\d{2}|\w+))?\n?[=-]*'
+      ]
+
+      changelog_hash = nil
+      version_header_regexes.each do |version_header_regex|
+        parser = Vandamme::Parser.new(changelog: changelog_contents, version_header_exp: version_header_regex, format: 'markdown')
+        changelog_hash = parser.parse
+
+        break if !changelog_hash.empty?
+      end
+      
+      if changelog_hash.empty?
+        Printer.fail("Unable to find any releases in the CHANGELOG.md.  Please check that your formatting is correct.")
+        abort()
+      end
+      
+      Printer.success("Found " + changelog_hash.count.to_s.bold + " release(s) in CHANGELOG.md.")
+
+      validate_semver(changelog_hash, prefix)
+
+      latest_release, latest_release_changelog = changelog_hash.first
+      CurrentRelease.new(latest_release, latest_release_changelog)
+    end
+  end
+end

data/releasinator.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'releasinator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "releasinator"
+  spec.version       = Releasinator::VERSION
+  spec.authors       = ["PayPal"]
+  spec.email         = ["DL-PP-RUBY-SDK@paypal.com"]
+  spec.summary       = %q{The releasinator assists in building and releasing SDKs across languages.}
+  spec.description   = %q{The releasinator assists in building and releasing SDKs across languages.}
+  spec.homepage      = "https://developer.paypal.com"
+  spec.license       = "Apache-2.0"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 11.1"
+
+  spec.add_dependency "configatron", "~> 4.5"
+  spec.add_dependency "colorize", "~> 0.7"
+  spec.add_dependency "vandamme", "~> 0.0.11"
+  spec.add_dependency "semantic", "~> 1.4"
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency "octokit", "~> 4.0"
+
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: releasinator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PayPal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: configatron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: vandamme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+- !ruby/object:Gem::Dependency
+  name: semantic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: The releasinator assists in building and releasing SDKs across languages.
+email:
+- DL-PP-RUBY-SDK@paypal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/command_processor.rb
+- lib/config_hash.rb
+- lib/copy_file.rb
+- lib/current_release.rb
+- lib/default_config.rb
+- lib/downstream_repo.rb
+- lib/git_util.rb
+- lib/github_repo.rb
+- lib/printer.rb
+- lib/publisher.rb
+- lib/releasinator/version.rb
+- lib/tasks/releasinator.rake
+- lib/validator.rb
+- lib/validator_changelog.rb
+- releasinator.gemspec
+homepage: https://developer.paypal.com
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: The releasinator assists in building and releasing SDKs across languages.
+test_files: []