hglib 0.1.pre20180129173049 → 0.1.0

data/spec/hglib/repo/id_spec.rb

@@ -0,0 +1,182 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../../spec_helper'
+
+require 'hglib/repo/id'
+
+
+RSpec.describe Hglib::Repo::Id do
+
+	it "can be created for an empty repo" do
+		result = described_class.new( '000000000000', 'tip' )
+
+		expect( result.global ).to eq( '000000000000' )
+		expect( result ).to eq( '000000000000' )
+		expect( result.tags ).to contain_exactly( 'tip' )
+		expect( result.bookmarks ).to be_empty
+		expect( result ).to_not have_uncommitted_changes
+	end
+
+
+	it "can be created for a repo with commits" do
+		result = described_class.new( 'd03a659966ec', 'tip' )
+
+		expect( result.global ).to eq( 'd03a659966ec' )
+		expect( result ).to eq( 'd03a659966ec' )
+		expect( result.tags ).to contain_exactly( 'tip' )
+		expect( result.bookmarks ).to be_empty
+		expect( result ).to_not have_uncommitted_changes
+	end
+
+
+	it "can be created for a repo with uncommitted changes" do
+		result = described_class.new( 'd03a659966ec', 'tip', uncommitted_changes: true )
+
+		expect( result.global ).to eq( 'd03a659966ec' )
+		expect( result ).to have_uncommitted_changes
+	end
+
+
+	it "can be created for a repo with more than one tag" do
+		result = described_class.new( 'd03a659966ec', 'qbase', 'qtip', 'repo-features.patch', 'tip' )
+
+		expect( result.global ).to eq( 'd03a659966ec' )
+		expect( result.tags ).to contain_exactly( 'qbase', 'qtip', 'repo-features.patch', 'tip' )
+	end
+
+
+	it "can be created for a repo with a bookmark" do
+		result = described_class.new( 'd03a659966ec', 'tip', bookmarks: 'master' )
+
+		expect( result.global ).to eq( 'd03a659966ec' )
+		expect( result.bookmarks ).to contain_exactly( 'master' )
+	end
+
+
+	it "can be created for a repo with more than one bookmark" do
+		result = described_class.new( 'd03a659966ec', 'tip', bookmarks: ['master', 'github/master'] )
+
+		expect( result.global ).to eq( 'd03a659966ec' )
+		expect( result.bookmarks ).to contain_exactly( 'master', 'github/master' )
+	end
+
+
+	describe "equality" do
+
+		it "is equal to an object of the same class with the same values" do
+			id = described_class.new( 'd03a659966ec',
+				'qbase', 'qtip', 'repo-features.patch', 'tip',
+				uncommitted_changes: true,
+				bookmarks: ['master', 'live']
+			)
+
+			copy = id.dup
+
+			expect( id ).to eq( copy )
+		end
+
+
+		it "is equal to the String that contains the same revision identifier" do
+			id = described_class.new( 'd03a659966ec',
+				'qbase', 'qtip', 'repo-features.patch', 'tip',
+				uncommitted_changes: true,
+				bookmarks: ['master', 'live']
+			)
+
+			expect( id ).to eq( 'd03a659966ec' )
+		end
+
+	end
+
+
+	describe "parsing server output" do
+
+		it "can parse the server output from an empty repo" do
+			result = described_class.parse( '000000000000 tip' )
+
+			expect( result.global ).to eq( '000000000000' )
+			expect( result ).to eq( '000000000000' )
+			expect( result.tags ).to contain_exactly( 'tip' )
+			expect( result.bookmarks ).to be_empty
+			expect( result ).to_not have_uncommitted_changes
+		end
+
+
+		it "can be parsed from the server output from a repo with commits" do
+			result = described_class.parse( 'd03a659966ec tip' )
+
+			expect( result.global ).to eq( 'd03a659966ec' )
+			expect( result ).to eq( 'd03a659966ec' )
+			expect( result.tags ).to contain_exactly( 'tip' )
+			expect( result.bookmarks ).to be_empty
+			expect( result ).to_not have_uncommitted_changes
+		end
+
+
+		it "can be parsed from the server output from a repo with uncommitted changes" do
+			result = described_class.parse( 'd03a659966ec+ tip' )
+
+			expect( result.global ).to eq( 'd03a659966ec' )
+			expect( result ).to have_uncommitted_changes
+		end
+
+
+		it "can be parsed from the server output from a repo with more than one tag" do
+			result = described_class.parse( 'd03a659966ec qbase/qtip/repo-features.patch/tip' )
+
+			expect( result.global ).to eq( 'd03a659966ec' )
+			expect( result.tags ).to contain_exactly( 'qbase', 'qtip', 'repo-features.patch', 'tip' )
+		end
+
+
+		it "can be parsed from the server output from a repo with a bookmark" do
+			result = described_class.parse( 'd03a659966ec tip master' )
+
+			expect( result.global ).to eq( 'd03a659966ec' )
+			expect( result.bookmarks ).to contain_exactly( 'master' )
+		end
+
+
+		it "can be parsed from the server output from a repo with more than one bookmark" do
+			result = described_class.parse( 'd03a659966ec tip master/servant' )
+
+			expect( result.global ).to eq( 'd03a659966ec' )
+			expect( result.bookmarks ).to contain_exactly( 'master', 'servant' )
+		end
+
+	end
+
+
+	describe "stringifying" do
+
+		it "works for the ID of an empty repo" do
+			id = described_class.new( '000000000000', 'tip' )
+
+			expect( id.to_s ).to eq( '000000000000 tip' )
+		end
+
+
+		it "works for the ID of a repo with uncommitted changes" do
+			id = described_class.new( 'd03a659966ec', 'tip', uncommitted_changes: true )
+
+			expect( id.to_s ).to eq( 'd03a659966ec+ tip' )
+		end
+
+
+		it "works for the ID of a repo with more than one tag" do
+			id = described_class.new( 'd03a659966ec', 'qbase', 'qtip', 'repo-features.patch', 'tip' )
+
+			expect( id.to_s ).to eq( 'd03a659966ec qbase/qtip/repo-features.patch/tip' )
+		end
+
+
+		it "works for the ID of a repo with a bookmark" do
+			id = described_class.new( 'd03a659966ec', 'tip', bookmarks: 'master' )
+
+			expect( id.to_s ).to eq( 'd03a659966ec tip master' )
+		end
+
+	end
+
+end
+

data/spec/hglib/repo/log_entry_spec.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env rspec -cfd
+# frozen_string_literal: true
+
+require_relative '../../spec_helper'
+
+require 'hglib/repo/log_entry'
+
+
+RSpec.describe Hglib::Repo::LogEntry do
+
+	RAW_LOG_ENTRY = {
+		"bookmarks" => ['master'],
+		"branch"    => "default",
+		"date"      => [1526420446, 25200],
+		"desc"      => "Flesh out the features of Repo objects",
+		"node"      => "d4af915821dea2feca29288dc16742c0d41cee8c",
+		"parents"   => ["a366819bd05b8dd995440105340e057528be25e6"],
+		"phase"     => "public",
+		"rev"       => 5,
+		"tags"      => ['github/master', 'tip'],
+		"user"      => "Michael Granger <ged@FaerieMUD.org>"
+	}.freeze
+
+	VERBOSE_LOG_ENTRY = RAW_LOG_ENTRY.merge(
+		"files"     => %w[.hoerc .ruby-version lib/hglib/repo.rb spec/hglib/repo_spec.rb]
+	).freeze
+
+
+	it "can be created from the JSON log hash" do
+		entry = described_class.new( RAW_LOG_ENTRY )
+
+		expected_time = Time.parse( 'Tue May 15 14:40:46 2018 -0700' )
+
+		expect( entry ).to be_a( described_class )
+		expect( entry.changeset ).to eq( '5:d4af915821de' )
+		expect( entry.rev ).to eq( 5 )
+		expect( entry.node ).to eq( 'd4af915821dea2feca29288dc16742c0d41cee8c' )
+		expect( entry.bookmarks ).to contain_exactly( 'master' )
+		expect( entry.tags ).to contain_exactly( 'github/master', 'tip' )
+		expect( entry.user ).to eq( 'Michael Granger <ged@FaerieMUD.org>' )
+		expect( entry.date ).to be_a( Time ).and( eq(expected_time) )
+		expect( entry.summary ).to eq( 'Flesh out the features of Repo objects' )
+
+		expect( entry.diff ).to be_nil
+		expect( entry.files ).to be_empty
+	end
+
+
+	it "can be created from verbose log entry JSON" do
+		entry = described_class.new( VERBOSE_LOG_ENTRY )
+
+		expected_time = Time.parse( 'Tue May 15 14:40:46 2018 -0700' )
+
+		expect( entry ).to be_a( described_class )
+		expect( entry.changeset ).to eq( '5:d4af915821de' )
+		expect( entry.rev ).to eq( 5 )
+		expect( entry.node ).to eq( 'd4af915821dea2feca29288dc16742c0d41cee8c' )
+		expect( entry.bookmarks ).to contain_exactly( 'master' )
+		expect( entry.tags ).to contain_exactly( 'github/master', 'tip' )
+		expect( entry.user ).to eq( 'Michael Granger <ged@FaerieMUD.org>' )
+		expect( entry.date ).to be_a( Time ).and( eq(expected_time) )
+		expect( entry.summary ).to eq( 'Flesh out the features of Repo objects' )
+
+		expect( entry.diff ).to be_nil
+		expect( entry.files ).to contain_exactly( *VERBOSE_LOG_ENTRY['files'] )
+	end
+
+end
+

