jm81-svn-fixture 0.1.0

data/lib/svn-fixture/revision.rb

@@ -0,0 +1,65 @@
+module SvnFixture
+  # A Revision of the Repository. It can be added via Repository#revision to
+  # a specific Repository
+  #
+  #     repo = SvnFixture::Repository.get('test') do
+  #       revision(1, 'log msg')
+  #     end
+  #     repo.commit
+  #
+  # or specified in Repository#commit:
+  #
+  #     rev = SvnFixture::Revision.new(1, 'log msg')
+  #     SvnFixture::Repository.get('test').commit(rev)
+  class Revision
+    attr_reader :name
+    
+    # Initialize a Revision (normally called by Repository#revision).
+    #
+    # - +name+: A name of the Revision, can be given in Array to 
+    #   Repository#commit instead of the Revision itself. Can be a revision
+    #   number, but this does not affect the actual revision number in the
+    #   Subversion repository.
+    # - +message+: Log message. Defaults to empty String.
+    # - +options+:
+    #   - +:author+: The Revision's author
+    #   - +:date+: The date and time of the commit
+    # - Optionally accepts a block. The block, if given, is run at the time
+    #   #commit is called, within the context of the root directory of the
+    #   Repository, which is an instance of SvnFixture::Directory. For example:
+    #
+    #     SvnFixture::Revision.new(1, 'log msg') do
+    #       dir('test') # Or any other SvnFixture::Directory instance method.
+    #     end
+    def initialize(name, message = "", options = {}, &block)
+      @name, @message, @block = name, message, block
+      @author = options.delete(:author)
+      @date = SvnFixture.svn_time(options.delete(:date))
+    end
+    
+    # Processes the changes made in this revision. Normally these would be made
+    # in a block given to Revision.new. #commit runs that block against the root
+    # directory of the working copy. This method is usually called by
+    # Repository#commit instead of directly. Also sets Revision properties for
+    # log message and, optionally, author and date, based on arguments 
+    # to +.new+. If there are no changes, the commit fails and a warning to that
+    # effect.
+    # 
+    # Only argument is an instance of SvnFixture::Repository that is the
+    # Repository to which this revision is committed.
+    def commit(repo)
+      root = Directory.new(repo.ctx, repo.wc_path)
+      root.instance_eval(&@block) if @block
+      ci = repo.ctx.ci(repo.wc_path)
+      unless ci.revision == Svn::Core::INVALID_REVNUM
+        rev = ci.revision
+        repo.repos.fs.set_prop('svn:log', @message, rev) if @message
+        repo.repos.fs.set_prop('svn:author', @author, rev) if @author
+        repo.repos.fs.set_prop('svn:date', @date, rev) if @date
+      else
+        puts "Warning: No change in revision #{name} (SvnFixture::Revision#commit)"
+      end
+      return true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'svn-fixture'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/svn-fixture/config_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "SvnFixture.config" do
+  before(:each) do
+    # Force to default state
+    SvnFixture.instance_variable_set(:@config, nil)
+  end
+  
+  after(:all) do
+    # Force to default state for other specs
+    SvnFixture.instance_variable_set(:@config, nil)
+  end
+  
+  it 'should initialize with CONFIG_DEFAULTS' do
+    SvnFixture.config.should == SvnFixture::CONFIG_DEFAULTS
+  end
+  
+  it 'should be writable' do
+    SvnFixture.config[:base_path] = '/tmp/elsewhere'
+    SvnFixture.instance_variable_get(:@config)[:base_path].
+        should == '/tmp/elsewhere'
+  end
+  
+  describe ':base_path' do
+    it 'should default to "#{Dir.tmpdir)/#{svn-fixture}"' do
+      SvnFixture.config[:base_path].should == File.join(Dir.tmpdir, 'svn-fixture')
+    end
+  end
+end

data/spec/svn-fixture/directory_spec.rb

@@ -0,0 +1,194 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SvnFixture::Directory do
+  before(:each) do
+    @klass = SvnFixture::Directory
+    SvnFixture::Repository.destroy_all
+    
+    # Set up repo
+    @repos = SvnFixture::repo('dir_test') do
+      revision(1, 'create directory and file') do
+        dir('test-dir') do
+          dir('subdir')
+          file('file.txt')
+        end
+      end
+    end
+    @repos.commit
+    @repos_path = @repos.instance_variable_get(:@repos_path)
+    @wc_path = @repos.instance_variable_get(:@wc_path)
+    @ctx = @repos.ctx
+  end
+  
+  before(:each) do
+    @path = File.join(@wc_path, 'test-dir')
+    @full_repos_path = "file://#{File.join(@repos_path, 'test-dir')}"
+    @dir = @klass.new(@ctx, @path)
+  end
+  
+  after(:all) do
+    SvnFixture::Repository.destroy_all
+  end
+  
+  describe '#initialize' do
+    it 'should set ctx and path' do
+      dir = @klass.new(@ctx, '/tmp/path/')
+      dir.instance_variable_get(:@ctx).should == @ctx
+      dir.instance_variable_get(:@path).should == '/tmp/path/'
+    end
+    
+    it 'should add a trailing slash to path if needed' do
+      dir = @klass.new(@ctx, '/tmp/path')
+      dir.instance_variable_get(:@path).should == '/tmp/path/'
+    end
+  end
+  
+  describe '#dir' do
+    before(:each) do
+      @subdir_path = File.join(@path, 'subdir')
+    end
+    
+    it 'should create a new directory if needed (and add to Subversion)' do
+      new_path = File.join(@path, 'subdir2')
+      File.exist?(new_path).should be_false
+      new_dir = @dir.dir('subdir2')
+      @ctx.commit(@wc_path)
+      File.exist?(new_path).should be_true
+      @repos.repos.fs.root.dir?('test-dir/subdir2').should be_true
+    end
+    
+    it 'should use an existing directory' do
+      FileUtils.should_not_receive(:mkdir_p)
+      @ctx.should_not_receive(:add)
+      @dir.dir('subdir')
+    end
+    
+    it 'should setup a new SvnFixture::Directory' do
+      SvnFixture::Directory.should_receive(:new).with(@ctx, @subdir_path)
+      @dir.dir('subdir')
+    end
+    
+    it 'should return the Directory' do
+      sub = @dir.dir('subdir')
+      sub.should be_kind_of(SvnFixture::Directory)
+      sub.instance_variable_get(:@path).should == @subdir_path + '/'
+    end
+    
+    it 'should run block if given' do
+      SvnFixture::File.should_receive(:new).with(@ctx, File.join(@subdir_path, 'test.txt'))
+      @dir.dir('subdir') do
+        file('test.txt')
+      end
+    end
+  end
+  
+  describe '#file' do
+    before(:each) do
+      @file_path = File.join(@path, 'file.txt')
+    end
+    
+    it 'should create a new file if needed (and add to Subversion)' do
+      new_path = File.join(@path, 'file2.txt')
+      File.exist?(new_path).should be_false
+      f = @dir.file('file2.txt')
+      @ctx.commit(@wc_path)
+      File.exist?(new_path).should be_true
+      @repos.repos.fs.root.file?('test-dir/file2.txt').should be_true
+    end
+    
+    it 'should use an existing file' do
+      FileUtils.should_not_receive(:touch)
+      @ctx.should_not_receive(:add)
+      @dir.file('file.txt')
+    end
+    
+    it 'should setup a new SvnFixture::File' do
+      SvnFixture::File.should_receive(:new).with(@ctx, @file_path)
+      @dir.file('file.txt')
+    end
+    
+    it 'should return the File' do
+      f = @dir.file('file.txt')
+      f.should be_kind_of(SvnFixture::File)
+      f.instance_variable_get(:@path).should == @file_path
+    end
+    
+    it 'should run block if given' do
+      @dir.file('file.txt') do
+        body('Test')
+      end
+      File.read(@file_path).should == 'Test'
+    end
+  end
+  
+  describe '#move' do
+    before(:each) do
+      @file_path = File.join(@path, 'file.txt')
+    end
+    
+    it 'should move node in FS and Subversion' do
+      new_path = File.join(@path, 'subdir', 'file2.txt')
+      File.exist?(new_path).should be_false
+      File.exist?(@file_path).should be_true
+      @dir.move('file.txt', 'subdir/file2.txt')
+      File.exist?(new_path).should be_true
+      File.exist?(@file_path).should be_false
+      @ctx.commit(@wc_path)
+      @repos.repos.fs.root.file?('test-dir/file.txt').should be_false
+      @repos.repos.fs.root.file?('test-dir/subdir/file2.txt').should be_true
+    end
+  end
+  
+  describe '#copy' do
+    before(:each) do
+      @file_path = File.join(@path, 'file.txt')
+    end
+    
+    it 'should copy node in FS and Subversion' do
+      new_path = File.join(@path, 'subdir', 'file2.txt')
+      File.exist?(new_path).should be_false
+      File.exist?(@file_path).should be_true
+      @dir.copy('file.txt', 'subdir/file2.txt')
+      File.exist?(new_path).should be_true
+      File.exist?(@file_path).should be_true
+      @ctx.commit(@wc_path)
+      @repos.repos.fs.root.file?('test-dir/file.txt').should be_true
+      @repos.repos.fs.root.file?('test-dir/subdir/file2.txt').should be_true
+    end
+  end
+  
+  describe '#delete' do
+    before(:each) do
+      @file_path = File.join(@path, 'file.txt')
+    end
+    
+    it 'should copy node in FS and Subversion' do
+      File.exist?(@file_path).should be_true
+      @dir.delete('file.txt')
+      File.exist?(@file_path).should be_false
+      @ctx.commit(@wc_path)
+      @repos.repos.fs.root.file?('test-dir/file.txt').should be_false
+    end
+  end
+  
+  describe '#prop' do    
+    it 'should set a property' do
+      @dir.prop('prop:name', 'Prop Value')
+      rev = @ctx.ci(@wc_path).revision
+      @ctx.propget('prop:name', @path, rev)[@full_repos_path].should ==
+          'Prop Value'
+      
+      @dir.prop('prop:name', 'New Value')
+      rev = @ctx.ci(@wc_path).revision
+      @ctx.propget('prop:name', @path, rev)[@full_repos_path].should ==
+          'New Value'
+    end
+    
+    it 'should format a Time correctly' do
+      @dir.prop('prop:timeval', Time.parse('2009-06-18 14:00'))
+      rev = @ctx.ci(@wc_path).revision
+      @ctx.propget('prop:timeval', @path, rev)[@full_repos_path].should ==
+          '2009-06-18T14:00:00.000000Z'
+    end
+  end
+end

data/spec/svn-fixture/file_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SvnFixture::File do
+  before(:all) do
+    @klass = SvnFixture::File
+    SvnFixture::Repository.destroy_all
+    
+    # Set up repo
+    @repos = SvnFixture::repo('file_test') do
+      revision(1, 'create file') do
+        file('test.txt')
+      end
+    end
+    @repos.commit
+    @repos_path = @repos.instance_variable_get(:@repos_path)
+    @wc_path = @repos.instance_variable_get(:@wc_path)
+    @ctx = @repos.ctx
+  end
+  
+  before(:each) do
+    @path = File.join(@wc_path, 'test.txt')
+    @full_repos_path = "file://#{File.join(@repos_path, 'test.txt')}"
+    @file = @klass.new(@ctx, @path)
+  end
+  
+  after(:all) do
+    SvnFixture::Repository.destroy_all
+  end
+  
+  describe '#initialize' do
+    it 'should set ctx and path' do
+      file = @klass.new(@ctx, '/tmp/path')
+      file.instance_variable_get(:@ctx).should == @ctx
+      file.instance_variable_get(:@path).should == '/tmp/path'
+    end
+  end
+  
+  describe '#prop' do    
+    it 'should set a property' do
+      @file.prop('prop:name', 'Prop Value')
+      rev = @ctx.ci(@wc_path).revision
+      @ctx.propget('prop:name', @path, rev)[@full_repos_path].should ==
+          'Prop Value'
+      
+      @file.prop('prop:name', 'New Value')
+      rev = @ctx.ci(@wc_path).revision
+      @ctx.propget('prop:name', @path, rev)[@full_repos_path].should ==
+          'New Value'
+    end
+    
+    it 'should format a Time correctly' do
+      @file.prop('prop:timeval', Time.parse('2009-06-18 14:00'))
+      rev = @ctx.ci(@wc_path).revision
+      @ctx.propget('prop:timeval', @path, rev)[@full_repos_path].should ==
+          '2009-06-18T14:00:00.000000Z'
+    end
+  end
+  
+  describe '#body' do
+    it "should update the File's contents" do
+      @file.body('Test Content')
+      File.read(@path).should == 'Test Content'
+    end
+  end
+end

data/spec/svn-fixture/fixtures/hello_world.rb

