released 0.0.1

data/lib/released/pipeline_reader.rb

@@ -0,0 +1,73 @@
+module Released
+  class PipelineReader
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def read
+      yaml = transform(YAML.load_file(@filename))
+
+      goals = []
+
+      yaml['goals'].each do |goal_yaml|
+        name = goal_yaml.keys.first
+        config = goal_yaml[name]
+        # TODO: what if there are more?
+
+        goals << Released::Goal.named(name.to_sym).new(config)
+      end
+
+      goals
+    end
+
+    private
+
+    def transform(obj)
+      case obj
+      when Hash
+        transform_hash(obj)
+      when Array
+        transform_array(obj)
+      when String
+        transform_string(obj)
+      else
+        obj
+      end
+    end
+
+    def transform_hash(hash)
+      hash.each_with_object({}) do |(key, value), memo|
+        memo[key] = transform(value)
+      end
+    end
+
+    def transform_array(array)
+      array.map do |elem|
+        transform(elem)
+      end
+    end
+
+    def transform_string(string)
+      case string
+      when /\Aenv!(.*)/
+        ENV.fetch(Regexp.last_match(1))
+      when /\Ash!(.*)/
+        `#{Regexp.last_match(1)}`
+      when /\A-----BEGIN PGP MESSAGE-----/
+        decrypt(string)
+      else
+        string
+      end
+    end
+
+    def decrypt(string)
+      stdout = ''
+      stderr = ''
+
+      piper = Nanoc::Extra::Piper.new(stdout: stdout, stderr: stderr)
+      piper.run(['gpg', '--decrypt', '--no-tty'], string)
+
+      stdout
+    end
+  end
+end

data/lib/released/runner.rb

@@ -0,0 +1,171 @@
+module Released
+  class Runner
+    # FIXME: extract UI
+
+    class TUI
+      def initialize(io)
+        @io = io
+      end
+
+      def move_up(num)
+        @io <<
+          if num == 1
+            "\e[A"
+          else
+            "\e[#{num}A"
+          end
+      end
+
+      def move_down(num)
+        @io <<
+          if num == 1
+            "\e[B"
+          else
+            "\e[#{num}B"
+          end
+      end
+
+      def move_to_left(col = 1)
+        @io <<
+          if col == 1
+            "\e[G"
+          else
+            "\e[#{col}G"
+          end
+      end
+
+      def clear_to_end_of_line
+        @io << "\e[K"
+      end
+    end
+
+    def initialize(goals, dry_run: false)
+      @goals = goals
+      @dry_run = dry_run
+
+      @tui = TUI.new($stdout)
+      @tui_mutex = Mutex.new
+    end
+
+    def run
+      assess_all
+      try_achieve_all
+    end
+
+    private
+
+    def print_goals
+      @goals.each do |goal|
+        left.times { $stdout << '. ' }
+
+        @tui.move_to_left
+        $stdout << goal
+        $stdout << ' '
+
+        @tui.move_to_left(left - 1)
+        $stdout << ' '
+
+        @tui.move_to_left
+        @tui.move_down(1)
+      end
+    end
+
+    def handle_error(e)
+      puts
+      puts 'FAILURE!'
+      puts '-----'
+      puts e.message
+      puts
+      puts e.backtrace.join("\n")
+      puts '-----'
+      puts 'Aborting!'
+    end
+
+    def write_state(idx, left, state)
+      up = @goals.size - idx
+      @tui.move_up(up)
+      @tui.move_to_left(left)
+      $stdout << state
+      @tui.clear_to_end_of_line
+      @tui.move_to_left
+      @tui.move_down(up)
+    end
+
+    def left
+      @_left ||= @goals.map { |g| g.to_s.size }.max + 5
+    end
+
+    def assess_all
+      puts 'Assessing goals…'
+      print_goals
+
+      @goals.each.with_index do |_, idx|
+        write_state(idx, left, 'waiting')
+      end
+
+      @goals.each.with_index do |goal, idx|
+        if goal.assessable?
+          write_state(idx, left, 'working…')
+
+          begin
+            goal.assess
+            write_state(idx, left, 'ok (succeeded)')
+          rescue => e
+            write_state(idx, left, 'failed')
+            handle_error(e)
+            exit 1 # FIXME: eww
+          end
+        else
+          write_state(idx, left, 'ok (skipped)')
+        end
+      end
+
+      puts
+    end
+
+    def try_achieve_all
+      puts 'Achieving goals…'
+      print_goals
+
+      @goals.each.with_index do |_, idx|
+        write_state(idx, left, 'waiting')
+      end
+
+      @goals.each.with_index do |goal, idx|
+        if @dry_run
+          if goal.achieved?
+            write_state(idx, left, 'ok (already achieved)')
+          else
+            write_state(idx, left, 'pending')
+          end
+          next
+        end
+
+        if goal.achieved?
+          write_state(idx, left, 'ok (already achieved)')
+          next
+        end
+
+        begin
+          write_state(idx, left, 'working…')
+          goal.try_achieve
+        rescue => e
+          write_state(idx, left, 'errored')
+          handle_error(e)
+          exit 1 # FIXME: eww
+        end
+
+        if !goal.effectful?
+          write_state(idx, left, 'ok (passed)')
+          next
+        elsif goal.achieved?
+          write_state(idx, left, 'ok (newly achieved)')
+          next
+        else
+          write_state(idx, left, 'failed')
+          exit 1 # FIXME: eww
+        end
+      end
+    end
+  end
+end

data/lib/released/version.rb

@@ -0,0 +1,3 @@
+module Released
+  VERSION = '0.0.1'.freeze
+end

data/lib/released.rb

@@ -0,0 +1,17 @@
+module Released
+end
+
+require 'English'
+require 'json'
+require 'net/http'
+require 'shellwords'
+require 'uri'
+
+require 'ddplugin'
+require 'nanoc'
+
+require_relative 'released/version'
+require_relative 'released/goal'
+require_relative 'released/runner'
+require_relative 'released/pipeline_reader'
+require_relative 'released/goals'

data/released.gemspec

@@ -0,0 +1,38 @@
+require_relative 'lib/released/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'released'
+  s.version     = Released::VERSION
+  s.homepage    = 'https://github.com/ddfreyne/released'
+  s.summary     = 'extensible release tool'
+  s.description = ''
+
+  s.author  = 'Denis Defreyne'
+  s.email   = 'denis.defreyne@stoneship.org'
+  s.license = 'MIT'
+
+  s.files =
+    Dir['[A-Z]*'] +
+    Dir['{lib,spec}/**/*'] +
+    Dir['*.gemspec']
+  s.require_paths      = ['lib']
+
+  s.rdoc_options     = ['--main', 'README.md']
+
+  s.required_ruby_version = '>= 2.3.0'
+
+  # Dependencies for goals
+  # TODO: Move into plugins
+  s.add_runtime_dependency('git')
+  s.add_runtime_dependency('twitter')
+  s.add_runtime_dependency('gems')
+  s.add_runtime_dependency('netrc')
+  s.add_runtime_dependency('octokit')
+
+  # TODO: Remove this (copy piper?)
+  s.add_runtime_dependency('nanoc', '~> 4.4')
+
+  s.add_runtime_dependency('ddplugin', '~> 1.0')
+
+  s.add_development_dependency('bundler', '>= 1.7.10', '< 2.0')
+end

data/spec/released/goals/gem_built_spec.rb

@@ -0,0 +1,64 @@
+describe Released::Goals::GemBuilt do
+  subject(:goal) do
+    described_class.new(config)
+  end
+
+  let(:config) do
+    {
+      'name' => 'donkey',
+      'version' => '0.1',
+    }
+  end
+
+  let(:donkey_gemspec) do
+    <<~STRING
+      Gem::Specification.new do |s|
+        s.name    = 'donkey'
+        s.version = '0.1'
+
+        s.summary = 'the cutest animal'
+        s.author  = 'Denis Defreyne'
+        s.email   = 'denis.defreyne@stoneship.org'
+        s.license = 'MIT'
+
+        s.files   = []
+      end
+    STRING
+  end
+
+  describe '#achieved?' do
+    subject { goal.achieved? }
+
+    context 'file exists' do
+      before { File.write('donkey-0.1.gem', 'hello!') }
+      it { is_expected.to eql(true) }
+    end
+
+    context 'file does not exist' do
+      it { is_expected.to eql(false) }
+    end
+  end
+
+  describe '#try_achieve' do
+    subject { goal.try_achieve }
+
+    context 'no gemspec' do
+      it 'raises' do
+        expect { subject }.to raise_error(/Gemspec file not found/)
+      end
+    end
+
+    context 'valid gemspec' do
+      before { File.write('donkey.gemspec', donkey_gemspec) }
+
+      it 'builds the gem' do
+        expect { subject }.to change { File.file?('donkey-0.1.gem') }.from(false).to(true)
+      end
+    end
+  end
+
+  describe '#failure_reason' do
+    subject { goal.failure_reason }
+    it { is_expected.to eql('expected the file donkey-0.1.gem to exist') }
+  end
+end

