jro_apps/redmine Commit - r9692:3b854bee5921

Make repository identifier accept underscores (#11192)....

Jean-Philippe Lang -

r9692:3b854bee5921

parent child

Context file:

r9692:3b854bee5921

Collapse all files

app/models/repository.rb +2 -2

              # Redmine - project management software
              # Copyright (C) 2006-2012  Jean-Philippe Lang
              #
              # This program is free software; you can redistribute it and/or
              # modify it under the terms of the GNU General Public License
              # as published by the Free Software Foundation; either version 2
              # of the License, or (at your option) any later version.
              #
              # This program is distributed in the hope that it will be useful,
              # but WITHOUT ANY WARRANTY; without even the implied warranty of
              # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
              # GNU General Public License for more details.
              #
              # You should have received a copy of the GNU General Public License
              # along with this program; if not, write to the Free Software
              # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
              class ScmFetchError < Exception; end
              class Repository < ActiveRecord::Base
                include Redmine::Ciphering
                belongs_to :project
                has_many :changesets, :order => "#{Changeset.table_name}.committed_on DESC, #{Changeset.table_name}.id DESC"
                has_many :filechanges, :class_name => 'Change', :through => :changesets
                serialize :extra_info
                before_save :check_default
                # Raw SQL to delete changesets and changes in the database
                # has_many :changesets, :dependent => :destroy is too slow for big repositories
                before_destroy :clear_changesets
                validates_length_of :password, :maximum => 255, :allow_nil => true
                validates_length_of :identifier, :maximum => 255, :allow_blank => true
                validates_presence_of :identifier, :unless => Proc.new { |r| r.is_default? || r.set_as_default? }
                validates_uniqueness_of :identifier, :scope => :project_id, :allow_blank => true
                validates_exclusion_of :identifier, :in => %w(show entry raw changes annotate diff show stats graph)
-               # donwcase letters, digits, dashes but not digits only
-               validates_format_of :identifier, :with => /^(?!\d+$)[a-z0-9\-]*$/, :allow_blank => true
+               # donwcase letters, digits, dashes, underscores but not digits only
+               validates_format_of :identifier, :with => /^(?!\d+$)[a-z0-9\-_]*$/, :allow_blank => true
                # Checks if the SCM is enabled when creating a repository
                validate :repo_create_validation, :on => :create
                def repo_create_validation
                  unless Setting.enabled_scm.include?(self.class.name.demodulize)
                    errors.add(:type, :invalid)
                  end
                end
                def self.human_attribute_name(attribute_key_name, *args)
                  attr_name = attribute_key_name.to_s
                  if attr_name == "log_encoding"
                    attr_name = "commit_logs_encoding"
                  end
                  super(attr_name, *args)
                end
                # Removes leading and trailing whitespace
                def url=(arg)
                  write_attribute(:url, arg ? arg.to_s.strip : nil)
                end
                # Removes leading and trailing whitespace
                def root_url=(arg)
                  write_attribute(:root_url, arg ? arg.to_s.strip : nil)
                end
                def password
                  read_ciphered_attribute(:password)
                end
                def password=(arg)
                  write_ciphered_attribute(:password, arg)
                end
                def scm_adapter
                  self.class.scm_adapter_class
                end
                def scm
                  unless @scm
                    @scm = self.scm_adapter.new(url, root_url,
                                                login, password, path_encoding)
                    if root_url.blank? && @scm.root_url.present?
                      update_attribute(:root_url, @scm.root_url)
                    end
                  end
                  @scm
                end
                def scm_name
                  self.class.scm_name
                end
                def name
                  if identifier.present?
                    identifier
                  elsif is_default?
                    l(:field_repository_is_default)
                  else
                    scm_name
                  end
                end
                def identifier_param
                  if is_default?
                    nil
                  elsif identifier.present?
                    identifier
                  else
                    id.to_s
                  end
                end
                def <=>(repository)
                  if is_default?
                    -1
                  elsif repository.is_default?
 
                  else
                    identifier.to_s <=> repository.identifier.to_s
                  end
                end
                def self.find_by_identifier_param(param)
                  if param.to_s =~ /^\d+$/
                    find_by_id(param)
                  else
                    find_by_identifier(param)
                  end
                end
                def merge_extra_info(arg)
                  h = extra_info || {}
                  return h if arg.nil?
                  h.merge!(arg)
                  write_attribute(:extra_info, h)
                end
                def report_last_commit
                  true
                end
                def supports_cat?
                  scm.supports_cat?
                end
                def supports_annotate?
                  scm.supports_annotate?
                end
                def supports_all_revisions?
                  true
                end
                def supports_directory_revisions?
                  false
                end
                def supports_revision_graph?
                  false
                end
                def entry(path=nil, identifier=nil)
                  scm.entry(path, identifier)
                end
                def entries(path=nil, identifier=nil)
                  entries = scm.entries(path, identifier)
                  load_entries_changesets(entries)
                  entries
                end
                def branches
                  scm.branches
                end
                def tags
                  scm.tags
                end
                def default_branch
                  nil
                end
                def properties(path, identifier=nil)
                  scm.properties(path, identifier)
                end
                def cat(path, identifier=nil)
                  scm.cat(path, identifier)
                end
                def diff(path, rev, rev_to)
                  scm.diff(path, rev, rev_to)
                end
                def diff_format_revisions(cs, cs_to, sep=':')
                  text = ""
                  text << cs_to.format_identifier + sep if cs_to
                  text << cs.format_identifier if cs
                  text
                end
                # Returns a path relative to the url of the repository
                def relative_path(path)
                  path
                end
                # Finds and returns a revision with a number or the beginning of a hash
                def find_changeset_by_name(name)
                  return nil if name.blank?
                  s = name.to_s
                  changesets.find(:first, :conditions => (s.match(/^\d*$/) ?
                        ["revision = ?", s] : ["revision LIKE ?", s + '%']))
                end
                def latest_changeset
                  @latest_changeset ||= changesets.find(:first)
                end
                # Returns the latest changesets for +path+
                # Default behaviour is to search in cached changesets
                def latest_changesets(path, rev, limit=10)
                  if path.blank?
                    changesets.find(
                       :all,
                       :include => :user,
                       :order => "#{Changeset.table_name}.committed_on DESC, #{Changeset.table_name}.id DESC",
                       :limit => limit)
                  else
                    filechanges.find(
                       :all,
                       :include => {:changeset => :user},
                       :conditions => ["path = ?", path.with_leading_slash],
                       :order => "#{Changeset.table_name}.committed_on DESC, #{Changeset.table_name}.id DESC",
                       :limit => limit
                     ).collect(&:changeset)
                  end
                end
                def scan_changesets_for_issue_ids
                  self.changesets.each(&:scan_comment_for_issue_ids)
                end
                # Returns an array of committers usernames and associated user_id
                def committers
                  @committers ||= Changeset.connection.select_rows(
                       "SELECT DISTINCT committer, user_id FROM #{Changeset.table_name} WHERE repository_id = #{id}")
                end
                # Maps committers username to a user ids
                def committer_ids=(h)
                  if h.is_a?(Hash)
                    committers.each do |committer, user_id|
                      new_user_id = h[committer]
                      if new_user_id && (new_user_id.to_i != user_id.to_i)
                        new_user_id = (new_user_id.to_i > 0 ? new_user_id.to_i : nil)
                        Changeset.update_all(
                             "user_id = #{ new_user_id.nil? ? 'NULL' : new_user_id }",
                             ["repository_id = ? AND committer = ?", id, committer])
                      end
                    end
                    @committers            = nil
                    @found_committer_users = nil
                    true
                  else
                    false
                  end
                end
                # Returns the Redmine User corresponding to the given +committer+
                # It will return nil if the committer is not yet mapped and if no User
                # with the same username or email was found
                def find_committer_user(committer)
                  unless committer.blank?
                    @found_committer_users ||= {}
                    return @found_committer_users[committer] if @found_committer_users.has_key?(committer)
                    user = nil
                    c = changesets.find(:first, :conditions => {:committer => committer}, :include => :user)
                    if c && c.user
                      user = c.user
                    elsif committer.strip =~ /^([^<]+)(<(.*)>)?$/
                      username, email = $1.strip, $3
                      u = User.find_by_login(username)
                      u ||= User.find_by_mail(email) unless email.blank?
                      user = u
                    end
                    @found_committer_users[committer] = user
                    user
                  end
                end
                def repo_log_encoding
                  encoding = log_encoding.to_s.strip
                  encoding.blank? ? 'UTF-8' : encoding
                end
                # Fetches new changesets for all repositories of active projects
                # Can be called periodically by an external script
                # eg. ruby script/runner "Repository.fetch_changesets"
                def self.fetch_changesets
                  Project.active.has_module(:repository).all.each do |project|
                    project.repositories.each do |repository|
                      begin
                        repository.fetch_changesets
                      rescue Redmine::Scm::Adapters::CommandFailed => e
                        logger.error "scm: error during fetching changesets: #{e.message}"
                      end
                    end
                  end
                end
                # scan changeset comments to find related and fixed issues for all repositories
                def self.scan_changesets_for_issue_ids
                  find(:all).each(&:scan_changesets_for_issue_ids)
                end
                def self.scm_name
                  'Abstract'
                end
                def self.available_scm
                  subclasses.collect {|klass| [klass.scm_name, klass.name]}
                end
                def self.factory(klass_name, *args)
                  klass = "Repository::#{klass_name}".constantize
                  klass.new(*args)
                rescue
                  nil
                end
                def self.scm_adapter_class
                  nil
                end
                def self.scm_command
                  ret = ""
                  begin
                    ret = self.scm_adapter_class.client_command if self.scm_adapter_class
                  rescue Exception => e
                    logger.error "scm: error during get command: #{e.message}"
                  end
                  ret
                end
                def self.scm_version_string
                  ret = ""
                  begin
                    ret = self.scm_adapter_class.client_version_string if self.scm_adapter_class
                  rescue Exception => e
                    logger.error "scm: error during get version string: #{e.message}"
                  end
                  ret
                end
                def self.scm_available
                  ret = false
                  begin
                    ret = self.scm_adapter_class.client_available if self.scm_adapter_class
                  rescue Exception => e
                    logger.error "scm: error during get scm available: #{e.message}"
                  end
                  ret
                end
                def set_as_default?
                  new_record? && project && !Repository.first(:conditions => {:project_id => project.id})
                end
                protected
                def check_default
                  if !is_default? && set_as_default?
                    self.is_default = true
                  end
                  if is_default? && is_default_changed?
                    Repository.update_all(["is_default = ?", false], ["project_id = ?", project_id])
                  end
                end
                def load_entries_changesets(entries)
                  if entries
                    entries.each do |entry|
                      if entry.lastrev && entry.lastrev.identifier
                        entry.changeset = find_changeset_by_name(entry.lastrev.identifier)
                      end
                    end
                  end
                end
                private
                # Deletes repository data
                def clear_changesets
                  cs = Changeset.table_name
                  ch = Change.table_name
                  ci = "#{table_name_prefix}changesets_issues#{table_name_suffix}"
                  cp = "#{table_name_prefix}changeset_parents#{table_name_suffix}"
                  connection.delete("DELETE FROM #{ch} WHERE #{ch}.changeset_id IN (SELECT #{cs}.id FROM #{cs} WHERE #{cs}.repository_id = #{id})")
                  connection.delete("DELETE FROM #{ci} WHERE #{ci}.changeset_id IN (SELECT #{cs}.id FROM #{cs} WHERE #{cs}.repository_id = #{id})")
                  connection.delete("DELETE FROM #{cp} WHERE #{cp}.changeset_id IN (SELECT #{cs}.id FROM #{cs} WHERE #{cs}.repository_id = #{id})")
                  connection.delete("DELETE FROM #{cs} WHERE #{cs}.repository_id = #{id}")
                end
              end

test/unit/repository_test.rb +9 0

              # Redmine - project management software
              # Copyright (C) 2006-2012  Jean-Philippe Lang
              #
              # This program is free software; you can redistribute it and/or
              # modify it under the terms of the GNU General Public License
              # as published by the Free Software Foundation; either version 2
              # of the License, or (at your option) any later version.
              #
              # This program is distributed in the hope that it will be useful,
              # but WITHOUT ANY WARRANTY; without even the implied warranty of
              # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
              # GNU General Public License for more details.
              #
              # You should have received a copy of the GNU General Public License
              # along with this program; if not, write to the Free Software
              # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
              require File.expand_path('../../test_helper', __FILE__)
              class RepositoryTest < ActiveSupport::TestCase
                fixtures :projects,
                         :trackers,
                         :projects_trackers,
                         :enabled_modules,
                         :repositories,
                         :issues,
                         :issue_statuses,
                         :issue_categories,
                         :changesets,
                         :changes,
                         :users,
                         :members,
                         :member_roles,
                         :roles,
                         :enumerations
                include Redmine::I18n
                def setup
                  @repository = Project.find(1).repository
                end
                def test_blank_log_encoding_error_message
                  set_language_if_valid 'en'
                  repo = Repository::Bazaar.new(
                                      :project      => Project.find(3),
                                      :url          => "/test",
                                      :log_encoding => ''
                                    )
                  assert !repo.save
                  assert_include "Commit messages encoding can't be blank",
                                 repo.errors.full_messages
                end
                def test_blank_log_encoding_error_message_fr
                  set_language_if_valid 'fr'
                  str = "Encodage des messages de commit doit \xc3\xaatre renseign\xc3\xa9(e)"
                  str.force_encoding('UTF-8') if str.respond_to?(:force_encoding)
                  repo = Repository::Bazaar.new(
                                      :project      => Project.find(3),
                                      :url          => "/test"
                                    )
                  assert !repo.save
                  assert_include str, repo.errors.full_messages
                end
                def test_create
                  repository = Repository::Subversion.new(:project => Project.find(3))
                  assert !repository.save
                  repository.url = "svn://localhost"
                  assert repository.save
                  repository.reload
                  project = Project.find(3)
                  assert_equal repository, project.repository
                end
                def test_first_repository_should_be_set_as_default
                  repository1 = Repository::Subversion.new(
                                    :project => Project.find(3),
                                    :identifier => 'svn1',
                                    :url => 'file:///svn1'
                                  )
                  assert repository1.save
                  assert repository1.is_default?
                  repository2 = Repository::Subversion.new(
                                    :project => Project.find(3),
                                    :identifier => 'svn2',
                                    :url => 'file:///svn2'
                                  )
                  assert repository2.save
                  assert !repository2.is_default?
                  assert_equal repository1, Project.find(3).repository
                  assert_equal [repository1, repository2], Project.find(3).repositories.sort
                end
+               def test_identifier_should_accept_letters_digits_dashes_and_underscores
+                 r = Repository::Subversion.new(
+                   :project_id => 3,
+                   :identifier => 'svn-123_45',
+                   :url => 'file:///svn'
+                 )
+                 assert r.save
+               end
                def test_destroy
                  repository = Repository.find(10)
                  changesets = repository.changesets.count
                  changes = repository.filechanges.count
                  assert_difference 'Changeset.count', -changesets do
                    assert_difference 'Change.count', -changes do
                      Repository.find(10).destroy
                    end
                  end
                end
                def test_destroy_should_delete_parents_associations
                  changeset = Changeset.find(102)
                  changeset.parents = Changeset.find_all_by_id([100, 101])
                  assert_difference 'Changeset.connection.select_all("select * from changeset_parents").size', -2 do
                    Repository.find(10).destroy
                  end
                end
                def test_destroy_should_delete_issues_associations
                  changeset = Changeset.find(102)
                  changeset.issues = Issue.find_all_by_id([1, 2])
                  assert_difference 'Changeset.connection.select_all("select * from changesets_issues").size', -2 do
                    Repository.find(10).destroy
                  end
                end
                def test_should_not_create_with_disabled_scm
                  # disable Subversion
                  with_settings :enabled_scm => ['Darcs', 'Git'] do
                    repository = Repository::Subversion.new(
                                    :project => Project.find(3), :url => "svn://localhost")
                    assert !repository.save
                    assert_include I18n.translate('activerecord.errors.messages.invalid'),
                                   repository.errors[:type]
                  end
                end
                def test_scan_changesets_for_issue_ids
                  Setting.default_language = 'en'
                  Setting.notified_events = ['issue_added','issue_updated']
                  # choosing a status to apply to fix issues
                  Setting.commit_fix_status_id = IssueStatus.find(
                                                   :first,
                                                   :conditions => ["is_closed = ?", true]).id
                  Setting.commit_fix_done_ratio = "90"
                  Setting.commit_ref_keywords = 'refs , references, IssueID'
                  Setting.commit_fix_keywords = 'fixes , closes'
                  Setting.default_language = 'en'
                  ActionMailer::Base.deliveries.clear
                  # make sure issue 1 is not already closed
                  fixed_issue = Issue.find(1)
                  assert !fixed_issue.status.is_closed?
                  old_status = fixed_issue.status
                  Repository.scan_changesets_for_issue_ids
                  assert_equal [101, 102], Issue.find(3).changeset_ids
                  # fixed issues
                  fixed_issue.reload
                  assert fixed_issue.status.is_closed?
                  assert_equal 90, fixed_issue.done_ratio
                  assert_equal [101], fixed_issue.changeset_ids
                  # issue change
                  journal = fixed_issue.journals.find(:first, :order => 'created_on desc')
                  assert_equal User.find_by_login('dlopper'), journal.user
                  assert_equal 'Applied in changeset r2.', journal.notes
                  # 2 email notifications
                  assert_equal 2, ActionMailer::Base.deliveries.size
                  mail = ActionMailer::Base.deliveries.first
                  assert_not_nil mail
                  assert mail.subject.starts_with?(
                      "[#{fixed_issue.project.name} - #{fixed_issue.tracker.name} ##{fixed_issue.id}]")
                  assert_mail_body_match(
                      "Status changed from #{old_status} to #{fixed_issue.status}", mail)
                  # ignoring commits referencing an issue of another project
                  assert_equal [], Issue.find(4).changesets
                end
                def test_for_changeset_comments_strip
                  repository = Repository::Mercurial.create(
                                  :project => Project.find( 4 ),
                                  :url => '/foo/bar/baz' )
                  comment = <<-COMMENT
                  This is a loooooooooooooooooooooooooooong comment
                  COMMENT
                  changeset = Changeset.new(
                    :comments => comment, :commit_date => Time.now,
                    :revision => 0, :scmid => 'f39b7922fb3c',
                    :committer => 'foo <foo@example.com>',
                    :committed_on => Time.now, :repository => repository )
                  assert( changeset.save )
                  assert_not_equal( comment, changeset.comments )
                  assert_equal( 'This is a loooooooooooooooooooooooooooong comment',
                                changeset.comments )
                end
                def test_for_urls_strip_cvs
                  repository = Repository::Cvs.create(
                      :project => Project.find(4),
                      :url => ' :pserver:login:password@host:/path/to/the/repository',
                      :root_url => 'foo  ',
                      :log_encoding => 'UTF-8')
                  assert repository.save
                  repository.reload
                  assert_equal ':pserver:login:password@host:/path/to/the/repository',
                                repository.url
                  assert_equal 'foo', repository.root_url
                end
                def test_for_urls_strip_subversion
                  repository = Repository::Subversion.create(
                      :project => Project.find(4),
                      :url => ' file:///dummy   ')
                  assert repository.save
                  repository.reload
                  assert_equal 'file:///dummy', repository.url
                end
                def test_for_urls_strip_git
                  repository = Repository::Git.create(
                      :project => Project.find(4),
                      :url => ' c:\dummy   ')
                  assert repository.save
                  repository.reload
                  assert_equal 'c:\dummy', repository.url
                end
                def test_manual_user_mapping
                  assert_no_difference "Changeset.count(:conditions => 'user_id <> 2')" do
                    c = Changeset.create!(
                            :repository => @repository,
                            :committer => 'foo',
                            :committed_on => Time.now,
                            :revision => 100,
                            :comments => 'Committed by foo.'
                          )
                    assert_nil c.user
                    @repository.committer_ids = {'foo' => '2'}
                    assert_equal User.find(2), c.reload.user
                    # committer is now mapped
                    c = Changeset.create!(
                            :repository => @repository,
                            :committer => 'foo',
                            :committed_on => Time.now,
                            :revision => 101,
                            :comments => 'Another commit by foo.'
                          )
                    assert_equal User.find(2), c.user
                  end
                end
                def test_auto_user_mapping_by_username
                  c = Changeset.create!(
                        :repository   => @repository,
                        :committer    => 'jsmith',
                        :committed_on => Time.now,
                        :revision     => 100,
                        :comments     => 'Committed by john.'
                      )
                  assert_equal User.find(2), c.user
                end
                def test_auto_user_mapping_by_email
                  c = Changeset.create!(
                        :repository   => @repository,
                        :committer    => 'john <jsmith@somenet.foo>',
                        :committed_on => Time.now,
                        :revision     => 100,
                        :comments     => 'Committed by john.'
                      )
                  assert_equal User.find(2), c.user
                end
                def test_filesystem_avaialbe
                  klass = Repository::Filesystem
                  assert klass.scm_adapter_class
                  assert_equal true, klass.scm_available
                end
                def test_merge_extra_info
                  repo = Repository::Subversion.new(:project => Project.find(3))
                  assert !repo.save
                  repo.url = "svn://localhost"
                  assert repo.save
                  repo.reload
                  project = Project.find(3)
                  assert_equal repo, project.repository
                  assert_nil repo.extra_info
                  h1 = {"test_1" => {"test_11" => "test_value_11"}}
                  repo.merge_extra_info(h1)
                  assert_equal h1, repo.extra_info
                  h2 = {"test_2" => {
                                 "test_21" => "test_value_21",
                                 "test_22" => "test_value_22",
                                }}
                  repo.merge_extra_info(h2)
                  assert_equal (h = {"test_11" => "test_value_11"}),
                               repo.extra_info["test_1"]
                  assert_equal "test_value_21",
                               repo.extra_info["test_2"]["test_21"]
                  h3 = {"test_2" => {
                                 "test_23" => "test_value_23",
                                 "test_24" => "test_value_24",
                                }}
                  repo.merge_extra_info(h3)
                  assert_equal (h = {"test_11" => "test_value_11"}),
                               repo.extra_info["test_1"]
                  assert_nil repo.extra_info["test_2"]["test_21"]
                  assert_equal "test_value_23",
                               repo.extra_info["test_2"]["test_23"]
                end
                def test_sort_should_not_raise_an_error_with_nil_identifiers
                  r1 = Repository.new
                  r2 = Repository.new
                  assert_nothing_raised do
                    [r1, r2].sort
                  end
                end
              end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages