gitolite-dtg 0.1.0

data/lib/gitolite-dtg/gitolite_admin.rb

@@ -0,0 +1,154 @@
+require 'abbrev'
+
+module Gitolite
+  module Dtg
+    class GitoliteAdmin
+		attr_accessor :gl_admin, :config
+
+		CONF = "gitolite.conf"
+		CONFDIR = "conf"
+		BRANCH = "master"
+
+		# Intialize with the path to
+		# the gitolite-admin repository
+		def initialize(path, options = {})
+		  @path = path
+		  @gl_admin = Grit::Repo.new(path)
+
+		  @conf = options[:conf] || CONF
+		  @confdir = options[:confdir] || CONFDIR
+		  @branch  = options[:branch] || BRANCH
+
+		  # Load the configuration
+		  load_data
+		end
+
+		# This method will destroy the in-memory data structures and reload everything
+		# from the file system
+		def reload!
+		  load_data
+		end
+
+		#Checks to see if the given path is a gitolite-admin repository
+		#A valid repository contains a conf folder, keydir folder,
+		#and a configuration file within the conf folder
+		def self.is_gitolite_admin_repo?(dir)
+		  # First check if it is a git repository
+		  begin
+			repo = Grit::Repo.new(dir)
+		  rescue Grit::InvalidGitRepositoryError
+			return false
+		  end
+
+		  # If we got here it is a valid git repo,
+		  # now check directory structure
+		  cbl = repo.tree / 'conf/gitolite.conf'
+		  if cbl != nil
+			return true
+		  else
+			return false
+		  end
+		end
+		
+		# repo_name - the repository name 
+		# username - the authenticated user name
+		# resource_path - the path relative to the repository root that
+		#                 the user is requesting access to
+		# wanted_access - the type of access the user is requesting. can
+		#                 be 'R' or 'W'
+		def authorize(repo_name, username, resource_path, wanted_access)
+			if @config == nil
+				return false
+			end
+			repo = @config.repos[repo_name]
+			if repo != nil
+				repo.permissions.each do |perm_hash|
+					perm_hash.each do |perm, list|
+					  #process a permission line
+					  list.each do |refex, users|
+						
+						ul = []
+					  	users.each do |user|
+							if user[0,1]=='@'
+							    gname = user.gsub('@', '')
+							    if ((@config.special_groups.include? gname) == false)
+									grp = @config.flat_groups[gname]
+									ul.concat(grp)
+								else
+									ul.push(user)
+							    end
+							else
+								ul.push(user)
+							end
+					  	end
+					  	ul.uniq!
+					  	
+					  	user_matches = false
+					  	if ((ul.include? "@all") || ((ul.include? "@raven") && (username != nil)) || (ul.include? username))
+							user_matches = true
+					  	end
+					  	
+					  	if user_matches == false
+							next
+						end
+						
+						
+						refex_applies = false;
+						if refex == ''
+							refex_applies = true;
+						else
+							dirs = []
+							dirs.push(refex)
+							dirs.push(resource_path)
+	 
+							common_prefix = dirs.abbrev.keys.min_by {|key| key.length}.chop
+							common_directory = common_prefix.sub(%r{/[^/]*$}, '')
+							
+							if common_directory != ''
+								refex_applies = true
+							end
+						end
+						if !refex_applies
+							next # if rule refex does not refer to the resource the user requested, go to the next rule
+						end
+						
+					  	
+					  	access_matches = false
+					  	if (perm.include? wanted_access)
+							access_matches = true
+					  	end
+					  	
+					  	# authorization cases. at this point, user_matches==true and refex_applies==true:
+					  	if (perm == "-")
+							return false
+						elsif (user_matches && access_matches)
+							#print "Access allowed by matching rule: " + perm + " "
+							#print list
+							#print "\n"
+							return true
+						else
+							next
+					  	end
+
+					  end
+					end
+				end
+			end
+			return false
+		end
+
+		private
+		  def load_data
+		    head = @gl_admin.commits(@branch).first
+		    config_blob = head.tree / File.join(@confdir, @conf)
+		    if config_blob != nil
+				@config = Config.new(config_blob)
+			else
+				@config = nil
+				print 'gitolite configuration could not be found in repository at ' + File.join(@path,@confdir,@conf)
+			end
+		  end
+		  
+	end
+  end
+end