@@ -0,0 +1,43 @@
+# For use by integration_spec
+
+SvnFixture::repo('hello_world') do
+  revision(1, 'Create directories',
+      :date => Time.parse('2009-01-01 12:00:00Z')) do
+    dir 'app'
+    dir 'docs'
+    dir 'lib'
+  end
+  
+  revision 2, 'Add some files' do
+    dir 'app' do
+      prop 'full_name', 'Application'
+      
+      file 'hello.rb' do
+        prop 'is_ruby', 'Yes'
+        body 'puts "Hello World"'
+      end
+      
+      file 'goodbye.rb' do
+        body 'puts "Goodbye World"'
+      end
+    end
+  end
+end
+
+SvnFixture::repo('hello_world') do
+  revision 3, 'Edit hello.rb', :author => "the.author" do
+    dir 'app' do
+      file 'hello.rb' do
+        prop 'is_ruby', 'Probably'
+        body 'puts "Howdy World"'
+      end
+    end
+  end
+  
+  revision 4, 'Copy and move' do
+    dir 'app' do
+      move 'goodbye.rb', 'bye.rb'
+      copy 'hello.rb', 'hello2.rb'
+    end
+  end
+end

data/spec/svn-fixture/integration_spec.rb

@@ -0,0 +1,102 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+# Test again fixtures/hello_world.rb to follow a complete fixture generation.
+describe 'SvnFixture integration' do
+  before(:all) do
+    SvnFixture::Repository.instance_variable_set(:@repositories, {})
+    load File.dirname(__FILE__) + '/fixtures/hello_world.rb'
+    SvnFixture::repo('hello_world').commit
+    repos_path = File.join(Dir.tmpdir, 'svn-fixture', 'repo_hello_world')
+    @repos = ::Svn::Repos.open(repos_path)
+    @fs = @repos.fs
+  end
+  
+  after(:all) do
+    SvnFixture::Repository.destroy_all
+  end
+  
+  describe 'revision 1' do
+    before(:each) do
+      @root = @fs.root(1)
+    end
+    
+    it 'should have 3 directories' do
+      @root.dir?('app').should be_true
+      @root.dir?('docs').should be_true
+      @root.dir?('lib').should be_true
+    end
+    
+    it 'should not have files' do
+      @root.file?('app/hello.rb').should be_false
+    end
+    
+    it 'should have specified date at rev 1' do
+      @fs.prop(Svn::Core::PROP_REVISION_DATE, 1).should ==
+          Time.parse('2009-01-01 12:00:00Z')
+    end
+  end
+  
+  describe 'revision 2' do
+    before(:each) do
+      @root = @fs.root(2)
+    end
+    
+    it 'should have files' do
+      @root.file?('app/hello.rb').should be_true
+      @root.file_contents('app/hello.rb') do |f|
+        f.read.should == 'puts "Hello World"'
+      end
+      @root.file?('app/goodbye.rb').should be_true
+    end
+    
+    it 'should have property for hello.rb' do
+      @root.node_proplist('app/hello.rb')['is_ruby'].should == 'Yes'
+    end
+  end
+  
+  describe 'revision 3' do
+    before(:each) do
+      @root = @fs.root(3)
+    end
+    
+    it 'should change text for hello.rb' do
+      @root.file_contents('app/hello.rb') do |f|
+        f.read.should == 'puts "Howdy World"'
+      end
+    end
+    
+    it 'should change property for hello.rb' do
+      @root.node_proplist('app/hello.rb')['is_ruby'].should == 'Probably'
+    end
+    
+    it 'should set author' do
+      @fs.prop(Svn::Core::PROP_REVISION_AUTHOR, 3).should ==
+          'the.author'
+    end
+  end
+  
+  describe 'revision 4' do
+    before(:each) do
+      @root = @fs.root(4)
+    end
+    
+    it 'should copy/move files' do
+      @root.file?('app/hello.rb').should be_true
+      @root.file?('app/hello2.rb').should be_true
+      @root.file_contents('app/hello2.rb') do |f|
+        f.read.should == 'puts "Howdy World"'
+      end
+      @root.file?('app/goodbye.rb').should be_false
+      @root.file?('app/bye.rb').should be_true
+    end
+    
+    it 'should have expected dirs, files' do
+      @root.dir?('app').should be_true
+      @root.file?('app/hello.rb').should be_true
+      @root.file?('app/hello2.rb').should be_true
+      @root.file?('app/bye.rb').should be_true
+      @root.dir?('docs').should be_true
+      @root.dir?('lib').should be_true
+    end
+  end
+end