data/spec/hglib/repo_spec.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'hglib/repo'
+
+
+RSpec.describe Hglib::Repo do
+
+	let( :repo_dir ) do
+		Dir.mktmpdir( ['hglib', 'repodir'] )
+	end
+
+	let( :server ) { instance_double(Hglib::Server) }
+
+
+	before( :each ) do
+		allow( Hglib::Server ).to receive( :new ).and_return( server )
+	end
+
+
+	it "can fetch the status of the working directory" do
+		repo = described_class.new( repo_dir )
+
+		expect( server ).to receive( :run ).with( :status, {} ).
+			and_return([
+				"M ",
+				".gems\n",
+				"M ",
+				"lib/hglib/repo.rb\n",
+				"M ",
+				"lib/hglib/server.rb\n",
+				"? ",
+				"coverage/assets/0.10.2/magnify.png\n"
+			])
+
+		result = repo.status
+
+		expect( result ).to be_a( Hash )
+		expect( result ).to include(
+			Pathname('.gems') => 'M',
+			Pathname('lib/hglib/repo.rb') => 'M',
+			Pathname('lib/hglib/server.rb') => 'M',
+			Pathname('coverage/assets/0.10.2/magnify.png') => '?'
+		)
+	end
+
+
+	it "can fetch the identification of the repository's current revision" do
+		repo = described_class.new( repo_dir )
+
+		expect( server ).to receive( :run ).with( :id, {} ).
+			and_return( ["80d775fc1d2c+ qbase/qtip/repo-features.patch/tip master\n"] )
+
+		result = repo.id
+
+		expect( result ).to be_a( Hglib::Repo::Id ).and( eq '80d775fc1d2c' )
+		expect( result.tags ).to eq( %w[qbase qtip repo-features.patch tip] )
+		expect( result.bookmarks ).to eq( %w[master] )
+	end
+
+
+	it "can fetch the log of the repository" do
+		repo = described_class.new( repo_dir )
+
+		expect( server ).to receive( :run ).with( :log, {T: 'json', graph: false} ).
+			and_return([
+				"[",
+				"\n {\n  \"bookmarks\": [],\n  \"branch\": \"default\",\n  \"date\": " +
+				"[1516812073, 28800],\n  \"desc\": \"Make ruby-version less specific\"," +
+				"\n  \"node\": \"81f357f730d9f22d560e4bd2790e7cf5aa5b7ec7\",\n  \"parents\":" +
+				" [\"d6c97f99b012199d9088e85bb0940147446c6a87\"],\n  \"phase\": \"public\",\n " +
+				" \"rev\": 1,\n  \"tags\": [],\n  \"user\": \"Michael Granger" +
+				" <ged@FaerieMUD.org>\"\n }",
+				",",
+				"\n {\n",
+				"  \"bookmarks\": []",
+				",\n",
+				"  \"branch\": \"default\"",
+				",\n",
+				"  \"date\": [1516811121, 28800]",
+				",\n",
+				"  \"desc\": \"Initial commit.\"",
+				",\n",
+				"  \"node\": \"d6c97f99b012199d9088e85bb0940147446c6a87\"",
+				",\n",
+				"  \"parents\": [\"0000000000000000000000000000000000000000\"]",
+				",\n",
+				"  \"phase\": \"public\"",
+				",\n",
+				"  \"rev\": 0",
+				",\n",
+				"  \"tags\": []",
+				",\n",
+				"  \"user\": \"Michael Granger <ged@FaerieMUD.org>\"",
+				"\n }",
+				"\n]\n"
+			])
+
+		result = repo.log
+
+		expect( result ).to be_an( Array ).and( all be_a(Hglib::Repo::LogEntry) )
+	end
+
+end
+