data/lib/gitolite-dtg/version.rb

@@ -0,0 +1,5 @@
+module Gitolite
+  module Dtg
+    VERSION = "0.1.0"
+  end
+end

data/lib/gitolite-dtg.rb

@@ -0,0 +1,9 @@
+module Gitolite
+  module Dtg
+    require 'grit'
+    require 'hashery'
+    require 'gratr'
+    require 'gitolite-dtg/config'
+    require 'gitolite-dtg/gitolite_admin'
+  end
+end

data/spec/concurrency_spec.rb

@@ -0,0 +1,2 @@
+#require 'gitolite'
+#require 'spec_helper'

data/spec/config_spec.rb

@@ -0,0 +1,459 @@
+require 'gratr'
+require 'gitolite/config'
+require 'spec_helper'
+
+describe Gitolite::Config do
+  conf_dir = File.join(File.dirname(__FILE__),'configs')
+
+  describe "#new" do
+    it 'should read a simple configuration' do
+      c = Gitolite::Config.new(File.join(conf_dir, 'simple.conf'))
+      c.repos.length.should == 2
+      c.groups.length.should == 0
+    end
+
+    it 'should read a complex configuration' do
+      c = Gitolite::Config.new(File.join(conf_dir, 'complicated.conf'))
+      c.groups.length.should == 5
+      c.repos.length.should == 12
+    end
+
+    describe 'gitweb operations' do
+      before :all do
+        @config = Gitolite::Config.new(File.join(conf_dir, 'complicated.conf'))
+      end
+
+      it 'should correctly read gitweb options for an existing repo' do
+        r = @config.get_repo('gitolite')
+        r.owner.should == "Sitaram Chamarty"
+        r.description.should == "fast, secure, access control for git in a corporate environment"
+      end
+
+      it 'should correctly read a gitweb option with no owner for an existing repo' do
+        r = @config.get_repo('foo')
+        r.owner.should be nil
+        r.description.should == "Foo is a nice test repo"
+      end
+
+      it 'should correctly read gitweb options for a new repo' do
+        r = @config.get_repo('foobar')
+        r.owner.should == "Bob Zilla"
+        r.description.should == "Foobar is top secret"
+      end
+
+      it 'should correctly read gitweb options with no owner for a new repo' do
+        r = @config.get_repo('bar')
+        r.owner.should be nil
+        r.description.should == "A nice place to get drinks"
+      end
+
+      it 'should raise a ParseError when a description is not specified' do
+        t = Tempfile.new('bad_conf.conf')
+        t.write('gitolite "Bob Zilla"')
+        t.close
+
+        lambda { Gitolite::Config.new(t.path) }.should raise_error(Gitolite::Config::ParseError)
+
+        t.unlink
+      end
+
+      it 'should raise a ParseError when a Gitweb description is specified for a group' do
+        t = Tempfile.new('bad_conf.conf')
+        t.write('@gitolite "Bob Zilla" = "Test description"')
+        t.close
+
+        lambda { Gitolite::Config.new(t.path) }.should raise_error(Gitolite::Config::ParseError)
+
+        t.unlink
+      end
+    end
+  end
+
+  describe "#init" do
+    it 'should create a valid, blank Gitolite::Config' do
+      c = Gitolite::Config.init
+
+      c.should be_an_instance_of Gitolite::Config
+      c.repos.should_not be nil
+      c.repos.length.should be 0
+      c.groups.should_not be nil
+      c.groups.length.should be 0
+      c.filename.should == "gitolite.conf"
+    end
+
+    it 'should create a valid, blank Gitolite::Config with the given filename' do
+      filename = "test.conf"
+      c = Gitolite::Config.init(filename)
+
+      c.should be_an_instance_of Gitolite::Config
+      c.repos.should_not be nil
+      c.repos.length.should be 0
+      c.groups.should_not be nil
+      c.groups.length.should be 0
+      c.filename.should == filename
+    end
+  end
+
+  describe "repo management" do
+    before :each do
+      @config = Gitolite::Config.new(File.join(conf_dir, 'complicated.conf'))
+    end
+
+    describe "#get_repo" do
+      it 'should fetch a repo by a string containing the name' do
+        @config.get_repo('gitolite').should be_an_instance_of Gitolite::Config::Repo
+      end
+
+      it 'should fetch a repo via a symbol representing the name' do
+        @config.get_repo(:gitolite).should be_an_instance_of Gitolite::Config::Repo
+      end
+
+      it 'should return nil for a repo that does not exist' do
+        @config.get_repo(:glite).should be nil
+      end
+    end
+
+    describe "#has_repo?" do
+      it 'should return false for a repo that does not exist' do
+        @config.has_repo?(:glite).should be false
+      end
+
+      it 'should check for the existance of a repo given a repo object' do
+        r = @config.repos["gitolite"]
+        @config.has_repo?(r).should be true
+      end
+
+      it 'should check for the existance of a repo given a string containing the name' do
+        @config.has_repo?('gitolite').should be true
+      end
+
+      it 'should check for the existance of a repo given a symbol representing the name' do
+        @config.has_repo?(:gitolite).should be true
+      end
+    end
+
+    describe "#add_repo" do
+      it 'should throw an ArgumentError for non-Gitolite::Config::Repo objects passed in' do
+        lambda{ @config.add_repo("not-a-repo") }.should raise_error(ArgumentError)
+      end
+
+      it 'should add a given repo to the list of repos' do
+        r = Gitolite::Config::Repo.new('cool_repo')
+        nrepos = @config.repos.size
+        @config.add_repo(r)
+
+        @config.repos.size.should == nrepos + 1
+        @config.has_repo?(:cool_repo).should be true
+      end
+
+      it 'should merge a given repo with an existing repo' do
+        #Make two new repos
+        repo1 = Gitolite::Config::Repo.new('cool_repo')
+        repo2 = Gitolite::Config::Repo.new('cool_repo')
+
+        #Add some perms to those repos
+        repo1.add_permission("RW+", "", "bob", "joe", "sam")
+        repo1.add_permission("R", "", "sue", "jen", "greg")
+        repo1.add_permission("-", "refs/tags/test[0-9]", "@students", "jessica")
+        repo1.add_permission("RW", "refs/tags/test[0-9]", "@teachers", "bill", "todd")
+        repo1.add_permission("R", "refs/tags/test[0-9]", "@profs")
+
+        repo2.add_permission("RW+", "", "jim", "cynthia", "arnold")
+        repo2.add_permission("R", "", "daniel", "mary", "ben")
+        repo2.add_permission("-", "refs/tags/test[0-9]", "@more_students", "stephanie")
+        repo2.add_permission("RW", "refs/tags/test[0-9]", "@student_teachers", "mike", "judy")
+        repo2.add_permission("R", "refs/tags/test[0-9]", "@leaders")
+
+        #Add the repos
+        @config.add_repo(repo1)
+        @config.add_repo(repo2)
+
+        #Make sure perms were properly merged
+      end
+
+      it 'should overwrite an existing repo when overwrite = true' do
+        #Make two new repos
+        repo1 = Gitolite::Config::Repo.new('cool_repo')
+        repo2 = Gitolite::Config::Repo.new('cool_repo')
+
+        #Add some perms to those repos
+        repo1.add_permission("RW+", "", "bob", "joe", "sam")
+        repo1.add_permission("R", "", "sue", "jen", "greg")
+        repo2.add_permission("RW+", "", "jim", "cynthia", "arnold")
+        repo2.add_permission("R", "", "daniel", "mary", "ben")
+
+        #Add the repos
+        @config.add_repo(repo1)
+        @config.add_repo(repo2, true)
+
+        #Make sure repo2 overwrote repo1
+      end
+    end
+
+    describe "#rm_repo" do
+      it 'should remove a repo for the Gitolite::Config::Repo object given' do
+        r = @config.get_repo(:gitolite)
+        r2 = @config.rm_repo(r)
+        r2.name.should == r.name
+        r2.permissions.length.should == r.permissions.length
+        r2.owner.should == r.owner
+        r2.description.should == r.description
+      end
+
+      it 'should remove a repo given a string containing the name' do
+        r = @config.get_repo(:gitolite)
+        r2 = @config.rm_repo('gitolite')
+        r2.name.should == r.name
+        r2.permissions.length.should == r.permissions.length
+        r2.owner.should == r.owner
+        r2.description.should == r.description
+      end
+
+      it 'should remove a repo given a symbol representing the name' do
+        r = @config.get_repo(:gitolite)
+        r2 = @config.rm_repo(:gitolite)
+        r2.name.should == r.name
+        r2.permissions.length.should == r.permissions.length
+        r2.owner.should == r.owner
+        r2.description.should == r.description
+      end
+    end
+  end
+
+  describe "group management" do
+    before :each do
+      @config = Gitolite::Config.new(File.join(conf_dir, 'complicated.conf'))
+    end
+
+    describe "#has_group?" do
+      it 'should find the staff group using a symbol' do
+        @config.has_group?(:staff).should be true
+      end
+
+      it 'should find the staff group using a string' do
+       @config.has_group?('staff').should be true
+      end
+
+      it 'should find the staff group using a Gitolite::Config::Group object' do
+        g = Gitolite::Config::Group.new("staff")
+        @config.has_group?(g).should be true
+      end
+    end
+
+    describe "#get_group" do
+      it 'should return the Gitolite::Config::Group object for the group name String' do
+        g = @config.get_group("staff")
+        g.is_a?(Gitolite::Config::Group).should be true
+        g.size.should == 6
+      end
+
+      it 'should return the Gitolite::Config::Group object for the group name Symbol' do
+        g = @config.get_group(:staff)
+        g.is_a?(Gitolite::Config::Group).should be true
+        g.size.should == 6
+      end
+    end
+
+    describe "#add_group" do
+      it 'should throw an ArgumentError for non-Gitolite::Config::Group objects passed in' do
+        lambda{ @config.add_group("not-a-group") }.should raise_error(ArgumentError)
+      end
+
+      it 'should add a given group to the groups list' do
+        g = Gitolite::Config::Group.new('cool_group')
+        ngroups = @config.groups.size
+        @config.add_group(g)
+        @config.groups.size.should be ngroups + 1
+        @config.has_group?(:cool_group).should be true
+      end
+
+    end
+
+    describe "#rm_group" do
+      it 'should remove a group for the Gitolite::Config::Group object given' do
+        g = @config.get_group(:oss_repos)
+        g2 = @config.rm_group(g)
+        g.should_not be nil
+        g2.name.should == g.name
+      end
+
+      it 'should remove a group given a string containing the name' do
+        g = @config.get_group(:oss_repos)
+        g2 = @config.rm_group('oss_repos')
+        g2.name.should == g.name
+      end
+
+      it 'should remove a group given a symbol representing the name' do
+        g = @config.get_group(:oss_repos)
+        g2 = @config.rm_group(:oss_repos)
+        g2.name.should == g.name
+      end
+    end
+
+  end
+
+  describe "#to_file" do
+    it 'should create a file at the given path with the config\'s file name' do
+      c = Gitolite::Config.init
+      file = c.to_file('/tmp')
+      File.file?(File.join('/tmp', c.filename)).should be true
+      File.unlink(file)
+    end
+
+    it 'should create a file at the given path when a different filename is specified' do
+      filename = "test.conf"
+      c = Gitolite::Config.init
+      c.filename = filename
+      file = c.to_file('/tmp')
+      File.file?(File.join('/tmp', filename)).should be true
+      File.unlink(file)
+    end
+
+    it 'should raise an ArgumentError when an invalid path is specified' do
+      c = Gitolite::Config.init
+      lambda { c.to_file('/does/not/exist') }.should raise_error(ArgumentError)
+    end
+
+    it 'should raise an ArgumentError when a filename is specified in the path' do
+      c = Gitolite::Config.init
+      lambda{ c.to_file('/home/test.rb') }.should raise_error(ArgumentError)
+    end
+
+    it 'should resolve group dependencies such that all groups are defined before they are used' do
+      c = Gitolite::Config.init
+      c.filename = "test_deptree.conf"
+
+      # Build some groups out of order
+      g = Gitolite::Config::Group.new "groupa"
+      g.add_users "bob", "@groupb"
+      c.add_group(g)
+
+      g = Gitolite::Config::Group.new "groupb"
+      g.add_users "joe", "sam", "susan", "andrew"
+      c.add_group(g)
+
+      g = Gitolite::Config::Group.new "groupc"
+      g.add_users "jane", "@groupb", "brandon"
+      c.add_group(g)
+
+      g = Gitolite::Config::Group.new "groupd"
+      g.add_users "larry", "@groupc"
+      c.add_group(g)
+
+      # Write the config to a file
+      file = c.to_file('/tmp')
+
+      # Read the conf and make sure our order is correct
+      f = File.read(file)
+      lines = f.lines.map {|l| l.strip}
+
+      # Compare the file lines.  Spacing is important here since we are doing a direct comparision
+      lines[0].should == "@groupb             = andrew joe sam susan"
+      lines[1].should == "@groupc             = @groupb brandon jane"
+      lines[2].should == "@groupd             = @groupc larry"
+      lines[3].should == "@groupa             = @groupb bob"
+
+      # Cleanup
+      File.unlink(file)
+    end
+
+    it 'should raise a GroupDependencyError if there is a cyclic dependency' do
+      c = Gitolite::Config.init
+      c.filename = "test_deptree.conf"
+
+      # Build some groups out of order
+      g = Gitolite::Config::Group.new "groupa"
+      g.add_users "bob", "@groupb"
+      c.add_group(g)
+
+      g = Gitolite::Config::Group.new "groupb"
+      g.add_users "joe", "sam", "susan", "@groupc"
+      c.add_group(g)
+
+      g = Gitolite::Config::Group.new "groupc"
+      g.add_users "jane", "@groupa", "brandon"
+      c.add_group(g)
+
+      g = Gitolite::Config::Group.new "groupd"
+      g.add_users "larry", "@groupc"
+      c.add_group(g)
+
+      # Attempt to write the config file
+      lambda{ c.to_file('/tmp')}.should raise_error(Gitolite::Config::GroupDependencyError)
+    end
+
+    it 'should resolve group dependencies even when there are disconnected portions of the graph' do
+      c = Gitolite::Config.init
+      c.filename = "test_deptree.conf"
+
+      # Build some groups out of order
+      g = Gitolite::Config::Group.new "groupa"
+      g.add_users "bob", "timmy", "stephanie"
+      c.add_group(g)
+
+      g = Gitolite::Config::Group.new "groupb"
+      g.add_users "joe", "sam", "susan", "andrew"
+      c.add_group(g)
+
+      g = Gitolite::Config::Group.new "groupc"
+      g.add_users "jane", "earl", "brandon", "@groupa"
+      c.add_group(g)
+
+      g = Gitolite::Config::Group.new "groupd"
+      g.add_users "larry", "chris", "emily"
+      c.add_group(g)
+
+      # Write the config to a file
+      file = c.to_file('/tmp')
+
+      # Read the conf and make sure our order is correct
+      f = File.read(file)
+      lines = f.lines.map {|l| l.strip}
+
+      # Compare the file lines.  Spacing is important here since we are doing a direct comparision
+      lines[0].should == "@groupd             = chris emily larry"
+      lines[1].should == "@groupb             = andrew joe sam susan"
+      lines[2].should == "@groupa             = bob stephanie timmy"
+      lines[3].should == "@groupc             = @groupa brandon earl jane"
+
+      # Cleanup
+      File.unlink(file)
+    end
+  end
+
+  describe "#cleanup_config_line" do
+    before(:each) do
+      @config = Gitolite::Config.init
+    end
+
+    it 'should remove comments' do
+      s = "#comment"
+      @config.instance_eval { cleanup_config_line(s) }.empty?.should == true
+    end
+
+    it 'should remove inline comments, keeping content before the comment' do
+      s = "blablabla #comment"
+      @config.instance_eval { cleanup_config_line(s) }.should == "blablabla"
+    end
+
+    it 'should pad = with spaces on each side' do
+      s = "bob=joe"
+      @config.instance_eval { cleanup_config_line(s) }.should == "bob = joe"
+    end
+
+    it 'should replace multiple space characters with a single space' do
+      s = "bob       =        joe"
+      @config.instance_eval { cleanup_config_line(s) }.should == "bob = joe"
+    end
+
+    it 'should cleanup whitespace at the beginning and end of lines' do
+      s = "            bob = joe            "
+      @config.instance_eval { cleanup_config_line(s) }.should == "bob = joe"
+    end
+
+    it 'should cleanup whitespace and comments effectively' do
+      s = "            bob     =     joe             #comment"
+      @config.instance_eval { cleanup_config_line(s) }.should == "bob = joe"
+    end
+  end
+end