data/spec/released/goals/gem_pushed_spec.rb

@@ -0,0 +1,149 @@
+describe Released::Goals::GemPushed, stdio: true do
+  subject(:goal) do
+    described_class.new(config)
+  end
+
+  let(:config) do
+    {
+      'name' => gem_name,
+      'version' => gem_version,
+      'authorization' => authorization,
+      'rubygems_base_url' => rubygems_base_url,
+    }
+  end
+
+  let(:gem_name) { 'nanoc' }
+  let(:gem_version) { '4.4.2' }
+  let(:authorization) { raise 'override me' }
+  let(:rubygems_base_url) { 'https://rubygems.org' }
+
+  let(:correct_authorization) { '83f5b7b9516c4342068cc60063a75de09bdb44d3' }
+  let(:incorrect_authorization) { '66666666666666666666666666666666' }
+
+  before do
+    gemspec =
+      <<~STRING
+        Gem::Specification.new do |s|
+          s.name    = 'nanoc'
+          s.version = '4.4.2'
+
+          s.summary = 'the best thing ever'
+          s.author  = 'Denis Defreyne'
+          s.email   = 'denis.defreyne@stoneship.org'
+          s.license = 'MIT'
+
+          s.files   = []
+        end
+      STRING
+
+    File.write('donkey.gemspec', gemspec)
+    system('gem', 'build', '--silent', 'donkey.gemspec')
+  end
+
+  describe '#assess' do
+    subject { goal.assess }
+
+    context 'incorrect authorization' do
+      let(:authorization) { incorrect_authorization }
+
+      it 'raises' do
+        VCR.use_cassette('goals__gem_pushed_spec__assess__incorrect_auth') do
+          expect { subject }.to raise_error(
+            RuntimeError, 'Authorization failed'
+          )
+        end
+      end
+    end
+
+    context 'correct authorization' do
+      let(:authorization) { correct_authorization }
+
+      context 'response does not include requested gem' do
+        let(:gem_name) { 'definitely_not_nanoc' }
+
+        it 'raises' do
+          VCR.use_cassette('goals__gem_pushed_spec__assess__correct_auth_but_gem_not_present') do
+            expect { subject }.to raise_error(
+              RuntimeError, 'List of owned gems does not include request gem'
+            )
+          end
+        end
+      end
+
+      context 'response includes requested gem' do
+        it 'raises' do
+          VCR.use_cassette('goals__gem_pushed_spec__assess__correct_auth_and_gem_present') do
+            expect { subject }.not_to raise_error
+          end
+        end
+      end
+    end
+  end
+
+  describe '#achieved?' do
+    subject { goal.achieved? }
+
+    context 'incorrect authorization' do
+      let(:authorization) { incorrect_authorization }
+
+      it 'raises' do
+        VCR.use_cassette('goals__gem_pushed_spec___achieved_q__incorrect_auth') do
+          expect { subject }.to raise_error(
+            RuntimeError, 'Authorization failed'
+          )
+        end
+      end
+    end
+
+    context 'correct authorization' do
+      let(:authorization) { correct_authorization }
+
+      context 'achieved' do
+        it 'is achieved' do
+          VCR.use_cassette('goals__gem_pushed_spec___achieved_q__achieved') do
+            expect(subject).to be
+          end
+        end
+      end
+
+      context 'not achieved' do
+        it 'is not achieved' do
+          VCR.use_cassette('goals__gem_pushed_spec___achieved_q__not_achieved') do
+            expect(subject).not_to be
+          end
+        end
+      end
+    end
+  end
+
+  describe '#try_achieve' do
+    subject { goal.try_achieve }
+
+    let(:rubygems_repo) do
+      Gems::Client.new(
+        key: '83f5b7b9516c4342068cc60063a75de09bdb44d3',
+        host: 'https://rubygems.org',
+      )
+    end
+
+    let(:authorization) { correct_authorization }
+
+    example do
+      VCR.use_cassette('goals__gem_pushed_spec___try_achieve__step_a') do
+        expect(rubygems_repo.gems.any? { |g| g['name'] == 'nanoc' && g['version'] == '4.4.2' }).not_to be
+      end
+
+      VCR.use_cassette('goals__gem_pushed_spec___try_achieve__step_b') do
+        subject
+      end
+
+      VCR.use_cassette('goals__gem_pushed_spec___try_achieve__step_c') do
+        expect(rubygems_repo.gems.any? { |g| g['name'] == 'nanoc' && g['version'] == '4.4.2' }).to be
+      end
+    end
+  end
+
+  describe '#failure_reason' do
+    # TODO
+  end
+end