data/spec/hglib/server_spec.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'tmpdir'
+require 'hglib/server'
+
+
+RSpec.describe Hglib::Server do
+
+	def cmdserver_message( channel, data='' )
+		return [ channel, data.bytesize, data ].pack( 'A*I>A*' )
+	end
+
+	def cmdserver_header( channel, bytes )
+		return [ channel, bytes ].pack( 'aI>' )
+	end
+
+
+	let( :repo_dir ) do
+		Dir.mktmpdir( ['hglib', 'repodir'] )
+	end
+
+	let( :parent_reader ) { StringIO.new }
+	let( :child_reader ) { instance_double(IO, close: true) }
+	let( :parent_writer ) { StringIO.new }
+	let( :child_writer ) { instance_double(IO, close: true) }
+
+	let( :hello_message ) do
+		cmdserver_message( 'o', "capabilities: runcommand getencoding\nencoding: UTF-8\n" )
+	end
+	let( :line_input_prompt ) do
+		cmdserver_header( 'L', 4096 )
+	end
+	let( :byte_input_prompt ) do
+		cmdserver_header( 'I', 4096 )
+	end
+	let( :result_message ) do
+		cmdserver_message( 'r', "done" )
+	end
+
+
+	before( :each ) do
+		allow( Process ).to receive( :spawn ).and_return( 1111 )
+		allow( Process ).to receive( :kill ).with( :TERM, 1111 )
+		allow( Process ).to receive( :wait ).with( 1111, Process::WNOHANG )
+
+		allow( IO ).to receive( :pipe ).and_return(
+			[parent_reader, child_writer],
+			[child_reader, parent_writer]
+		)
+	end
+
+
+	describe "option-mangling" do
+
+		it "mangles single-letter keys into one-hyphen options" do
+			result = described_class.mangle_options( C: true, p: true, g: true )
+			expect( result ).to eq( %w[-C -p -g] )
+		end
+
+
+		it "mangles multi-letter keys into two-hyphen options" do
+			result = described_class.mangle_options( copies: true, patch: true )
+			expect( result ).to eq( %w[--copies --patch] )
+		end
+
+
+		it "drops single-letter keys with falsey values" do
+			result = described_class.mangle_options( g: false, p: nil )
+			expect( result ).to eq( [] )
+		end
+
+
+		it "negates multi-letter keys with falsey values" do
+			result = described_class.mangle_options( graph: false, patch: nil )
+			expect( result ).to eq( %w[--no-graph --no-patch] )
+		end
+
+
+		it "appends String values onto options with a space for single-letter keys" do
+			result = described_class.mangle_options( P: '165' )
+			expect( result ).to eq( %w[-P 165] )
+		end
+
+
+		it "appends String values onto options with an equal for multi-letter keys" do
+			result = described_class.mangle_options( prune: '165' )
+			expect( result ).to eq( %w[--prune=165] )
+		end
+
+	end
+
+
+	it "knows whether or not it has been started" do
+		parent_reader.write( hello_message )
+		parent_reader.rewind
+
+		server = described_class.new( repo_dir )
+
+		expect( server ).to_not be_started
+		server.start
+		expect( server ).to be_started
+	end
+
+
+	it "calls the on_line_input callback when the command server asks for line input" do
+		parent_reader.write( hello_message )
+		parent_reader.write( line_input_prompt )
+		parent_reader.write( result_message )
+		parent_reader.rewind
+
+		server = described_class.new( repo_dir )
+		server.on_line_input do |max_bytes|
+			"a line of input no more than #{max_bytes} long"
+		end
+		server.run( :record )
+
+		expect( parent_writer.string ).to include(
+			"runcommand\n",
+			"record",
+			"a line of input no more than 4096 long\n"
+		)
+	end
+
+
+	it "calls the on_byte_input callback when the command server asks for byte input" do
+		parent_reader.write( hello_message )
+		parent_reader.write( byte_input_prompt )
+		parent_reader.write( result_message )
+		parent_reader.rewind
+
+		server = described_class.new( repo_dir )
+		server.on_byte_input do |max_bytes|
+			"bytes of input no more than #{max_bytes} long"
+		end
+		server.run( :import, '-' )
+
+		expect( parent_writer.string ).to include(
+			"runcommand\n",
+			"import\0-",
+			"bytes of input no more than 4096 long"
+		)
+	end
+
+
+	it "can be stopped manually" do
+		parent_reader.write( hello_message )
+		parent_reader.rewind
+
+		server = described_class.new( repo_dir )
+		server.start
+
+		server.stop
+		expect( parent_writer.string ).to be_empty
+	end
+
+
+	it "doesn't error when told to stop if it hasn't been started" do
+		server = described_class.new( repo_dir )
+		expect( server.stop ).to be_falsey
+	end
+
+
+end
+