data/spec/released/goals/git_ref_pushed_spec.rb

@@ -0,0 +1,74 @@
+describe Released::Goals::GitRefPushed do
+  subject(:goal) do
+    described_class.new(config)
+  end
+
+  let(:config) do
+    {
+      'working_dir' => 'local',
+      'remote' => 'gitlab',
+      'branch' => 'devel',
+    }
+  end
+
+  let!(:local) do
+    Git.init('local').tap do |g|
+      g.config('user.name', 'Testy McTestface')
+      g.config('user.email', 'testface@example.com')
+
+      g.chdir { File.write('hello.txt', 'hi there') }
+      g.add('hello.txt')
+      g.commit('Add greeting')
+      g.branch('devel').checkout
+    end
+  end
+
+  let!(:remote) do
+    Git.init('remote')
+  end
+
+  before do
+    local.add_remote('gitlab', './remote')
+  end
+
+  describe '#achieved?' do
+    subject { goal.achieved? }
+
+    context 'not pushed' do
+      it { is_expected.not_to be }
+    end
+
+    context 'pushed, but not right rev' do
+      before do
+        goal.try_achieve
+
+        local.chdir { File.write('bye.txt', 'bye now') }
+        local.add('bye.txt')
+        local.commit('Add farewell')
+        local.branch('devel').checkout
+      end
+
+      it { is_expected.not_to be }
+    end
+
+    context 'pushed' do
+      before { goal.try_achieve }
+      it { is_expected.to be }
+    end
+  end
+
+  describe '#try_achieve' do
+    subject { goal.try_achieve }
+
+    example do
+      expect(remote.branches['devel']).to be_nil
+      subject
+      expect(remote.branches['devel'].gcommit.sha).to eql(local.branches['devel'].gcommit.sha)
+    end
+  end
+
+  describe '#failure_reason' do
+    subject { goal.failure_reason }
+    it { is_expected.to eql('HEAD does not exist on gitlab/devel') }
+  end
+end

data/spec/released/pipeline_reader_spec.rb

@@ -0,0 +1,49 @@
+describe Released::PipelineReader do
+  subject(:pipeline_reader) { described_class.new(filename) }
+
+  let(:filename) { 'pipeline.yaml' }
+
+  before do
+    ENV['FAVORITE_GEM_AUTHOR'] = 'denis'
+  end
+
+  describe '#transform' do
+    subject { pipeline_reader.send(:transform, obj) }
+
+    context 'with array' do
+      let(:obj) { %w(hello env!FAVORITE_GEM_AUTHOR) }
+      it { is_expected.to eql(%w(hello denis)) }
+    end
+
+    context 'with hash' do
+      let(:obj) { { people: ['env!FAVORITE_GEM_AUTHOR'] } }
+      it { is_expected.to eql(people: ['denis']) }
+    end
+
+    context 'with string' do
+      context 'normal string' do
+        let(:obj) { 'hello' }
+        it { is_expected.to eql(obj) }
+      end
+
+      context 'env! string' do
+        let(:obj) { 'env!FAVORITE_GEM_AUTHOR' }
+        it { is_expected.to eql('denis') }
+      end
+
+      context 'sh! string' do
+        let(:obj) { 'sh!echo -n hello' }
+        it { is_expected.to eql('hello') }
+      end
+
+      context 'encrypted string' do
+        # TODO
+      end
+    end
+
+    context 'with anything else' do
+      let(:obj) { :donkey }
+      it { is_expected.to eql(obj) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'released'
+
+require 'webmock/rspec'
+require 'vcr'
+require 'rspec/its'
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'fixtures/vcr_cassettes'
+  config.hook_into :webmock
+end
+
+RSpec.configure do |c|
+  c.around(:each, stdio: true) do |example|
+    orig_stdout = $stdout
+    orig_stderr = $stderr
+
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    example.run
+
+    $stdout = orig_stdout
+    $stderr = orig_stderr
+  end
+
+  c.around(:each) do |example|
+    Dir.mktmpdir('released-specs') do |dir|
+      FileUtils.cd(dir) do
+        example.run
+      end
+    end
+  end
+end