From a1e2f63e64875a29e8c01a7ae17f5744680167a5 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Mon, 15 Nov 2010 11:37:14 +0100 Subject: submodule: Fleshed out interface, and a partial test which is not yet usable. It showed that the ConfigParser needs some work. If the root is set, it also needs to refer to the root_commit instead of to the root-tree, as it will have to decide whether it works on the working tree's version of the .gitmodules file or the one in the repository --- lib/git/objects/submodule.py | 115 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 112 insertions(+), 3 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 1f571a48..b0fd0e35 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -1,4 +1,8 @@ import base +from cStringIO import StringIO +from git.config import GitConfigParser +from git.util import join_path_native +from git.exc import InvalidGitRepositoryError, NoSuchPathError __all__ = ("Submodule", ) @@ -7,10 +11,115 @@ class Submodule(base.IndexObject): represents a commit in the submodule's repository which is to be checked out at the path of this instance. The submodule type does not have a string type associated with it, as it exists - solely as a marker in the tree and index""" + solely as a marker in the tree and index. + + All methods work in bare and non-bare repositories.""" + + kModulesFile = '.gitmodules' # this is a bogus type for base class compatability type = 'submodule' - # TODO: Add functions to retrieve a repo for the submodule, to allow - # its initiailization and handling + __slots__ = ('_root_tree', '_url', '_ref') + + def _set_cache_(self, attr): + if attr == 'size': + raise ValueError("Submodules do not have a size as they do not refer to anything in this repository") + elif attr == '_root_tree': + # set a default value, which is the root tree of the current head + self._root_tree = self.repo.tree() + elif attr in ('path', '_url', '_ref'): + reader = self.config_reader() + # default submodule values + self._path = reader.get_value('path') + self._url = reader.get_value('url') + # git-python extension values - optional + self._ref = reader.get_value('ref', 'master') + else: + super(Submodule, self)._set_cache_(attr) + # END handle attribute name + + def _fp_config(self): + """:return: Configuration file as StringIO - we only access it through the respective blob's data""" + return StringIO(self._root_tree[self.kModulesFile].datastream.read()) + + def _config_parser(self, read_only): + """:return: Config Parser constrained to our submodule in read or write mode""" + parser = GitConfigParser(self._fp_config(), read_only = read_only) + return SectionConstraint(parser, 'submodule "%s"' % self.path) + + #{ Edit Interface + + @classmethod + def add(cls, repo, path, url, skip_init=False): + """Add a new submodule to the given repository. This will alter the index + as well as the .gitmodules file, but will not create a new commit. + :param repo: Repository instance which should receive the submodule + :param path: repository-relative path at which the submodule should be located + It will be created as required during the repository initialization. + :param url: git-clone compatible URL, see git-clone reference for more information + :param skip_init: if True, the new repository will not be cloned to its location. + :return: The newly created submodule instance""" + + def set_root_tree(self, root_tree): + """Set this instance to use the given tree which is supposed to contain the + .gitmodules blob. + :param root_tree: Tree'ish reference pointing at the root_tree + :raise ValueError: if the root_tree didn't contain the .gitmodules blob.""" + tree = self.repo.tree(root_tree) + if self.kModulesFile not in tree: + raise ValueError("Tree %s did not contain the %s file" % (root_tree, self.kModulesFile)) + # END handle exceptions + self._root_tree = tree + + # clear the possibly changing values + del(self.path) + del(self._ref) + del(self._url) + + def config_writer(self): + """:return: a config writer instance allowing you to read and write the data + belonging to this submodule into the .gitmodules file.""" + return self._config_parser(read_only=False) + + #} END edit interface + + #{ Query Interface + + def module(self): + """:return: Repo instance initialized from the repository at our submodule path + :raise InvalidGitRepositoryError: if a repository was not available""" + if self.repo.bare: + raise InvalidGitRepositoryError("Cannot retrieve module repository in bare parent repositories") + # END handle bare mode + + repo_path = join_path_native(self.repo.working_tree_dir, self.path) + try: + return Repo(repo_path) + except (InvalidGitRepositoryError, NoSuchPathError): + raise InvalidGitRepositoryError("No valid repository at %s" % self.path) + # END handle exceptions + + def ref(self): + """:return: The reference's name that we are to checkout""" + return self._ref + + def url(self): + """:return: The url to the repository which our module-repository refers to""" + return self._url + + def root_tree(self): + """:return: Tree instance referring to the tree which contains the .gitmodules file + we are to use + :note: will always point to the current head's root tree if it was not set explicitly""" + return self._root_tree + + def config_reader(self): + """:return: ConfigReader instance which allows you to qurey the configuration values + of this submodule, as provided by the .gitmodules file + :note: The config reader will actually read the data directly from the repository + and thus does not need nor care about your working tree. + :note: Should be cached by the caller and only kept as long as needed""" + return self._config_parser.read_only(read_only=True) + + #} END query interface -- cgit v1.2.1 From 4d36f8ff4d1274a8815e932285ad6dbd6b2888af Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Mon, 15 Nov 2010 12:13:59 +0100 Subject: Improved GitConfigurationParser to better deal with streams and the corresponding locks. Submodule class now operates on parent_commits, the configuration is either streamed from the repository or written directly into a blob ( or file ) dependending on whether we have a working tree checkout or not which matches our parent_commit --- lib/git/objects/submodule.py | 70 +++++++++++++++++++++++++++++--------------- 1 file changed, 46 insertions(+), 24 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index b0fd0e35..b9bcfc07 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -6,6 +6,13 @@ from git.exc import InvalidGitRepositoryError, NoSuchPathError __all__ = ("Submodule", ) +class SubmoduleConfigParser(GitConfigParser): + """Catches calls to _write, and updates the .gitmodules blob in the index + with the new data, if we have written into a stream. Otherwise it will + add the local file to the index to make it correspond with the working tree.""" + _mutating_methods_ = tuple() + + class Submodule(base.IndexObject): """Implements access to a git submodule. They are special in that their sha represents a commit in the submodule's repository which is to be checked out @@ -20,14 +27,14 @@ class Submodule(base.IndexObject): # this is a bogus type for base class compatability type = 'submodule' - __slots__ = ('_root_tree', '_url', '_ref') + __slots__ = ('_parent_commit', '_url', '_ref') def _set_cache_(self, attr): if attr == 'size': raise ValueError("Submodules do not have a size as they do not refer to anything in this repository") - elif attr == '_root_tree': + elif attr == '_parent_commit': # set a default value, which is the root tree of the current head - self._root_tree = self.repo.tree() + self._parent_commit = self.repo.commit() elif attr in ('path', '_url', '_ref'): reader = self.config_reader() # default submodule values @@ -39,13 +46,26 @@ class Submodule(base.IndexObject): super(Submodule, self)._set_cache_(attr) # END handle attribute name - def _fp_config(self): + def _sio_modules(self): """:return: Configuration file as StringIO - we only access it through the respective blob's data""" - return StringIO(self._root_tree[self.kModulesFile].datastream.read()) + sio = StringIO(self._parent_commit.tree[self.kModulesFile].datastream.read()) + sio.name = self.kModulesFile + return sio def _config_parser(self, read_only): """:return: Config Parser constrained to our submodule in read or write mode""" - parser = GitConfigParser(self._fp_config(), read_only = read_only) + parent_matches_head = self.repo.head.commit == self._parent_commit + if not self.repo.bare and parent_matches_head: + fp_module = self.kModulesFile + else: + fp_module = self._sio_modules() + # END handle non-bare working tree + + if not read_only and not parent_matches_head: + raise ValueError("Cannot write blobs of 'historical' submodule configurations") + # END handle writes of historical submodules + + parser = GitConfigParser(fp_module, read_only = read_only) return SectionConstraint(parser, 'submodule "%s"' % self.path) #{ Edit Interface @@ -61,21 +81,24 @@ class Submodule(base.IndexObject): :param skip_init: if True, the new repository will not be cloned to its location. :return: The newly created submodule instance""" - def set_root_tree(self, root_tree): - """Set this instance to use the given tree which is supposed to contain the - .gitmodules blob. - :param root_tree: Tree'ish reference pointing at the root_tree - :raise ValueError: if the root_tree didn't contain the .gitmodules blob.""" - tree = self.repo.tree(root_tree) - if self.kModulesFile not in tree: - raise ValueError("Tree %s did not contain the %s file" % (root_tree, self.kModulesFile)) + def set_parent_commit(self, commit): + """Set this instance to use the given commit whose tree is supposed to + contain the .gitmodules blob. + :param commit: Commit'ish reference pointing at the root_tree + :raise ValueError: if the commit's tree didn't contain the .gitmodules blob.""" + pcommit = self.repo.commit(commit) + if self.kModulesFile not in pcommit.tree: + raise ValueError("Tree of commit %s did not contain the %s file" % (commit, self.kModulesFile)) # END handle exceptions - self._root_tree = tree + self._parent_commit = pcommit - # clear the possibly changing values - del(self.path) - del(self._ref) - del(self._url) + # clear the possibly changed values + for name in ('path', '_ref', '_url'): + try: + delattr(self, name) + except AttributeError: + pass + # END for each name to delete def config_writer(self): """:return: a config writer instance allowing you to read and write the data @@ -108,11 +131,10 @@ class Submodule(base.IndexObject): """:return: The url to the repository which our module-repository refers to""" return self._url - def root_tree(self): - """:return: Tree instance referring to the tree which contains the .gitmodules file - we are to use - :note: will always point to the current head's root tree if it was not set explicitly""" - return self._root_tree + def parent_commit(self): + """:return: Commit instance with the tree containing the .gitmodules file + :note: will always point to the current head's commit if it was not set explicitly""" + return self._parent_commit def config_reader(self): """:return: ConfigReader instance which allows you to qurey the configuration values -- cgit v1.2.1 From 00ce31ad308ff4c7ef874d2fa64374f47980c85c Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Mon, 15 Nov 2010 16:53:12 +0100 Subject: Objects: Constructor now manually checks and sets the input arguments to the local cache - previously a procedural approach was used, which was less code, but slower too. Especially in case of CommitObjects unrolling the loop manually makes a difference. Submodule: Implemented query methods and did a bit of testing. More is to come, but the test works for now. As special addition, the submodule implementation uses the section name as submodule ID even though it seems to be just the path. This allows to make renames easier --- lib/git/objects/submodule.py | 222 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 189 insertions(+), 33 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index b9bcfc07..1aa0cfb5 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -1,11 +1,29 @@ import base -from cStringIO import StringIO -from git.config import GitConfigParser +from StringIO import StringIO # need a dict to set bloody .name field +from git.util import Iterable +from git.config import GitConfigParser, SectionConstraint from git.util import join_path_native from git.exc import InvalidGitRepositoryError, NoSuchPathError +import os + __all__ = ("Submodule", ) +#{ Utilities + +def sm_section(path): + """:return: section title used in .gitmodules configuration file""" + return 'submodule "%s"' % path + +def sm_name(section): + """:return: name of the submodule as parsed from the section name""" + section = section.strip() + return section[11:-1] +#} END utilities + + +#{ Classes + class SubmoduleConfigParser(GitConfigParser): """Catches calls to _write, and updates the .gitmodules blob in the index with the new data, if we have written into a stream. Otherwise it will @@ -13,7 +31,7 @@ class SubmoduleConfigParser(GitConfigParser): _mutating_methods_ = tuple() -class Submodule(base.IndexObject): +class Submodule(base.IndexObject, Iterable): """Implements access to a git submodule. They are special in that their sha represents a commit in the submodule's repository which is to be checked out at the path of this instance. @@ -22,12 +40,32 @@ class Submodule(base.IndexObject): All methods work in bare and non-bare repositories.""" - kModulesFile = '.gitmodules' + _id_attribute_ = "path" + k_modules_file = '.gitmodules' + k_ref_option = 'ref' + k_ref_default = 'master' # this is a bogus type for base class compatability type = 'submodule' - __slots__ = ('_parent_commit', '_url', '_ref') + __slots__ = ('_parent_commit', '_url', '_ref', '_name') + + def __init__(self, repo, binsha, mode=None, path=None, name = None, parent_commit=None, url=None, ref=None): + """Initialize this instance with its attributes. We only document the ones + that differ from ``IndexObject`` + :param binsha: binary sha referring to a commit in the remote repository, see url parameter + :param parent_commit: see set_parent_commit() + :param url: The url to the remote repository which is the submodule + :param ref: Reference to checkout when cloning the remote repository""" + super(Submodule, self).__init__(repo, binsha, mode, path) + if parent_commit is not None: + self._parent_commit = parent_commit + if url is not None: + self._url = url + if ref is not None: + self._ref = ref + if name is not None: + self._name = name def _set_cache_(self, attr): if attr == 'size': @@ -38,35 +76,63 @@ class Submodule(base.IndexObject): elif attr in ('path', '_url', '_ref'): reader = self.config_reader() # default submodule values - self._path = reader.get_value('path') + self.path = reader.get_value('path') self._url = reader.get_value('url') # git-python extension values - optional - self._ref = reader.get_value('ref', 'master') + self._ref = reader.get_value(self.k_ref_option, self.k_ref_default) + elif attr == '_name': + raise AttributeError("Cannot retrieve the name of a submodule if it was not set initially") else: super(Submodule, self)._set_cache_(attr) # END handle attribute name - - def _sio_modules(self): - """:return: Configuration file as StringIO - we only access it through the respective blob's data""" - sio = StringIO(self._parent_commit.tree[self.kModulesFile].datastream.read()) - sio.name = self.kModulesFile - return sio - def _config_parser(self, read_only): - """:return: Config Parser constrained to our submodule in read or write mode""" - parent_matches_head = self.repo.head.commit == self._parent_commit - if not self.repo.bare and parent_matches_head: - fp_module = self.kModulesFile + def __eq__(self, other): + """Compare with another submodule""" + return self.path == other.path and self.url == other.url and super(Submodule, self).__eq__(other) + + def __ne__(self, other): + """Compare with another submodule for inequality""" + return not (self == other) + + @classmethod + def _config_parser(cls, repo, parent_commit, read_only): + """:return: Config Parser constrained to our submodule in read or write mode + :raise IOError: If the .gitmodules file cannot be found, either locally or in the repository + at the given parent commit. Otherwise the exception would be delayed until the first + access of the config parser""" + parent_matches_head = repo.head.commit == parent_commit + if not repo.bare and parent_matches_head: + fp_module = cls.k_modules_file + fp_module_path = os.path.join(repo.working_tree_dir, fp_module) + if not os.path.isfile(fp_module_path): + raise IOError("%s file was not accessible" % fp_module_path) + # END handle existance else: - fp_module = self._sio_modules() + try: + fp_module = cls._sio_modules(parent_commit) + except KeyError: + raise IOError("Could not find %s file in the tree of parent commit %s" % (cls.k_modules_file, parent_commit)) + # END handle exceptions # END handle non-bare working tree if not read_only and not parent_matches_head: raise ValueError("Cannot write blobs of 'historical' submodule configurations") # END handle writes of historical submodules - parser = GitConfigParser(fp_module, read_only = read_only) - return SectionConstraint(parser, 'submodule "%s"' % self.path) + return GitConfigParser(fp_module, read_only = read_only) + + + @classmethod + def _sio_modules(cls, parent_commit): + """:return: Configuration file as StringIO - we only access it through the respective blob's data""" + sio = StringIO(parent_commit.tree[cls.k_modules_file].data_stream.read()) + sio.name = cls.k_modules_file + return sio + + def _config_parser_constrained(self, read_only): + """:return: Config Parser constrained to our submodule in read or write mode""" + parser = self._config_parser(self.repo, self._parent_commit, read_only) + return SectionConstraint(parser, sm_section(self.name)) #{ Edit Interface @@ -81,29 +147,52 @@ class Submodule(base.IndexObject): :param skip_init: if True, the new repository will not be cloned to its location. :return: The newly created submodule instance""" - def set_parent_commit(self, commit): + def set_parent_commit(self, commit, check=True): """Set this instance to use the given commit whose tree is supposed to contain the .gitmodules blob. :param commit: Commit'ish reference pointing at the root_tree - :raise ValueError: if the commit's tree didn't contain the .gitmodules blob.""" + :param check: if True, relatively expensive checks will be performed to verify + validity of the submodule. + :raise ValueError: if the commit's tree didn't contain the .gitmodules blob. + :raise ValueError: if the parent commit didn't store this submodule under the + current path""" pcommit = self.repo.commit(commit) - if self.kModulesFile not in pcommit.tree: - raise ValueError("Tree of commit %s did not contain the %s file" % (commit, self.kModulesFile)) + pctree = pcommit.tree + if self.k_modules_file not in pctree: + raise ValueError("Tree of commit %s did not contain the %s file" % (commit, self.k_modules_file)) # END handle exceptions + + prev_pc = self._parent_commit self._parent_commit = pcommit + if check: + parser = self._config_parser(self.repo, self._parent_commit, read_only=True) + if not parser.has_section(sm_section(self.name)): + self._parent_commit = prev_pc + raise ValueError("Submodule at path %r did not exist in parent commit %s" % (self.path, commit)) + # END handle submodule did not exist + # END handle checking mode + + # update our sha, it could have changed + self.binsha = pctree[self.path].binsha + # clear the possibly changed values for name in ('path', '_ref', '_url'): try: delattr(self, name) except AttributeError: pass + # END try attr deletion # END for each name to delete def config_writer(self): """:return: a config writer instance allowing you to read and write the data - belonging to this submodule into the .gitmodules file.""" - return self._config_parser(read_only=False) + belonging to this submodule into the .gitmodules file. + + :raise ValueError: if trying to get a writer on a parent_commit which does not + match the current head commit + :raise IOError: If the .gitmodules file/blob could not be read""" + return self._config_parser_constrained(read_only=False) #} END edit interface @@ -111,37 +200,104 @@ class Submodule(base.IndexObject): def module(self): """:return: Repo instance initialized from the repository at our submodule path - :raise InvalidGitRepositoryError: if a repository was not available""" + :raise InvalidGitRepositoryError: if a repository was not available. This could + also mean that it was not yet initialized""" + # late import to workaround circular dependencies + from git.repo import Repo + if self.repo.bare: raise InvalidGitRepositoryError("Cannot retrieve module repository in bare parent repositories") # END handle bare mode repo_path = join_path_native(self.repo.working_tree_dir, self.path) try: - return Repo(repo_path) + repo = Repo(repo_path) + if repo != self.repo: + return repo + # END handle repo uninitialized except (InvalidGitRepositoryError, NoSuchPathError): raise InvalidGitRepositoryError("No valid repository at %s" % self.path) + else: + raise InvalidGitRepositoryError("Repository at %r was not yet checked out" % repo_path) # END handle exceptions - + + @property def ref(self): """:return: The reference's name that we are to checkout""" return self._ref - + + @property def url(self): """:return: The url to the repository which our module-repository refers to""" return self._url + @property def parent_commit(self): """:return: Commit instance with the tree containing the .gitmodules file :note: will always point to the current head's commit if it was not set explicitly""" return self._parent_commit + + @property + def name(self): + """:return: The name of this submodule. It is used to identify it within the + .gitmodules file. + :note: by default, the name is the path at which to find the submodule, but + in git-python it should be a unique identifier similar to the identifiers + used for remotes, which allows to change the path of the submodule + easily + """ + return self._name def config_reader(self): """:return: ConfigReader instance which allows you to qurey the configuration values of this submodule, as provided by the .gitmodules file :note: The config reader will actually read the data directly from the repository and thus does not need nor care about your working tree. - :note: Should be cached by the caller and only kept as long as needed""" - return self._config_parser.read_only(read_only=True) + :note: Should be cached by the caller and only kept as long as needed + :raise IOError: If the .gitmodules file/blob could not be read""" + return self._config_parser_constrained(read_only=True) #} END query interface + + #{ Iterable Interface + + @classmethod + def iter_items(cls, repo, parent_commit='HEAD'): + """:return: iterator yielding Submodule instances available in the given repository""" + pc = repo.commit(parent_commit) # parent commit instance + try: + parser = cls._config_parser(repo, pc, read_only=True) + except IOError: + raise StopIteration + # END handle empty iterator + + rt = pc.tree # root tree + + for sms in parser.sections(): + n = sm_name(sms) + p = parser.get_value(sms, 'path') + u = parser.get_value(sms, 'url') + r = cls.k_ref_default + if parser.has_option(sms, cls.k_ref_option): + r = parser.get_value(sms, cls.k_ref_option) + # END handle optional information + + # get the binsha + try: + sm = rt[p] + except KeyError: + raise InvalidGitRepositoryError("Gitmodule path %r did not exist in revision of parent commit %s" % (p, parent_commit)) + # END handle critical error + + # fill in remaining info - saves time as it doesn't have to be parsed again + sm._name = n + sm._parent_commit = pc + sm._ref = r + sm._url = u + + yield sm + # END for each section + + #} END iterable interface + +#} END classes -- cgit v1.2.1 From f97653aa06cf84bcf160be3786b6fce49ef52961 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Mon, 15 Nov 2010 18:42:44 +0100 Subject: Repo: added submodule query and iteration methods similar to the ones provided for Remotes, including test --- lib/git/objects/submodule.py | 46 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 43 insertions(+), 3 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 1aa0cfb5..eda95115 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -1,13 +1,15 @@ import base +from util import Traversable from StringIO import StringIO # need a dict to set bloody .name field from git.util import Iterable from git.config import GitConfigParser, SectionConstraint from git.util import join_path_native from git.exc import InvalidGitRepositoryError, NoSuchPathError +import stat import os -__all__ = ("Submodule", ) +__all__ = ("Submodule", "RootModule") #{ Utilities @@ -31,7 +33,7 @@ class SubmoduleConfigParser(GitConfigParser): _mutating_methods_ = tuple() -class Submodule(base.IndexObject, Iterable): +class Submodule(base.IndexObject, Iterable, Traversable): """Implements access to a git submodule. They are special in that their sha represents a commit in the submodule's repository which is to be checked out at the path of this instance. @@ -40,10 +42,11 @@ class Submodule(base.IndexObject, Iterable): All methods work in bare and non-bare repositories.""" - _id_attribute_ = "path" + _id_attribute_ = "name" k_modules_file = '.gitmodules' k_ref_option = 'ref' k_ref_default = 'master' + k_def_mode = stat.S_IFDIR | stat.S_IFLNK # submodules are directories with link-status # this is a bogus type for base class compatability type = 'submodule' @@ -86,6 +89,14 @@ class Submodule(base.IndexObject, Iterable): super(Submodule, self)._set_cache_(attr) # END handle attribute name + def _get_intermediate_items(self, item): + """:return: all the submodules of our module repository""" + try: + return type(self).list_items(item.module()) + except InvalidGitRepositoryError: + return list() + # END handle intermeditate items + def __eq__(self, other): """Compare with another submodule""" return self.path == other.path and self.url == other.url and super(Submodule, self).__eq__(other) @@ -107,6 +118,7 @@ class Submodule(base.IndexObject, Iterable): if not os.path.isfile(fp_module_path): raise IOError("%s file was not accessible" % fp_module_path) # END handle existance + fp_module = fp_module_path else: try: fp_module = cls._sio_modules(parent_commit) @@ -300,4 +312,32 @@ class Submodule(base.IndexObject, Iterable): #} END iterable interface + +class RootModule(Submodule): + """A (virtual) Root of all submodules in the given repository. It can be used + to more easily traverse all submodules of the master repository""" + + __slots__ = tuple() + + k_root_name = '__ROOT__' + + def __init__(self, repo): + # repo, binsha, mode=None, path=None, name = None, parent_commit=None, url=None, ref=None) + super(RootModule, self).__init__( + repo, + binsha = self.NULL_BIN_SHA, + mode = self.k_def_mode, + path = '', + name = self.k_root_name, + parent_commit = repo.head.commit, + url = '', + ref = self.k_ref_default + ) + + + #{ Interface + def module(self): + """:return: the actual repository containing the submodules""" + return self.repo + #} END interface #} END classes -- cgit v1.2.1 From ceee7d7e0d98db12067744ac3cd0ab3a49602457 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Mon, 15 Nov 2010 22:12:05 +0100 Subject: Added partial implementation of update, but realized that using refs in general may be contradicting if a tag is given there, as well as a commit sha of the submodule. Hence it should really be only a branch --- lib/git/objects/submodule.py | 60 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index eda95115..12610abd 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -56,6 +56,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): def __init__(self, repo, binsha, mode=None, path=None, name = None, parent_commit=None, url=None, ref=None): """Initialize this instance with its attributes. We only document the ones that differ from ``IndexObject`` + :param repo: Our parent repository :param binsha: binary sha referring to a commit in the remote repository, see url parameter :param parent_commit: see set_parent_commit() :param url: The url to the remote repository which is the submodule @@ -105,6 +106,10 @@ class Submodule(base.IndexObject, Iterable, Traversable): """Compare with another submodule for inequality""" return not (self == other) + def __hash__(self): + """Hash this instance using its logical id, not the sha""" + return hash(self._name) + @classmethod def _config_parser(cls, repo, parent_commit, read_only): """:return: Config Parser constrained to our submodule in read or write mode @@ -159,6 +164,57 @@ class Submodule(base.IndexObject, Iterable, Traversable): :param skip_init: if True, the new repository will not be cloned to its location. :return: The newly created submodule instance""" + def update(self, recursive=False, init=True): + """Update the repository of this submodule to point to the checkout + we point at with the binsha of this instance. + :param recursive: if True, we will operate recursively and update child- + modules as well. + :param init: if True, the module repository will be cloned into place if necessary + :note: does nothing in bare repositories + :return: self""" + if self.repo.bare: + return self + #END pass in bare mode + + try: + mrepo = self.module() + except InvalidGitRepositoryError: + if not init: + return self + # END early abort if init is not allowed + import git + + # there is no git-repository yet - but delete empty paths + module_path = join_path_native(self.repo.working_tree_dir, self.path) + if os.path.isdir(module_path): + try: + os.rmdir(module_path) + except OSError: + raise OSError("Module directory at %r does already exist and is non-empty" % module_path) + # END handle OSError + # END handle directory removal + + # don't check it out at first + mrepo = git.Repo.clone_from(self.url, self.path, n=True) + # ref can be a tag or a branch - we can checkout branches, but not tags + # tag_ref = git.TagReference(mrepo, TagReference.to_full_path(self.ref)) + if tag_ref.is_valid(): + #if tag_ref.commit + mrepo.git.checkout(tag_ref) + else: + # assume it is a branch and try it + mrepo.git.checkout(self.hexsha, b=self.ref) + #if mrepo.head.ref.name != self.ref: + # mrepo.head.ref = git.Head(mrepo, git.Head.to_full_path(self.ref + #END handle initalization + + # TODO: handle ref-path + if mrepo.head.commit.binsha != self.binsha: + mrepo.git.checkout(self.binsha) + # END handle checkout + + return self + def set_parent_commit(self, commit, check=True): """Set this instance to use the given commit whose tree is supposed to contain the .gitmodules blob. @@ -167,7 +223,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): validity of the submodule. :raise ValueError: if the commit's tree didn't contain the .gitmodules blob. :raise ValueError: if the parent commit didn't store this submodule under the - current path""" + current path + :return: self""" pcommit = self.repo.commit(commit) pctree = pcommit.tree if self.k_modules_file not in pctree: @@ -196,6 +253,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): pass # END try attr deletion # END for each name to delete + return self def config_writer(self): """:return: a config writer instance allowing you to read and write the data -- cgit v1.2.1 From d4fd7fca515ba9b088a7c811292f76f47d16cd7b Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 16 Nov 2010 00:18:13 +0100 Subject: Submodule now only supports branches to be given as hint that will svn-external like behaviour. Implemented first version of update, which works for now, but probably needs to see more features --- lib/git/objects/submodule.py | 164 ++++++++++++++++++++++++++++++------------- 1 file changed, 116 insertions(+), 48 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 12610abd..86aba49c 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -8,6 +8,8 @@ from git.exc import InvalidGitRepositoryError, NoSuchPathError import stat import os +import sys +import weakref __all__ = ("Submodule", "RootModule") @@ -27,11 +29,43 @@ def sm_name(section): #{ Classes class SubmoduleConfigParser(GitConfigParser): - """Catches calls to _write, and updates the .gitmodules blob in the index + """ + Catches calls to _write, and updates the .gitmodules blob in the index with the new data, if we have written into a stream. Otherwise it will - add the local file to the index to make it correspond with the working tree.""" - _mutating_methods_ = tuple() + add the local file to the index to make it correspond with the working tree. + Additionally, the cache must be cleared + """ + def __init__(self, *args, **kwargs): + self._smref = None + super(SubmoduleConfigParser, self).__init__(*args, **kwargs) + + #{ Interface + def set_submodule(self, submodule): + """Set this instance's submodule. It must be called before + the first write operation begins""" + self._smref = weakref.ref(submodule) + + def flush_to_index(self): + """Flush changes in our configuration file to the index""" + assert self._smref is not None + # should always have a file here + assert not isinstance(self._file_or_files, StringIO) + + sm = self._smref() + if sm is not None: + sm.repo.index.add([sm.k_modules_file]) + sm._clear_cache() + # END handle weakref + + #} END interface + + #{ Overridden Methods + def write(self): + rval = super(SubmoduleConfigParser, self).write() + self.flush_to_index() + return rval + # END overridden methods class Submodule(base.IndexObject, Iterable, Traversable): """Implements access to a git submodule. They are special in that their sha @@ -44,16 +78,16 @@ class Submodule(base.IndexObject, Iterable, Traversable): _id_attribute_ = "name" k_modules_file = '.gitmodules' - k_ref_option = 'ref' - k_ref_default = 'master' + k_head_option = 'branch' + k_head_default = 'master' k_def_mode = stat.S_IFDIR | stat.S_IFLNK # submodules are directories with link-status # this is a bogus type for base class compatability type = 'submodule' - __slots__ = ('_parent_commit', '_url', '_ref', '_name') + __slots__ = ('_parent_commit', '_url', '_branch', '_name', '__weakref__') - def __init__(self, repo, binsha, mode=None, path=None, name = None, parent_commit=None, url=None, ref=None): + def __init__(self, repo, binsha, mode=None, path=None, name = None, parent_commit=None, url=None, branch=None): """Initialize this instance with its attributes. We only document the ones that differ from ``IndexObject`` :param repo: Our parent repository @@ -66,8 +100,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): self._parent_commit = parent_commit if url is not None: self._url = url - if ref is not None: - self._ref = ref + if branch is not None: + self._branch = branch if name is not None: self._name = name @@ -77,13 +111,13 @@ class Submodule(base.IndexObject, Iterable, Traversable): elif attr == '_parent_commit': # set a default value, which is the root tree of the current head self._parent_commit = self.repo.commit() - elif attr in ('path', '_url', '_ref'): + elif attr in ('path', '_url', '_branch'): reader = self.config_reader() # default submodule values self.path = reader.get_value('path') self._url = reader.get_value('url') # git-python extension values - optional - self._ref = reader.get_value(self.k_ref_option, self.k_ref_default) + self._branch = reader.get_value(self.k_head_option, self.k_head_default) elif attr == '_name': raise AttributeError("Cannot retrieve the name of a submodule if it was not set initially") else: @@ -132,12 +166,21 @@ class Submodule(base.IndexObject, Iterable, Traversable): # END handle exceptions # END handle non-bare working tree - if not read_only and not parent_matches_head: + if not read_only and (repo.bare or not parent_matches_head): raise ValueError("Cannot write blobs of 'historical' submodule configurations") # END handle writes of historical submodules - return GitConfigParser(fp_module, read_only = read_only) + return SubmoduleConfigParser(fp_module, read_only = read_only) + def _clear_cache(self): + # clear the possibly changed values + for name in ('path', '_branch', '_url'): + try: + delattr(self, name) + except AttributeError: + pass + # END try attr deletion + # END for each name to delete @classmethod def _sio_modules(cls, parent_commit): @@ -149,6 +192,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): def _config_parser_constrained(self, read_only): """:return: Config Parser constrained to our submodule in read or write mode""" parser = self._config_parser(self.repo, self._parent_commit, read_only) + parser.set_submodule(self) return SectionConstraint(parser, sm_section(self.name)) #{ Edit Interface @@ -178,6 +222,9 @@ class Submodule(base.IndexObject, Iterable, Traversable): try: mrepo = self.module() + for remote in mrepo.remotes: + remote.fetch() + #END fetch new data except InvalidGitRepositoryError: if not init: return self @@ -194,25 +241,42 @@ class Submodule(base.IndexObject, Iterable, Traversable): # END handle OSError # END handle directory removal - # don't check it out at first - mrepo = git.Repo.clone_from(self.url, self.path, n=True) - # ref can be a tag or a branch - we can checkout branches, but not tags - # tag_ref = git.TagReference(mrepo, TagReference.to_full_path(self.ref)) - if tag_ref.is_valid(): - #if tag_ref.commit - mrepo.git.checkout(tag_ref) - else: - # assume it is a branch and try it - mrepo.git.checkout(self.hexsha, b=self.ref) - #if mrepo.head.ref.name != self.ref: - # mrepo.head.ref = git.Head(mrepo, git.Head.to_full_path(self.ref + # don't check it out at first - nonetheless it will create a local + # branch according to the remote-HEAD if possible + mrepo = git.Repo.clone_from(self.url, module_path, n=True) + + # see whether we have a valid branch to checkout + try: + remote_branch = mrepo.remotes.origin.refs[self.branch] + local_branch = git.Head(mrepo, git.Head.to_full_path(self.branch)) + if not local_branch.is_valid(): + mrepo.git.checkout(remote_branch, b=self.branch) + # END initial checkout + branch creation + # make sure we are not detached + mrepo.head.ref = local_branch + except IndexError: + print >> sys.stderr, "Warning: Failed to checkout tracking branch %s" % self.branch + #END handle tracking branch #END handle initalization - # TODO: handle ref-path - if mrepo.head.commit.binsha != self.binsha: - mrepo.git.checkout(self.binsha) + # if the commit to checkout is on the current branch, merge the branch + if mrepo.head.is_detached: + if mrepo.head.commit.binsha != self.binsha: + mrepo.git.checkout(self.hexsha) + # END checkout commit + else: + # TODO: allow to specify a rebase, merge, or reset + # TODO: Warn if the hexsha forces the tracking branch off the remote + # branch - this should be prevented when setting the branch option + mrepo.head.reset(self.hexsha, index=True, working_tree=True) # END handle checkout + if recursive: + for submodule in self.iter_items(self.module()): + submodule.update(recursive, init) + # END handle recursive update + # END for each submodule + return self def set_parent_commit(self, commit, check=True): @@ -245,14 +309,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): # update our sha, it could have changed self.binsha = pctree[self.path].binsha - # clear the possibly changed values - for name in ('path', '_ref', '_url'): - try: - delattr(self, name) - except AttributeError: - pass - # END try attr deletion - # END for each name to delete + self._clear_cache() + return self def config_writer(self): @@ -262,6 +320,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): :raise ValueError: if trying to get a writer on a parent_commit which does not match the current head commit :raise IOError: If the .gitmodules file/blob could not be read""" + if self.repo.bare: + raise InvalidGitRepositoryError("Cannot change submodule configuration in a bare repository") return self._config_parser_constrained(read_only=False) #} END edit interface @@ -279,24 +339,28 @@ class Submodule(base.IndexObject, Iterable, Traversable): raise InvalidGitRepositoryError("Cannot retrieve module repository in bare parent repositories") # END handle bare mode - repo_path = join_path_native(self.repo.working_tree_dir, self.path) + module_path = self.module_path() try: - repo = Repo(repo_path) + repo = Repo(module_path) if repo != self.repo: return repo # END handle repo uninitialized except (InvalidGitRepositoryError, NoSuchPathError): raise InvalidGitRepositoryError("No valid repository at %s" % self.path) else: - raise InvalidGitRepositoryError("Repository at %r was not yet checked out" % repo_path) + raise InvalidGitRepositoryError("Repository at %r was not yet checked out" % module_path) # END handle exceptions + + def module_path(self): + """:return: full path to the root of our module. It is relative to the filesystem root""" + return join_path_native(self.repo.working_tree_dir, self.path) @property - def ref(self): - """:return: The reference's name that we are to checkout""" - return self._ref + def branch(self): + """:return: The branch name that we are to checkout""" + return self._branch - @property + @property def url(self): """:return: The url to the repository which our module-repository refers to""" return self._url @@ -347,9 +411,9 @@ class Submodule(base.IndexObject, Iterable, Traversable): n = sm_name(sms) p = parser.get_value(sms, 'path') u = parser.get_value(sms, 'url') - r = cls.k_ref_default - if parser.has_option(sms, cls.k_ref_option): - r = parser.get_value(sms, cls.k_ref_option) + b = cls.k_head_default + if parser.has_option(sms, cls.k_head_option): + b = parser.get_value(sms, cls.k_head_option) # END handle optional information # get the binsha @@ -362,7 +426,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): # fill in remaining info - saves time as it doesn't have to be parsed again sm._name = n sm._parent_commit = pc - sm._ref = r + sm._branch = b sm._url = u yield sm @@ -389,10 +453,14 @@ class RootModule(Submodule): name = self.k_root_name, parent_commit = repo.head.commit, url = '', - ref = self.k_ref_default + branch = self.k_head_default ) + def _clear_cache(self): + """May not do anything""" + pass + #{ Interface def module(self): """:return: the actual repository containing the submodules""" -- cgit v1.2.1 From af5abca21b56fcf641ff916bd567680888c364aa Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 16 Nov 2010 09:30:10 +0100 Subject: Added a few utility methods and improved the test. Refs need an improvement though to allow easy configuration of branch-specific settings --- lib/git/objects/submodule.py | 60 +++++++++++++++++++++++++++++++------------- 1 file changed, 43 insertions(+), 17 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 86aba49c..d58e07a9 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -251,6 +251,17 @@ class Submodule(base.IndexObject, Iterable, Traversable): local_branch = git.Head(mrepo, git.Head.to_full_path(self.branch)) if not local_branch.is_valid(): mrepo.git.checkout(remote_branch, b=self.branch) + else: + # have a valid branch, but no checkout - make sure we can figure + # that out by marking the commit with a null_sha + # have to write it directly as .commit = NULLSHA tries to resolve the sha + ref = mrepo.head.ref + refpath = join_path_native(mrepo.git_dir, ref.to_full_path(ref.path)) + refdir = os.path.dirname(refpath) + if not os.path.isdir(refdir): + os.makedirs(refdir) + #END handle directory + open(refpath, 'w').write(self.NULL_HEX_SHA) # END initial checkout + branch creation # make sure we are not detached mrepo.head.ref = local_branch @@ -259,24 +270,24 @@ class Submodule(base.IndexObject, Iterable, Traversable): #END handle tracking branch #END handle initalization - # if the commit to checkout is on the current branch, merge the branch - if mrepo.head.is_detached: - if mrepo.head.commit.binsha != self.binsha: + # update the working tree + if mrepo.head.commit.binsha != self.binsha: + if mrepo.head.is_detached: mrepo.git.checkout(self.hexsha) - # END checkout commit - else: - # TODO: allow to specify a rebase, merge, or reset - # TODO: Warn if the hexsha forces the tracking branch off the remote - # branch - this should be prevented when setting the branch option - mrepo.head.reset(self.hexsha, index=True, working_tree=True) - # END handle checkout - - if recursive: - for submodule in self.iter_items(self.module()): - submodule.update(recursive, init) - # END handle recursive update - # END for each submodule - + else: + # TODO: allow to specify a rebase, merge, or reset + # TODO: Warn if the hexsha forces the tracking branch off the remote + # branch - this should be prevented when setting the branch option + mrepo.head.reset(self.hexsha, index=True, working_tree=True) + # END handle checkout + + if recursive: + for submodule in self.iter_items(self.module()): + submodule.update(recursive, init) + # END handle recursive update + # END for each submodule + # END update to new commit only if needed + return self def set_parent_commit(self, commit, check=True): @@ -354,6 +365,15 @@ class Submodule(base.IndexObject, Iterable, Traversable): def module_path(self): """:return: full path to the root of our module. It is relative to the filesystem root""" return join_path_native(self.repo.working_tree_dir, self.path) + + def module_exists(self): + """:return: True if our module exists and is a valid git repository. See module() method""" + try: + self.module() + return True + except InvalidGitRepositoryError: + return False + # END handle exception @property def branch(self): @@ -391,6 +411,12 @@ class Submodule(base.IndexObject, Iterable, Traversable): :raise IOError: If the .gitmodules file/blob could not be read""" return self._config_parser_constrained(read_only=True) + def children(self): + """:return: IterableList(Submodule, ...) an iterable list of submodules instances + which are children of this submodule + :raise InvalidGitRepositoryError: if the submodule is not checked-out""" + return self._get_intermediate_items(self) + #} END query interface #{ Iterable Interface -- cgit v1.2.1 From 21b4db556619db2ef25f0e0d90fef7e38e6713e5 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 16 Nov 2010 11:27:23 +0100 Subject: Improved efficiency of the submodule.update process, improved test --- lib/git/objects/submodule.py | 46 ++++++++++++++++++++++++++------------------ 1 file changed, 27 insertions(+), 19 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index d58e07a9..72ab6360 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -144,6 +144,9 @@ class Submodule(base.IndexObject, Iterable, Traversable): """Hash this instance using its logical id, not the sha""" return hash(self._name) + def __str__(self): + return self._name + @classmethod def _config_parser(cls, repo, parent_commit, read_only): """:return: Config Parser constrained to our submodule in read or write mode @@ -250,20 +253,24 @@ class Submodule(base.IndexObject, Iterable, Traversable): remote_branch = mrepo.remotes.origin.refs[self.branch] local_branch = git.Head(mrepo, git.Head.to_full_path(self.branch)) if not local_branch.is_valid(): - mrepo.git.checkout(remote_branch, b=self.branch) - else: - # have a valid branch, but no checkout - make sure we can figure - # that out by marking the commit with a null_sha - # have to write it directly as .commit = NULLSHA tries to resolve the sha - ref = mrepo.head.ref - refpath = join_path_native(mrepo.git_dir, ref.to_full_path(ref.path)) - refdir = os.path.dirname(refpath) - if not os.path.isdir(refdir): - os.makedirs(refdir) - #END handle directory - open(refpath, 'w').write(self.NULL_HEX_SHA) + # Setup a tracking configuration - branch doesn't need to + # exist to do that + local_branch.set_tracking_branch(remote_branch) + #END handle local branch + + # have a valid branch, but no checkout - make sure we can figure + # that out by marking the commit with a null_sha + # have to write it directly as .commit = NULLSHA tries to resolve the sha + # This will bring the branch into existance + refpath = join_path_native(mrepo.git_dir, local_branch.path) + refdir = os.path.dirname(refpath) + if not os.path.isdir(refdir): + os.makedirs(refdir) + #END handle directory + open(refpath, 'w').write(self.NULL_HEX_SHA) # END initial checkout + branch creation - # make sure we are not detached + + # make sure HEAD is not detached mrepo.head.ref = local_branch except IndexError: print >> sys.stderr, "Warning: Failed to checkout tracking branch %s" % self.branch @@ -280,13 +287,14 @@ class Submodule(base.IndexObject, Iterable, Traversable): # branch - this should be prevented when setting the branch option mrepo.head.reset(self.hexsha, index=True, working_tree=True) # END handle checkout - - if recursive: - for submodule in self.iter_items(self.module()): - submodule.update(recursive, init) - # END handle recursive update - # END for each submodule # END update to new commit only if needed + + # HANDLE RECURSION + if recursive: + for submodule in self.iter_items(self.module()): + submodule.update(recursive, init) + # END handle recursive update + # END for each submodule return self -- cgit v1.2.1 From 78d2cd65b8b778f3b0cfef5268b0684314ca22ef Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 16 Nov 2010 12:11:29 +0100 Subject: implemented update to_last_revision option including test. Its now possible to update submodules such as svn-externals --- lib/git/objects/submodule.py | 43 +++++++++++++++++++++++++++++++++++++------ 1 file changed, 37 insertions(+), 6 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 72ab6360..116c53f1 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -211,18 +211,26 @@ class Submodule(base.IndexObject, Iterable, Traversable): :param skip_init: if True, the new repository will not be cloned to its location. :return: The newly created submodule instance""" - def update(self, recursive=False, init=True): + def update(self, recursive=False, init=True, to_latest_revision=False): """Update the repository of this submodule to point to the checkout we point at with the binsha of this instance. :param recursive: if True, we will operate recursively and update child- modules as well. :param init: if True, the module repository will be cloned into place if necessary + :param to_latest_revision: if True, the submodule's sha will be ignored during checkout. + Instead, the remote will be fetched, and the local tracking branch updated. + This only works if we have a local tracking branch, which is the case + if the remote repository had a master branch, or of the 'branch' option + was specified for this submodule and the branch existed remotely :note: does nothing in bare repositories :return: self""" if self.repo.bare: return self #END pass in bare mode + + # ASSURE REPO IS PRESENT AND UPTODATE + ##################################### try: mrepo = self.module() for remote in mrepo.remotes: @@ -277,22 +285,45 @@ class Submodule(base.IndexObject, Iterable, Traversable): #END handle tracking branch #END handle initalization + + # DETERMINE SHAS TO CHECKOUT + ############################ + binsha = self.binsha + hexsha = self.hexsha + is_detached = mrepo.head.is_detached + if to_latest_revision: + msg_base = "Cannot update to latest revision in repository at %r as " % mrepo.working_dir + if not is_detached: + rref = mrepo.head.ref.tracking_branch() + if rref is not None: + rcommit = rref.commit + binsha = rcommit.binsha + hexsha = rcommit.hexsha + else: + print >> sys.stderr, "%s a tracking branch was not set for local branch '%s'" % (msg_base, mrepo.head.ref) + # END handle remote ref + else: + print >> sys.stderr, "%s there was no local tracking branch" % msg_base + # END handle detached head + # END handle to_latest_revision option + # update the working tree - if mrepo.head.commit.binsha != self.binsha: - if mrepo.head.is_detached: - mrepo.git.checkout(self.hexsha) + if mrepo.head.commit.binsha != binsha: + if is_detached: + mrepo.git.checkout(hexsha) else: # TODO: allow to specify a rebase, merge, or reset # TODO: Warn if the hexsha forces the tracking branch off the remote # branch - this should be prevented when setting the branch option - mrepo.head.reset(self.hexsha, index=True, working_tree=True) + mrepo.head.reset(hexsha, index=True, working_tree=True) # END handle checkout # END update to new commit only if needed # HANDLE RECURSION + ################## if recursive: for submodule in self.iter_items(self.module()): - submodule.update(recursive, init) + submodule.update(recursive, init, to_latest_revision) # END handle recursive update # END for each submodule -- cgit v1.2.1 From 3d061a1a506b71234f783628ba54a7bdf79bbce9 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 16 Nov 2010 17:16:44 +0100 Subject: Implemented deletion of submodules including proper tests --- lib/git/objects/submodule.py | 126 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 123 insertions(+), 3 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 116c53f1..9e8abbd4 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -10,14 +10,15 @@ import stat import os import sys import weakref +import shutil __all__ = ("Submodule", "RootModule") #{ Utilities -def sm_section(path): +def sm_section(name): """:return: section title used in .gitmodules configuration file""" - return 'submodule "%s"' % path + return 'submodule "%s"' % name def sm_name(section): """:return: name of the submodule as parsed from the section name""" @@ -223,6 +224,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): if the remote repository had a master branch, or of the 'branch' option was specified for this submodule and the branch existed remotely :note: does nothing in bare repositories + :note: method is definitely not atomic if recurisve is True :return: self""" if self.repo.bare: return self @@ -329,6 +331,111 @@ class Submodule(base.IndexObject, Iterable, Traversable): return self + def remove(self, module=True, force=False, configuration=True, dry_run=False): + """Remove this submodule from the repository. This will remove our entry + from the .gitmodules file and the entry in the .git/config file. + :param module: If True, the module we point to will be deleted + as well. If the module is currently on a commit which is not part + of any branch in the remote, if the currently checked out branch + is ahead of its tracking branch, if you have modifications in the + working tree, or untracked files, + In case the removal of the repository fails for these reasons, the + submodule status will not have been altered. + If this submodule has child-modules on its own, these will be deleted + prior to touching the own module. + :param force: Enforces the deletion of the module even though it contains + modifications. This basically enforces a brute-force file system based + deletion. + :param configuration: if True, the submodule is deleted from the configuration, + otherwise it isn't. Although this should be enabled most of the times, + this flag enables you to safely delete the repository of your submodule. + :param dry_run: if True, we will not actually do anything, but throw the errors + we would usually throw + :note: doesn't work in bare repositories + :raise InvalidGitRepositoryError: thrown if the repository cannot be deleted + :raise OSError: if directories or files could not be removed""" + if self.repo.bare: + raise InvalidGitRepositoryError("Cannot delete a submodule in bare repository") + # END handle bare mode + + if not (module + configuration): + raise ValueError("Need to specify to delete at least the module, or the configuration") + # END handle params + + # DELETE MODULE REPOSITORY + ########################## + if module and self.module_exists(): + if force: + # take the fast lane and just delete everything in our module path + # TODO: If we run into permission problems, we have a highly inconsistent + # state. Delete the .git folders last, start with the submodules first + mp = self.module_path() + method = None + if os.path.islink(mp): + method = os.remove + elif os.path.isdir(mp): + method = shutil.rmtree + elif os.path.exists(mp): + raise AssertionError("Cannot forcibly delete repository as it was neither a link, nor a directory") + #END handle brutal deletion + if not dry_run: + assert method + method(mp) + #END apply deletion method + else: + # verify we may delete our module + mod = self.module() + if mod.is_dirty(untracked_files=True): + raise InvalidGitRepositoryError("Cannot delete module at %s with any modifications, unless force is specified" % mod.working_tree_dir) + # END check for dirt + + # figure out whether we have new commits compared to the remotes + # NOTE: If the user pulled all the time, the remote heads might + # not have been updated, so commits coming from the remote look + # as if they come from us. But we stay strictly read-only and + # don't fetch beforhand. + for remote in mod.remotes: + num_branches_with_new_commits = 0 + rrefs = remote.refs + for rref in rrefs: + num_branches_with_new_commits = len(mod.git.cherry(rref)) != 0 + # END for each remote ref + # not a single remote branch contained all our commits + if num_branches_with_new_commits == len(rrefs): + raise InvalidGitRepositoryError("Cannot delete module at %s as there are new commits" % mod.working_tree_dir) + # END handle new commits + # END for each remote + + # gently remove all submodule repositories + for sm in self.children(): + sm.remove(module=True, force=False, configuration=False, dry_run=dry_run) + # END for each child-submodule + + # finally delete our own submodule + if not dry_run: + shutil.rmtree(mod.working_tree_dir) + # END delete tree if possible + # END handle force + # END handle module deletion + + # DELETE CONFIGURATION + ###################### + if configuration and not dry_run: + # first the index-entry + index = self.repo.index + try: + del(index.entries[index.entry_key(self.path, 0)]) + except KeyError: + pass + #END delete entry + index.write() + + # now git config - need the config intact, otherwise we can't query + # inforamtion anymore + self.repo.config_writer().remove_section(sm_section(self.name)) + self.config_writer().remove_section() + # END delete configuration + def set_parent_commit(self, commit, check=True): """Set this instance to use the given commit whose tree is supposed to contain the .gitmodules blob. @@ -410,10 +517,23 @@ class Submodule(base.IndexObject, Iterable, Traversable): try: self.module() return True - except InvalidGitRepositoryError: + except Exception: return False # END handle exception + def exists(self): + """:return: True if the submodule exists, False otherwise. Please note that + a submodule may exist (in the .gitmodules file) even though its module + doesn't exist""" + self._clear_cache() + try: + self.path + return True + except Exception: + # we raise if the path cannot be restored from configuration + return False + # END handle exceptions + @property def branch(self): """:return: The branch name that we are to checkout""" -- cgit v1.2.1 From 98e6edb546116cd98abdc3b37c6744e859bbde5c Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 16 Nov 2010 19:01:27 +0100 Subject: Initial implementation of submodule.add without any tests. These are to come next --- lib/git/objects/submodule.py | 94 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 90 insertions(+), 4 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 9e8abbd4..93d47999 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -202,15 +202,101 @@ class Submodule(base.IndexObject, Iterable, Traversable): #{ Edit Interface @classmethod - def add(cls, repo, path, url, skip_init=False): + def add(cls, repo, name, path, url=None, branch=k_head_default, no_checkout=False): """Add a new submodule to the given repository. This will alter the index as well as the .gitmodules file, but will not create a new commit. + If the submodule already exists, no matter if the configuration differs + from the one provided, the existing submodule will be returned. :param repo: Repository instance which should receive the submodule - :param path: repository-relative path at which the submodule should be located + :param name: The name/identifier for the submodule + :param path: repository-relative or absolute path at which the submodule + should be located It will be created as required during the repository initialization. :param url: git-clone compatible URL, see git-clone reference for more information - :param skip_init: if True, the new repository will not be cloned to its location. - :return: The newly created submodule instance""" + If None, the repository is assumed to exist, and the url of the first + remote is taken instead. This is useful if you want to make an existing + repository a submodule of anotherone. + :param branch: branch at which the submodule should (later) be checked out. + The given branch must exist in the remote repository, and will be checked + out locally as a tracking branch. + It will only be written into the configuration if it differs from the + default. + :param no_checkout: if True, and if the repository has to be cloned manually, + no checkout will be performed + :return: The newly created submodule instance + :note: works atomically, such that no change will be done if the repository + update fails for instance""" + if repo.bare: + raise InvalidGitRepositoryError("Cannot add a submodule to bare repositories") + #END handle bare mode + + path = to_native_path_linux(path) + if path.endswith('/'): + path = path[:-1] + # END handle trailing slash + + sm = cls(repo, cls.NULL_BIN_SHA, cls.k_def_mode, path, name) + if sm.exists(): + # reretrieve submodule from tree + return repo.head.commit.tree[path] + # END handle existing + + branch = Head(repo, head.to_full_path(branch)) + has_module = sm.module_exists() + branch_is_default = branch.name == cls.k_head_default + if has_module and url is not None: + if url not in [r.url for r in sm.module().remotes]: + raise ValueError("Specified URL %s does not match any remote url of the repository at %s" % (url, sm.module_path())) + # END check url + # END verify urls match + + mrepo = None + if url is None: + if not has_module: + raise ValueError("A URL was not given and existing repository did not exsit at %s" % path) + # END check url + mrepo = sm.module() + urls = [r.url for r in mrepo.remotes] + if not urls: + raise ValueError("Didn't find any remote url in repository at %s" % sm.module_path()) + # END verify we have url + url = urls[0] + else: + # clone new repo + kwargs = {'n' : no_checkout} + if branch_is_default: + kwargs['b'] = str(branch) + # END setup checkout-branch + mrepo = git.Repo.clone_from(url, path, **kwargs) + # END verify url + + # update configuration and index + writer = sm.config_writer() + writer.set_value('url', url) + writer.set_value('path', path) + + sm._url = url + if not branch_is_default: + # store full path + writer.set_value(cls.k_head_option, branch.path) + sm._branch = branch + # END handle path + del(writer) + + # NOTE: Have to write the repo config file as well, otherwise + # the default implementation will be offended and not update the repository + # Maybe this is a good way to assure it doesn't get into our way, but + # we want to stay backwards compatible too ... . Its so redundant ! + repo.config_writer().set_value(sm_section(sm.name), 'url', url) + + # we deliberatly assume that our head matches our index ! + pcommit = repo.head.commit + sm._parent_commit = pcommit + sm.binsha = mrepo.head.commit.binsha + repo.index.add([sm], write=True) + + return sm + def update(self, recursive=False, init=True, to_latest_revision=False): """Update the repository of this submodule to point to the checkout -- cgit v1.2.1 From 33964afb47ce3af8a32e6613b0834e5f94bdfe68 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 16 Nov 2010 21:07:33 +0100 Subject: Added tests for all failure modes of submodule add ( except for one ), and fixed a few issues on the way --- lib/git/objects/submodule.py | 40 +++++++++++++++++++++++++++++----------- 1 file changed, 29 insertions(+), 11 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 93d47999..44dc9b02 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -1,11 +1,11 @@ import base from util import Traversable from StringIO import StringIO # need a dict to set bloody .name field -from git.util import Iterable +from git.util import Iterable, join_path_native, to_native_path_linux from git.config import GitConfigParser, SectionConstraint -from git.util import join_path_native from git.exc import InvalidGitRepositoryError, NoSuchPathError import stat +import git import os import sys @@ -87,6 +87,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): type = 'submodule' __slots__ = ('_parent_commit', '_url', '_branch', '_name', '__weakref__') + _cache_attrs = ('path', '_url', '_branch') def __init__(self, repo, binsha, mode=None, path=None, name = None, parent_commit=None, url=None, branch=None): """Initialize this instance with its attributes. We only document the ones @@ -178,7 +179,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): def _clear_cache(self): # clear the possibly changed values - for name in ('path', '_branch', '_url'): + for name in self._cache_attrs: try: delattr(self, name) except AttributeError: @@ -235,18 +236,19 @@ class Submodule(base.IndexObject, Iterable, Traversable): path = path[:-1] # END handle trailing slash + # INSTANTIATE INTERMEDIATE SM sm = cls(repo, cls.NULL_BIN_SHA, cls.k_def_mode, path, name) if sm.exists(): # reretrieve submodule from tree return repo.head.commit.tree[path] # END handle existing - branch = Head(repo, head.to_full_path(branch)) + branch = git.Head(repo, git.Head.to_full_path(branch)) has_module = sm.module_exists() branch_is_default = branch.name == cls.k_head_default if has_module and url is not None: if url not in [r.url for r in sm.module().remotes]: - raise ValueError("Specified URL %s does not match any remote url of the repository at %s" % (url, sm.module_path())) + raise ValueError("Specified URL '%s' does not match any remote url of the repository at '%s'" % (url, sm.module_path())) # END check url # END verify urls match @@ -611,14 +613,30 @@ class Submodule(base.IndexObject, Iterable, Traversable): """:return: True if the submodule exists, False otherwise. Please note that a submodule may exist (in the .gitmodules file) even though its module doesn't exist""" + # keep attributes for later, and restore them if we have no valid data + # this way we do not actually alter the state of the object + loc = locals() + for attr in self._cache_attrs: + if hasattr(self, attr): + loc[attr] = getattr(self, attr) + # END if we have the attribute cache + #END for each attr self._clear_cache() + try: - self.path - return True - except Exception: - # we raise if the path cannot be restored from configuration - return False - # END handle exceptions + try: + self.path + return True + except Exception: + return False + # END handle exceptions + finally: + for attr in self._cache_attrs: + if attr in loc: + setattr(self, attr, loc[attr]) + # END if we have a cache + # END reapply each attribute + # END handle object state consistency @property def branch(self): -- cgit v1.2.1 From 7b3ef45167e1c2f7d1b7507c13fcedd914f87da9 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 16 Nov 2010 21:21:09 +0100 Subject: The submodule's branch is now a branch instance, not a plain string anymore --- lib/git/objects/submodule.py | 42 ++++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 44dc9b02..586ebeab 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -24,6 +24,10 @@ def sm_name(section): """:return: name of the submodule as parsed from the section name""" section = section.strip() return section[11:-1] + +def mkhead(repo, path): + """:return: New branch/head instance""" + return git.Head(repo, git.Head.to_full_path(path)) #} END utilities @@ -96,13 +100,14 @@ class Submodule(base.IndexObject, Iterable, Traversable): :param binsha: binary sha referring to a commit in the remote repository, see url parameter :param parent_commit: see set_parent_commit() :param url: The url to the remote repository which is the submodule - :param ref: Reference to checkout when cloning the remote repository""" + :param branch: Head instance to checkout when cloning the remote repository""" super(Submodule, self).__init__(repo, binsha, mode, path) if parent_commit is not None: self._parent_commit = parent_commit if url is not None: self._url = url if branch is not None: + assert isinstance(branch, git.Head) self._branch = branch if name is not None: self._name = name @@ -119,7 +124,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): self.path = reader.get_value('path') self._url = reader.get_value('url') # git-python extension values - optional - self._branch = reader.get_value(self.k_head_option, self.k_head_default) + self._branch = mkhead(self.repo, reader.get_value(self.k_head_option, self.k_head_default)) elif attr == '_name': raise AttributeError("Cannot retrieve the name of a submodule if it was not set initially") else: @@ -203,7 +208,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): #{ Edit Interface @classmethod - def add(cls, repo, name, path, url=None, branch=k_head_default, no_checkout=False): + def add(cls, repo, name, path, url=None, branch=None, no_checkout=False): """Add a new submodule to the given repository. This will alter the index as well as the .gitmodules file, but will not create a new commit. If the submodule already exists, no matter if the configuration differs @@ -220,8 +225,10 @@ class Submodule(base.IndexObject, Iterable, Traversable): :param branch: branch at which the submodule should (later) be checked out. The given branch must exist in the remote repository, and will be checked out locally as a tracking branch. - It will only be written into the configuration if it differs from the - default. + It will only be written into the configuration if it not None, which is + when the checked out branch will be the one the remote HEAD pointed to. + The result you get in these situation is somewhat fuzzy, and it is recommended + to specify at least 'master' here :param no_checkout: if True, and if the repository has to be cloned manually, no checkout will be performed :return: The newly created submodule instance @@ -243,9 +250,9 @@ class Submodule(base.IndexObject, Iterable, Traversable): return repo.head.commit.tree[path] # END handle existing - branch = git.Head(repo, git.Head.to_full_path(branch)) + br = mkhead(repo, branch or cls.k_head_default) has_module = sm.module_exists() - branch_is_default = branch.name == cls.k_head_default + branch_is_default = branch is None if has_module and url is not None: if url not in [r.url for r in sm.module().remotes]: raise ValueError("Specified URL '%s' does not match any remote url of the repository at '%s'" % (url, sm.module_path())) @@ -266,8 +273,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): else: # clone new repo kwargs = {'n' : no_checkout} - if branch_is_default: - kwargs['b'] = str(branch) + if not branch_is_default: + kwargs['b'] = str(br) # END setup checkout-branch mrepo = git.Repo.clone_from(url, path, **kwargs) # END verify url @@ -280,8 +287,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): sm._url = url if not branch_is_default: # store full path - writer.set_value(cls.k_head_option, branch.path) - sm._branch = branch + writer.set_value(cls.k_head_option, br.path) + sm._branch = br.path # END handle path del(writer) @@ -348,8 +355,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): # see whether we have a valid branch to checkout try: - remote_branch = mrepo.remotes.origin.refs[self.branch] - local_branch = git.Head(mrepo, git.Head.to_full_path(self.branch)) + remote_branch = mrepo.remotes.origin.refs[self.branch.name] + local_branch = self.branch if not local_branch.is_valid(): # Setup a tracking configuration - branch doesn't need to # exist to do that @@ -578,7 +585,6 @@ class Submodule(base.IndexObject, Iterable, Traversable): :raise InvalidGitRepositoryError: if a repository was not available. This could also mean that it was not yet initialized""" # late import to workaround circular dependencies - from git.repo import Repo if self.repo.bare: raise InvalidGitRepositoryError("Cannot retrieve module repository in bare parent repositories") @@ -586,7 +592,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): module_path = self.module_path() try: - repo = Repo(module_path) + repo = git.Repo(module_path) if repo != self.repo: return repo # END handle repo uninitialized @@ -640,7 +646,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): @property def branch(self): - """:return: The branch name that we are to checkout""" + """:return: The branch instance that we are to checkout""" return self._branch @property @@ -715,7 +721,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): # fill in remaining info - saves time as it doesn't have to be parsed again sm._name = n sm._parent_commit = pc - sm._branch = b + sm._branch = mkhead(repo, b) sm._url = u yield sm @@ -742,7 +748,7 @@ class RootModule(Submodule): name = self.k_root_name, parent_commit = repo.head.commit, url = '', - branch = self.k_head_default + branch = mkhead(repo, self.k_head_default) ) -- cgit v1.2.1 From ef48ca5f54fe31536920ec4171596ff8468db5fe Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Wed, 17 Nov 2010 00:28:57 +0100 Subject: Added rest of submodule.add test code which should be pretty much 100% coverage for it --- lib/git/objects/submodule.py | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 586ebeab..e07117a6 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -85,7 +85,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): k_modules_file = '.gitmodules' k_head_option = 'branch' k_head_default = 'master' - k_def_mode = stat.S_IFDIR | stat.S_IFLNK # submodules are directories with link-status + k_default_mode = stat.S_IFDIR | stat.S_IFLNK # submodules are directories with link-status # this is a bogus type for base class compatability type = 'submodule' @@ -244,7 +244,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): # END handle trailing slash # INSTANTIATE INTERMEDIATE SM - sm = cls(repo, cls.NULL_BIN_SHA, cls.k_def_mode, path, name) + sm = cls(repo, cls.NULL_BIN_SHA, cls.k_default_mode, path, name) if sm.exists(): # reretrieve submodule from tree return repo.head.commit.tree[path] @@ -712,10 +712,17 @@ class Submodule(base.IndexObject, Iterable, Traversable): # END handle optional information # get the binsha + index = repo.index try: sm = rt[p] except KeyError: - raise InvalidGitRepositoryError("Gitmodule path %r did not exist in revision of parent commit %s" % (p, parent_commit)) + # try the index, maybe it was just added + try: + entry = index.entries[index.entry_key(p, 0)] + sm = cls(repo, entry.binsha, entry.mode, entry.path) + except KeyError: + raise InvalidGitRepositoryError("Gitmodule path %r did not exist in revision of parent commit %s" % (p, parent_commit)) + # END handle keyerror # END handle critical error # fill in remaining info - saves time as it doesn't have to be parsed again @@ -743,7 +750,7 @@ class RootModule(Submodule): super(RootModule, self).__init__( repo, binsha = self.NULL_BIN_SHA, - mode = self.k_def_mode, + mode = self.k_default_mode, path = '', name = self.k_root_name, parent_commit = repo.head.commit, -- cgit v1.2.1 From a1e6234c27abf041e4c8cd1a799950e7cd9104f6 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Wed, 17 Nov 2010 15:24:48 +0100 Subject: Inital implementation of Submodule.move including a very simple and to-be-improved test --- lib/git/objects/submodule.py | 145 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 123 insertions(+), 22 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index e07117a6..8a1ab6af 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -28,6 +28,19 @@ def sm_name(section): def mkhead(repo, path): """:return: New branch/head instance""" return git.Head(repo, git.Head.to_full_path(path)) + +def unbare_repo(func): + """Methods with this decorator raise InvalidGitRepositoryError if they + encounter a bare repository""" + def wrapper(self, *args, **kwargs): + if self.repo.bare: + raise InvalidGitRepositoryError("Method '%s' cannot operate on bare repositories" % func.__name__) + #END bare method + return func(self, *args, **kwargs) + # END wrapper + wrapper.__name__ = func.__name__ + return wrapper + #} END utilities @@ -39,10 +52,14 @@ class SubmoduleConfigParser(GitConfigParser): with the new data, if we have written into a stream. Otherwise it will add the local file to the index to make it correspond with the working tree. Additionally, the cache must be cleared + + Please note that no mutating method will work in bare mode """ def __init__(self, *args, **kwargs): self._smref = None + self._index = None + self._auto_write = True super(SubmoduleConfigParser, self).__init__(*args, **kwargs) #{ Interface @@ -59,7 +76,11 @@ class SubmoduleConfigParser(GitConfigParser): sm = self._smref() if sm is not None: - sm.repo.index.add([sm.k_modules_file]) + index = self._index + if index is None: + index = sm.repo.index + # END handle index + index.add([sm.k_modules_file], write=self._auto_write) sm._clear_cache() # END handle weakref @@ -102,6 +123,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): :param url: The url to the remote repository which is the submodule :param branch: Head instance to checkout when cloning the remote repository""" super(Submodule, self).__init__(repo, binsha, mode, path) + self.size = 0 if parent_commit is not None: self._parent_commit = parent_commit if url is not None: @@ -113,9 +135,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): self._name = name def _set_cache_(self, attr): - if attr == 'size': - raise ValueError("Submodules do not have a size as they do not refer to anything in this repository") - elif attr == '_parent_commit': + if attr == '_parent_commit': # set a default value, which is the root tree of the current head self._parent_commit = self.repo.commit() elif attr in ('path', '_url', '_branch'): @@ -235,8 +255,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): :note: works atomically, such that no change will be done if the repository update fails for instance""" if repo.bare: - raise InvalidGitRepositoryError("Cannot add a submodule to bare repositories") - #END handle bare mode + raise InvalidGitRepositoryError("Cannot add submodules to bare repositories") + # END handle bare repos path = to_native_path_linux(path) if path.endswith('/'): @@ -280,7 +300,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): # END verify url # update configuration and index - writer = sm.config_writer() + index = sm.repo.index + writer = sm.config_writer(index=index, write=False) writer.set_value('url', url) writer.set_value('path', path) @@ -302,11 +323,10 @@ class Submodule(base.IndexObject, Iterable, Traversable): pcommit = repo.head.commit sm._parent_commit = pcommit sm.binsha = mrepo.head.commit.binsha - repo.index.add([sm], write=True) + index.add([sm], write=True) return sm - def update(self, recursive=False, init=True, to_latest_revision=False): """Update the repository of this submodule to point to the checkout we point at with the binsha of this instance. @@ -426,6 +446,85 @@ class Submodule(base.IndexObject, Iterable, Traversable): return self + @unbare_repo + def move(self, module_path): + """Move the submodule to a another module path. This involves physically moving + the repository at our current path, changing the configuration, as well as + adjusting our index entry accordingly. + :param module_path: the path to which to move our module, given as + repository-relative path. Intermediate directories will be created + accordingly. If the path already exists, it must be empty. + Trailling (back)slashes are removed automatically + :return: self + :raise ValueError: if the module path existed and was not empty, or was a file + :note: Currently the method is not atomic, and it could leave the repository + in an inconsistent state if a sub-step fails for some reason + """ + module_path = to_native_path_linux(module_path) + if module_path.endswith('/'): + module_path = module_path[:-1] + # END handle trailing slash + + # VERIFY DESTINATION + if module_path == self.path: + return self + #END handle no change + + dest_path = join_path_native(self.repo.working_tree_dir, module_path) + if os.path.isfile(dest_path): + raise ValueError("Cannot move repository onto a file: %s" % dest_path) + # END handle target files + + # remove existing destination + if os.path.exists(dest_path): + if len(os.listdir(dest_path)): + raise ValueError("Destination module directory was not empty") + #END handle non-emptyness + + if os.path.islink(dest_path): + os.remove(dest_path) + else: + os.rmdir(dest_path) + #END handle link + else: + # recreate parent directories + # NOTE: renames() does that now + pass + #END handle existance + + # move the module into place if possible + cur_path = self.module_path() + if os.path.exists(cur_path): + os.renames(cur_path, dest_path) + #END move physical module + + # NOTE: from now on, we would have to undo the rename ! + + # rename the index entry - have to manipulate the index directly as + # git-mv cannot be used on submodules ... yeah + index = self.repo.index + try: + ekey = index.entry_key(self.path, 0) + entry = index.entries[ekey] + del(index.entries[ekey]) + nentry = git.IndexEntry(entry[:3]+(module_path,)+entry[4:]) + ekey = index.entry_key(module_path, 0) + index.entries[ekey] = nentry + except KeyError: + raise ValueError("Submodule's entry at %r did not exist" % (self.path)) + #END handle submodule doesn't exist + + # update configuration + writer = self.config_writer(index=index) # auto-write + writer.set_value('path', module_path) + self.path = module_path + del(writer) + + return self + + + + @unbare_repo def remove(self, module=True, force=False, configuration=True, dry_run=False): """Remove this submodule from the repository. This will remove our entry from the .gitmodules file and the entry in the .git/config file. @@ -449,10 +548,6 @@ class Submodule(base.IndexObject, Iterable, Traversable): :note: doesn't work in bare repositories :raise InvalidGitRepositoryError: thrown if the repository cannot be deleted :raise OSError: if directories or files could not be removed""" - if self.repo.bare: - raise InvalidGitRepositoryError("Cannot delete a submodule in bare repository") - # END handle bare mode - if not (module + configuration): raise ValueError("Need to specify to delete at least the module, or the configuration") # END handle params @@ -565,31 +660,37 @@ class Submodule(base.IndexObject, Iterable, Traversable): return self - def config_writer(self): + @unbare_repo + def config_writer(self, index=None, write=True): """:return: a config writer instance allowing you to read and write the data belonging to this submodule into the .gitmodules file. + :param index: if not None, an IndexFile instance which should be written. + defaults to the index of the Submodule's parent repository. + :param write: if True, the index will be written each time a configuration + value changes. + :note: the parameters allow for a more efficient writing of the index, + as you can pass in a modified index on your own, prevent automatic writing, + and write yourself once the whole operation is complete :raise ValueError: if trying to get a writer on a parent_commit which does not match the current head commit :raise IOError: If the .gitmodules file/blob could not be read""" - if self.repo.bare: - raise InvalidGitRepositoryError("Cannot change submodule configuration in a bare repository") - return self._config_parser_constrained(read_only=False) + writer = self._config_parser_constrained(read_only=False) + if index is not None: + writer.config._index = index + writer.config._auto_write = write + return writer #} END edit interface #{ Query Interface + @unbare_repo def module(self): """:return: Repo instance initialized from the repository at our submodule path :raise InvalidGitRepositoryError: if a repository was not available. This could also mean that it was not yet initialized""" # late import to workaround circular dependencies - - if self.repo.bare: - raise InvalidGitRepositoryError("Cannot retrieve module repository in bare parent repositories") - # END handle bare mode - module_path = self.module_path() try: repo = git.Repo(module_path) -- cgit v1.2.1 From 609a46a72764dc71104aa5d7b1ca5f53d4237a75 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Wed, 17 Nov 2010 17:15:24 +0100 Subject: submodule: removed module_path method as it is implemented in the abspath property alrdeady Improved submodule move tests --- lib/git/objects/submodule.py | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 8a1ab6af..51453820 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -275,7 +275,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): branch_is_default = branch is None if has_module and url is not None: if url not in [r.url for r in sm.module().remotes]: - raise ValueError("Specified URL '%s' does not match any remote url of the repository at '%s'" % (url, sm.module_path())) + raise ValueError("Specified URL '%s' does not match any remote url of the repository at '%s'" % (url, sm.abspath)) # END check url # END verify urls match @@ -287,7 +287,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): mrepo = sm.module() urls = [r.url for r in mrepo.remotes] if not urls: - raise ValueError("Didn't find any remote url in repository at %s" % sm.module_path()) + raise ValueError("Didn't find any remote url in repository at %s" % sm.abspath) # END verify we have url url = urls[0] else: @@ -493,7 +493,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): #END handle existance # move the module into place if possible - cur_path = self.module_path() + cur_path = self.abspath if os.path.exists(cur_path): os.renames(cur_path, dest_path) #END move physical module @@ -522,8 +522,6 @@ class Submodule(base.IndexObject, Iterable, Traversable): return self - - @unbare_repo def remove(self, module=True, force=False, configuration=True, dry_run=False): """Remove this submodule from the repository. This will remove our entry @@ -559,7 +557,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): # take the fast lane and just delete everything in our module path # TODO: If we run into permission problems, we have a highly inconsistent # state. Delete the .git folders last, start with the submodules first - mp = self.module_path() + mp = self.abspath method = None if os.path.islink(mp): method = os.remove @@ -691,7 +689,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): :raise InvalidGitRepositoryError: if a repository was not available. This could also mean that it was not yet initialized""" # late import to workaround circular dependencies - module_path = self.module_path() + module_path = self.abspath try: repo = git.Repo(module_path) if repo != self.repo: @@ -703,10 +701,6 @@ class Submodule(base.IndexObject, Iterable, Traversable): raise InvalidGitRepositoryError("Repository at %r was not yet checked out" % module_path) # END handle exceptions - def module_path(self): - """:return: full path to the root of our module. It is relative to the filesystem root""" - return join_path_native(self.repo.working_tree_dir, self.path) - def module_exists(self): """:return: True if our module exists and is a valid git repository. See module() method""" try: -- cgit v1.2.1 From 1687283c13caf7ff8d1959591541dff6a171ca1e Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Wed, 17 Nov 2010 22:38:10 +0100 Subject: RootModule.update: initial implementation of update method, which should be able to handle submodule removals, additions, path changes and branch changes. All this still needs to be tested though --- lib/git/objects/submodule.py | 210 +++++++++++++++++++++++++++++++++++++++---- 1 file changed, 191 insertions(+), 19 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 51453820..d31f1ec9 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -41,6 +41,17 @@ def unbare_repo(func): wrapper.__name__ = func.__name__ return wrapper +def find_remote_branch(remotes, branch): + """Find the remote branch matching the name of the given branch or raise InvalidGitRepositoryError""" + for remote in remotes: + try: + return remote.refs[branch.name] + except IndexError: + continue + # END exception handling + #END for remote + raise InvalidGitRepositoryError("Didn't find remote branch %r in any of the given remotes", branch + #} END utilities @@ -375,7 +386,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): # see whether we have a valid branch to checkout try: - remote_branch = mrepo.remotes.origin.refs[self.branch.name] + # find a remote which has our branch - we try to be flexible + remote_branch = find_remote_branch(mrepo.remotes, self.branch) local_branch = self.branch if not local_branch.is_valid(): # Setup a tracking configuration - branch doesn't need to @@ -447,7 +459,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): return self @unbare_repo - def move(self, module_path): + def move(self, module_path, module_only=False): """Move the submodule to a another module path. This involves physically moving the repository at our current path, changing the configuration, as well as adjusting our index entry accordingly. @@ -455,6 +467,10 @@ class Submodule(base.IndexObject, Iterable, Traversable): repository-relative path. Intermediate directories will be created accordingly. If the path already exists, it must be empty. Trailling (back)slashes are removed automatically + :param module_only: if True, only the repository managed by this submodule + will be moved, not the configuration. This will effectively + leave your repository in an inconsistent state unless the configuration + and index already point to the target location. :return: self :raise ValueError: if the module path existed and was not empty, or was a file :note: Currently the method is not atomic, and it could leave the repository @@ -475,6 +491,13 @@ class Submodule(base.IndexObject, Iterable, Traversable): raise ValueError("Cannot move repository onto a file: %s" % dest_path) # END handle target files + index = self.repo.index + tekey = index.entry_key(module_path, 0) + # if the target item already exists, fail + if not module_only and tekey in index.entries: + raise ValueError("Index entry for target path did alredy exist") + #END handle index key already there + # remove existing destination if os.path.exists(dest_path): if len(os.listdir(dest_path)): @@ -502,23 +525,23 @@ class Submodule(base.IndexObject, Iterable, Traversable): # rename the index entry - have to manipulate the index directly as # git-mv cannot be used on submodules ... yeah - index = self.repo.index - try: - ekey = index.entry_key(self.path, 0) - entry = index.entries[ekey] - del(index.entries[ekey]) - nentry = git.IndexEntry(entry[:3]+(module_path,)+entry[4:]) - ekey = index.entry_key(module_path, 0) - index.entries[ekey] = nentry - except KeyError: - raise ValueError("Submodule's entry at %r did not exist" % (self.path)) - #END handle submodule doesn't exist - - # update configuration - writer = self.config_writer(index=index) # auto-write - writer.set_value('path', module_path) - self.path = module_path - del(writer) + if not module_only: + try: + ekey = index.entry_key(self.path, 0) + entry = index.entries[ekey] + del(index.entries[ekey]) + nentry = git.IndexEntry(entry[:3]+(module_path,)+entry[4:]) + index.entries[tekey] = nentry + except KeyError: + raise ValueError("Submodule's entry at %r did not exist" % (self.path)) + #END handle submodule doesn't exist + + # update configuration + writer = self.config_writer(index=index) # auto-write + writer.set_value('path', module_path) + self.path = module_path + del(writer) + # END handle module_only return self @@ -543,6 +566,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): this flag enables you to safely delete the repository of your submodule. :param dry_run: if True, we will not actually do anything, but throw the errors we would usually throw + :return: self :note: doesn't work in bare repositories :raise InvalidGitRepositoryError: thrown if the repository cannot be deleted :raise OSError: if directories or files could not be removed""" @@ -624,6 +648,8 @@ class Submodule(base.IndexObject, Iterable, Traversable): self.config_writer().remove_section() # END delete configuration + return self + def set_parent_commit(self, commit, check=True): """Set this instance to use the given commit whose tree is supposed to contain the .gitmodules blob. @@ -859,6 +885,152 @@ class RootModule(Submodule): pass #{ Interface + + def update(self, previous_commit=None, recursive=True, force_remove=False, init=True, to_latest_revision=False): + """Update the submodules of this repository to the current HEAD commit. + This method behaves smartly by determining changes of the path of a submodules + repository, next to changes to the to-be-checked-out commit or the branch to be + checked out. This works if the submodules ID does not change. + Additionally it will detect addition and removal of submodules, which will be handled + gracefully. + + :param previous_commit: If set to a commit'ish, the commit we should use + as the previous commit the HEAD pointed to before it was set to the commit it points to now. + If None, it defaults to ORIG_HEAD otherwise, or the parent of the current + commit if it is not given + :param recursive: if True, the children of submodules will be updated as well + using the same technique + :param force_remove: If submodules have been deleted, they will be forcibly removed. + Otherwise the update may fail if a submodule's repository cannot be deleted as + changes have been made to it (see Submodule.update() for more information) + :param init: If we encounter a new module which would need to be initialized, then do it. + :param to_latest_revision: If True, instead of checking out the revision pointed to + by this submodule's sha, the checked out tracking branch will be merged with the + newest remote branch fetched from the repository's origin""" + if self.repo.bare: + raise InvalidGitRepositoryError("Cannot update submodules in bare repositories") + # END handle bare + + repo = self.repo + + # HANDLE COMMITS + ################## + cur_commit = repo.head.commit + if previous_commit is None: + symref = SymbolicReference(repo, SymbolicReference.to_full_path('ORIG_HEAD')) + try: + previous_commit = symref.commit + except Exception: + pcommits = cur_commit.parents + if pcommits: + previous_commit = pcommits[0] + else: + # in this special case, we just diff against ourselve, which + # means exactly no change + previous_commit = cur_commit + # END handle initial commit + # END no ORIG_HEAD + else: + previous_commit = repo.commit(previous_commit) # obtain commit object + # END handle previous commit + + + # HANDLE REMOVALS + psms = type(self).list_items(repo, parent_commit=previous_commit) + sms = self.children() + spsms = set(psms) + ssms = set(sms) + + # HANDLE REMOVALS + ################### + for rsm in (spsms - ssms): + # fake it into thinking its at the current commit to allow deletion + # of previous module. Trigger the cache to be updated before that + #rsm.url + rsm._parent_commit = repo.head.commit + rsm.remove(configuration=False, module=True, force=force_remove) + # END for each removed submodule + + # HANDLE PATH RENAMES + url changes + branch changes + for csm in (spsms & ssms): + psm = psms[csm.name] + sm = sms[csm.name] + + if sm.path != psm.path and psm.module_exists(): + # move the module to the new path + psm.move(sm.path, module_only=True) + # END handle path changes + + if sm.module_exists(): + # handle url change + if sm.url != psm.url: + # Add the new remote, remove the old one + # This way, if the url just changes, the commits will not + # have to be re-retrieved + nn = '__new_origin__' + smm = sm.module() + rmts = smm.remotes + assert nn not in rmts + smr = smm.create_remote(nn, sm.url) + srm.fetch() + + # now delete the changed one + orig_name = None + for remote in rmts: + if remote.url == psm.url: + orig_name = remote.name + smm.delete_remote(remote) + break + # END if urls match + # END for each remote + + # rename the new remote back to what it was + # if we have not found any remote with the original url + # we may not have a name. This is a special case, + # and its okay to fail her + assert orig_name is not None, "Couldn't find original remote-repo at url %r" % psm.url + smr.rename(orig_name) + # END handle url + + if sm.branch != psm.branch: + # finally, create a new tracking branch which tracks the + # new remote branch + smm = sm.module() + smmr = smm.remotes + tbr = git.Head.create(smm, sm.branch.name) + tbr.set_tracking_branch(find_remote_branch(smmr, sm.branch)) + + # figure out whether the previous tracking branch contains + # new commits compared to the other one, if not we can + # delete it. + try: + tbr = find_remote_branch(smmr, psm.branch) + if len(smm.git.cherry(tbr, psm.branch)) == 0: + psm.branch.delete(smm, psm.branch) + #END delete original tracking branch if there are no changes + except InvalidGitRepositoryError: + # ignore it if the previous branch couldn't be found in the + # current remotes, this just means we can't handle it + pass + # END exception handling + #END handle branch + #END handle + # END for each common submodule + + # FINALLY UPDATE ALL ACTUAL SUBMODULES + ########################################## + for sm in sms: + sm.update(recursive=True, init=init, to_latest_revision=to_latest_revision) + + # update recursively depth first - question is which inconsitent + # state will be better in case it fails somewhere. Defective branch + # or defective depth + if recursive: + type(cls)(sm.module()).update(recursive=True, force_remove=force_remove, + init=init, to_latest_revision=to_latest_revision) + #END handle recursive + # END for each submodule to update + def module(self): """:return: the actual repository containing the submodules""" return self.repo -- cgit v1.2.1 From 0c1834134ce177cdbd30a56994fcc4bf8f5be8b2 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Thu, 18 Nov 2010 11:41:16 +0100 Subject: Added test-setup which can test all aspects of the (smart) update method --- lib/git/objects/submodule.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index d31f1ec9..7ef7f590 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -50,7 +50,7 @@ def find_remote_branch(remotes, branch): continue # END exception handling #END for remote - raise InvalidGitRepositoryError("Didn't find remote branch %r in any of the given remotes", branch + raise InvalidGitRepositoryError("Didn't find remote branch %r in any of the given remotes", branch) #} END utilities -- cgit v1.2.1 From c0990b2a6dd2e777b46c1685ddb985b3c0ef59a2 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Thu, 18 Nov 2010 17:09:32 +0100 Subject: first update test succeeds, so it verifies that existing repositories can be moved later if the configuration changed, and actually it also verifies that the url-change is handled correctly (as we changed the url from the default to the local path) --- lib/git/objects/submodule.py | 162 ++++++++++++++++++++++++++----------------- 1 file changed, 100 insertions(+), 62 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 7ef7f590..9fb8ce8f 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -104,6 +104,7 @@ class SubmoduleConfigParser(GitConfigParser): return rval # END overridden methods + class Submodule(base.IndexObject, Iterable, Traversable): """Implements access to a git submodule. They are special in that their sha represents a commit in the submodule's repository which is to be checked out @@ -172,7 +173,10 @@ class Submodule(base.IndexObject, Iterable, Traversable): def __eq__(self, other): """Compare with another submodule""" - return self.path == other.path and self.url == other.url and super(Submodule, self).__eq__(other) + # we may only compare by name as this should be the ID they are hashed with + # Otherwise this type wouldn't be hashable + # return self.path == other.path and self.url == other.url and super(Submodule, self).__eq__(other) + return self._name == other._name def __ne__(self, other): """Compare with another submodule for inequality""" @@ -185,6 +189,9 @@ class Submodule(base.IndexObject, Iterable, Traversable): def __str__(self): return self._name + def __repr__(self): + return "git.%s(name=%s, path=%s, url=%s, branch=%s)" % (type(self).__name__, self._name, self.path, self.url, self.branch) + @classmethod def _config_parser(cls, repo, parent_commit, read_only): """:return: Config Parser constrained to our submodule in read or write mode @@ -459,7 +466,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): return self @unbare_repo - def move(self, module_path, module_only=False): + def move(self, module_path, configuration=True, module=True): """Move the submodule to a another module path. This involves physically moving the repository at our current path, changing the configuration, as well as adjusting our index entry accordingly. @@ -467,15 +474,21 @@ class Submodule(base.IndexObject, Iterable, Traversable): repository-relative path. Intermediate directories will be created accordingly. If the path already exists, it must be empty. Trailling (back)slashes are removed automatically - :param module_only: if True, only the repository managed by this submodule + :param configuration: if True, the configuration will be adjusted to let + the submodule point to the given path. + :param module: if True, the repository managed by this submodule will be moved, not the configuration. This will effectively leave your repository in an inconsistent state unless the configuration - and index already point to the target location. + and index already point to the target location. :return: self :raise ValueError: if the module path existed and was not empty, or was a file :note: Currently the method is not atomic, and it could leave the repository in an inconsistent state if a sub-step fails for some reason """ + if module + configuration < 1: + raise ValueError("You must specify to move at least the module or the configuration of the submodule") + #END handle input + module_path = to_native_path_linux(module_path) if module_path.endswith('/'): module_path = module_path[:-1] @@ -494,54 +507,64 @@ class Submodule(base.IndexObject, Iterable, Traversable): index = self.repo.index tekey = index.entry_key(module_path, 0) # if the target item already exists, fail - if not module_only and tekey in index.entries: + if configuration and tekey in index.entries: raise ValueError("Index entry for target path did alredy exist") #END handle index key already there # remove existing destination - if os.path.exists(dest_path): - if len(os.listdir(dest_path)): - raise ValueError("Destination module directory was not empty") - #END handle non-emptyness - - if os.path.islink(dest_path): - os.remove(dest_path) + if module: + if os.path.exists(dest_path): + if len(os.listdir(dest_path)): + raise ValueError("Destination module directory was not empty") + #END handle non-emptyness + + if os.path.islink(dest_path): + os.remove(dest_path) + else: + os.rmdir(dest_path) + #END handle link else: - os.rmdir(dest_path) - #END handle link - else: - # recreate parent directories - # NOTE: renames() does that now - pass - #END handle existance + # recreate parent directories + # NOTE: renames() does that now + pass + #END handle existance + # END handle module # move the module into place if possible cur_path = self.abspath - if os.path.exists(cur_path): + renamed_module = False + if module and os.path.exists(cur_path): os.renames(cur_path, dest_path) + renamed_module = True #END move physical module - # NOTE: from now on, we would have to undo the rename ! # rename the index entry - have to manipulate the index directly as # git-mv cannot be used on submodules ... yeah - if not module_only: - try: - ekey = index.entry_key(self.path, 0) - entry = index.entries[ekey] - del(index.entries[ekey]) - nentry = git.IndexEntry(entry[:3]+(module_path,)+entry[4:]) - index.entries[tekey] = nentry - except KeyError: - raise ValueError("Submodule's entry at %r did not exist" % (self.path)) - #END handle submodule doesn't exist - - # update configuration - writer = self.config_writer(index=index) # auto-write - writer.set_value('path', module_path) - self.path = module_path - del(writer) - # END handle module_only + try: + if configuration: + try: + ekey = index.entry_key(self.path, 0) + entry = index.entries[ekey] + del(index.entries[ekey]) + nentry = git.IndexEntry(entry[:3]+(module_path,)+entry[4:]) + index.entries[tekey] = nentry + except KeyError: + raise InvalidGitRepositoryError("Submodule's entry at %r did not exist" % (self.path)) + #END handle submodule doesn't exist + + # update configuration + writer = self.config_writer(index=index) # auto-write + writer.set_value('path', module_path) + self.path = module_path + del(writer) + # END handle configuration flag + except Exception: + if renamed_module: + os.renames(dest_path, cur_path) + # END undo module renaming + raise + #END handle undo rename return self @@ -917,7 +940,7 @@ class RootModule(Submodule): ################## cur_commit = repo.head.commit if previous_commit is None: - symref = SymbolicReference(repo, SymbolicReference.to_full_path('ORIG_HEAD')) + symref = repo.head.orig_head() try: previous_commit = symref.commit except Exception: @@ -936,8 +959,8 @@ class RootModule(Submodule): # HANDLE REMOVALS - psms = type(self).list_items(repo, parent_commit=previous_commit) - sms = self.children() + psms = self.list_items(repo, parent_commit=previous_commit) + sms = self.list_items(self.module()) spsms = set(psms) ssms = set(sms) @@ -958,7 +981,7 @@ class RootModule(Submodule): if sm.path != psm.path and psm.module_exists(): # move the module to the new path - psm.move(sm.path, module_only=True) + psm.move(sm.path, module=True, configuration=False) # END handle path changes if sm.module_exists(): @@ -970,26 +993,39 @@ class RootModule(Submodule): nn = '__new_origin__' smm = sm.module() rmts = smm.remotes - assert nn not in rmts - smr = smm.create_remote(nn, sm.url) - srm.fetch() - - # now delete the changed one - orig_name = None - for remote in rmts: - if remote.url == psm.url: - orig_name = remote.name - smm.delete_remote(remote) - break - # END if urls match - # END for each remote - # rename the new remote back to what it was - # if we have not found any remote with the original url - # we may not have a name. This is a special case, - # and its okay to fail her - assert orig_name is not None, "Couldn't find original remote-repo at url %r" % psm.url - smr.rename(orig_name) + # don't do anything if we already have the url we search in place + if len([r for r in rmts if r.url == sm.url]) == 0: + assert nn not in [r.name for r in rmts] + smr = smm.create_remote(nn, sm.url) + smr.fetch() + + # now delete the changed one + orig_name = None + for remote in rmts: + if remote.url == psm.url: + orig_name = remote.name + smm.delete_remote(remote) + break + # END if urls match + # END for each remote + + # if we didn't find a matching remote, but have exactly one, + # we can safely use this one + if len(rmts) == 1: + orig_name = rmts[0].name + smm.delete_remote(rmts[0]) + else: + # if we have not found any remote with the original url + # we may not have a name. This is a special case, + # and its okay to fail here + # Alternatively we could just generate a unique name + raise InvalidGitRepositoryError("Couldn't find original remote-repo at url %r" % psm.url) + # END only one remove + + # rename the new remote back to what it was + smr.rename(orig_name) + # END skip remote handling if new url already exists in module # END handle url if sm.branch != psm.branch: @@ -1020,11 +1056,13 @@ class RootModule(Submodule): # FINALLY UPDATE ALL ACTUAL SUBMODULES ########################################## for sm in sms: + # update the submodule using the default method sm.update(recursive=True, init=init, to_latest_revision=to_latest_revision) # update recursively depth first - question is which inconsitent # state will be better in case it fails somewhere. Defective branch - # or defective depth + # or defective depth. The RootSubmodule type will never process itself, + # which was done in the previous expression if recursive: type(cls)(sm.module()).update(recursive=True, force_remove=force_remove, init=init, to_latest_revision=to_latest_revision) -- cgit v1.2.1 From cf5eaddde33e983bc7b496f458bdd49154f6f498 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Thu, 18 Nov 2010 20:44:21 +0100 Subject: Updated tests and implementation to verify functionality for handling submodule removals, as well as url changes --- lib/git/objects/submodule.py | 80 +++++++++++++++++++++++++++++++++++--------- 1 file changed, 64 insertions(+), 16 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 9fb8ce8f..948a267f 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -958,7 +958,6 @@ class RootModule(Submodule): # END handle previous commit - # HANDLE REMOVALS psms = self.list_items(repo, parent_commit=previous_commit) sms = self.list_items(self.module()) spsms = set(psms) @@ -974,7 +973,9 @@ class RootModule(Submodule): rsm.remove(configuration=False, module=True, force=force_remove) # END for each removed submodule - # HANDLE PATH RENAMES + url changes + branch changes + # HANDLE PATH RENAMES + ##################### + # url changes + branch changes for csm in (spsms & ssms): psm = psms[csm.name] sm = sms[csm.name] @@ -996,35 +997,79 @@ class RootModule(Submodule): # don't do anything if we already have the url we search in place if len([r for r in rmts if r.url == sm.url]) == 0: + + assert nn not in [r.name for r in rmts] smr = smm.create_remote(nn, sm.url) smr.fetch() + # If we have a tracking branch, it should be available + # in the new remote as well. + if len([r for r in smr.refs if r.remote_head == sm.branch.name]) == 0: + raise ValueError("Submodule branch named %r was not available in new submodule remote at %r" % (sm.branch.name, sm.url)) + # END head is not detached + # now delete the changed one - orig_name = None + rmt_for_deletion = None for remote in rmts: if remote.url == psm.url: - orig_name = remote.name - smm.delete_remote(remote) + rmt_for_deletion = remote break # END if urls match # END for each remote # if we didn't find a matching remote, but have exactly one, # we can safely use this one - if len(rmts) == 1: - orig_name = rmts[0].name - smm.delete_remote(rmts[0]) - else: - # if we have not found any remote with the original url - # we may not have a name. This is a special case, - # and its okay to fail here - # Alternatively we could just generate a unique name - raise InvalidGitRepositoryError("Couldn't find original remote-repo at url %r" % psm.url) - # END only one remove + if rmt_for_deletion is None: + if len(rmts) == 1: + rmt_for_deletion = rmts[0] + else: + # if we have not found any remote with the original url + # we may not have a name. This is a special case, + # and its okay to fail here + # Alternatively we could just generate a unique name and leave all + # existing ones in place + raise InvalidGitRepositoryError("Couldn't find original remote-repo at url %r" % psm.url) + #END handle one single remote + # END handle check we found a remote + + orig_name = rmt_for_deletion.name + smm.delete_remote(rmt_for_deletion) + # NOTE: Currently we leave tags from the deleted remotes + # as well as separate tracking branches in the possibly totally + # changed repository ( someone could have changed the url to + # another project ). At some point, one might want to clean + # it up, but the danger is high to remove stuff the user + # has added explicitly # rename the new remote back to what it was smr.rename(orig_name) + + # early on, we verified that the our current tracking branch + # exists in the remote. Now we have to assure that the + # sha we point to is still contained in the new remote + # tracking branch. + smsha = sm.binsha + found = False + rref = smr.refs[self.branch.name] + for c in rref.commit.traverse(): + if c.binsha == smsha: + found = True + break + # END traverse all commits in search for sha + # END for each commit + + if not found: + # adjust our internal binsha to use the one of the remote + # this way, it will be checked out in the next step + # This will change the submodule relative to us, so + # the user will be able to commit the change easily + print >> sys.stderr, "WARNING: Current sha %s was not contained in the tracking branch at the new remote, setting it the the remote's tracking branch" % sm.hexsha + sm.binsha = rref.commit.binsha + #END reset binsha + + #NOTE: All checkout is performed by the base implementation of update + # END skip remote handling if new url already exists in module # END handle url @@ -1049,12 +1094,15 @@ class RootModule(Submodule): # current remotes, this just means we can't handle it pass # END exception handling + + #NOTE: All checkout is done in the base implementation of update + #END handle branch #END handle # END for each common submodule # FINALLY UPDATE ALL ACTUAL SUBMODULES - ########################################## + ###################################### for sm in sms: # update the submodule using the default method sm.update(recursive=True, init=init, to_latest_revision=to_latest_revision) -- cgit v1.2.1 From 3f2d76ba8e6d004ff5849ed8c7c34f6a4ac2e1e3 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Thu, 18 Nov 2010 21:36:01 +0100 Subject: Added test for branch changes - it appears to work well, at least as far as the restricted tests are concerned --- lib/git/objects/submodule.py | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index 948a267f..aa11909f 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -41,7 +41,7 @@ def unbare_repo(func): wrapper.__name__ = func.__name__ return wrapper -def find_remote_branch(remotes, branch): +def find_first_remote_branch(remotes, branch): """Find the remote branch matching the name of the given branch or raise InvalidGitRepositoryError""" for remote in remotes: try: @@ -394,7 +394,7 @@ class Submodule(base.IndexObject, Iterable, Traversable): # see whether we have a valid branch to checkout try: # find a remote which has our branch - we try to be flexible - remote_branch = find_remote_branch(mrepo.remotes, self.branch) + remote_branch = find_first_remote_branch(mrepo.remotes, self.branch) local_branch = self.branch if not local_branch.is_valid(): # Setup a tracking configuration - branch doesn't need to @@ -1078,14 +1078,23 @@ class RootModule(Submodule): # new remote branch smm = sm.module() smmr = smm.remotes - tbr = git.Head.create(smm, sm.branch.name) - tbr.set_tracking_branch(find_remote_branch(smmr, sm.branch)) + try: + tbr = git.Head.create(smm, sm.branch.name) + except git.GitCommandError, e: + if e.status != 128: + raise + #END handle something unexpected + + # ... or reuse the existing one + tbr = git.Head(smm, git.Head.to_full_path(sm.branch.name)) + #END assure tracking branch exists + tbr.set_tracking_branch(find_first_remote_branch(smmr, sm.branch)) # figure out whether the previous tracking branch contains # new commits compared to the other one, if not we can # delete it. try: - tbr = find_remote_branch(smmr, psm.branch) + tbr = find_first_remote_branch(smmr, psm.branch) if len(smm.git.cherry(tbr, psm.branch)) == 0: psm.branch.delete(smm, psm.branch) #END delete original tracking branch if there are no changes -- cgit v1.2.1 From ebe8f644e751c1b2115301c1a961bef14d2cce89 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Thu, 18 Nov 2010 22:11:06 +0100 Subject: Added test for the recursive code path. --- lib/git/objects/submodule.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py index aa11909f..c769b160 100644 --- a/lib/git/objects/submodule.py +++ b/lib/git/objects/submodule.py @@ -1121,7 +1121,7 @@ class RootModule(Submodule): # or defective depth. The RootSubmodule type will never process itself, # which was done in the previous expression if recursive: - type(cls)(sm.module()).update(recursive=True, force_remove=force_remove, + type(self)(sm.module()).update(recursive=True, force_remove=force_remove, init=init, to_latest_revision=to_latest_revision) #END handle recursive # END for each submodule to update -- cgit v1.2.1 From 4c34d5c3f2a4ed7194276a026e0ec6437d339c67 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Thu, 18 Nov 2010 22:44:53 +0100 Subject: Split big submodule file into smaller files. Tried to manually get imports right, but its not yet tested --- lib/git/objects/submodule.py | 1133 ------------------------------------------ 1 file changed, 1133 deletions(-) delete mode 100644 lib/git/objects/submodule.py (limited to 'lib/git/objects/submodule.py') diff --git a/lib/git/objects/submodule.py b/lib/git/objects/submodule.py deleted file mode 100644 index c769b160..00000000 --- a/lib/git/objects/submodule.py +++ /dev/null @@ -1,1133 +0,0 @@ -import base -from util import Traversable -from StringIO import StringIO # need a dict to set bloody .name field -from git.util import Iterable, join_path_native, to_native_path_linux -from git.config import GitConfigParser, SectionConstraint -from git.exc import InvalidGitRepositoryError, NoSuchPathError -import stat -import git - -import os -import sys -import weakref -import shutil - -__all__ = ("Submodule", "RootModule") - -#{ Utilities - -def sm_section(name): - """:return: section title used in .gitmodules configuration file""" - return 'submodule "%s"' % name - -def sm_name(section): - """:return: name of the submodule as parsed from the section name""" - section = section.strip() - return section[11:-1] - -def mkhead(repo, path): - """:return: New branch/head instance""" - return git.Head(repo, git.Head.to_full_path(path)) - -def unbare_repo(func): - """Methods with this decorator raise InvalidGitRepositoryError if they - encounter a bare repository""" - def wrapper(self, *args, **kwargs): - if self.repo.bare: - raise InvalidGitRepositoryError("Method '%s' cannot operate on bare repositories" % func.__name__) - #END bare method - return func(self, *args, **kwargs) - # END wrapper - wrapper.__name__ = func.__name__ - return wrapper - -def find_first_remote_branch(remotes, branch): - """Find the remote branch matching the name of the given branch or raise InvalidGitRepositoryError""" - for remote in remotes: - try: - return remote.refs[branch.name] - except IndexError: - continue - # END exception handling - #END for remote - raise InvalidGitRepositoryError("Didn't find remote branch %r in any of the given remotes", branch) - -#} END utilities - - -#{ Classes - -class SubmoduleConfigParser(GitConfigParser): - """ - Catches calls to _write, and updates the .gitmodules blob in the index - with the new data, if we have written into a stream. Otherwise it will - add the local file to the index to make it correspond with the working tree. - Additionally, the cache must be cleared - - Please note that no mutating method will work in bare mode - """ - - def __init__(self, *args, **kwargs): - self._smref = None - self._index = None - self._auto_write = True - super(SubmoduleConfigParser, self).__init__(*args, **kwargs) - - #{ Interface - def set_submodule(self, submodule): - """Set this instance's submodule. It must be called before - the first write operation begins""" - self._smref = weakref.ref(submodule) - - def flush_to_index(self): - """Flush changes in our configuration file to the index""" - assert self._smref is not None - # should always have a file here - assert not isinstance(self._file_or_files, StringIO) - - sm = self._smref() - if sm is not None: - index = self._index - if index is None: - index = sm.repo.index - # END handle index - index.add([sm.k_modules_file], write=self._auto_write) - sm._clear_cache() - # END handle weakref - - #} END interface - - #{ Overridden Methods - def write(self): - rval = super(SubmoduleConfigParser, self).write() - self.flush_to_index() - return rval - # END overridden methods - - -class Submodule(base.IndexObject, Iterable, Traversable): - """Implements access to a git submodule. They are special in that their sha - represents a commit in the submodule's repository which is to be checked out - at the path of this instance. - The submodule type does not have a string type associated with it, as it exists - solely as a marker in the tree and index. - - All methods work in bare and non-bare repositories.""" - - _id_attribute_ = "name" - k_modules_file = '.gitmodules' - k_head_option = 'branch' - k_head_default = 'master' - k_default_mode = stat.S_IFDIR | stat.S_IFLNK # submodules are directories with link-status - - # this is a bogus type for base class compatability - type = 'submodule' - - __slots__ = ('_parent_commit', '_url', '_branch', '_name', '__weakref__') - _cache_attrs = ('path', '_url', '_branch') - - def __init__(self, repo, binsha, mode=None, path=None, name = None, parent_commit=None, url=None, branch=None): - """Initialize this instance with its attributes. We only document the ones - that differ from ``IndexObject`` - :param repo: Our parent repository - :param binsha: binary sha referring to a commit in the remote repository, see url parameter - :param parent_commit: see set_parent_commit() - :param url: The url to the remote repository which is the submodule - :param branch: Head instance to checkout when cloning the remote repository""" - super(Submodule, self).__init__(repo, binsha, mode, path) - self.size = 0 - if parent_commit is not None: - self._parent_commit = parent_commit - if url is not None: - self._url = url - if branch is not None: - assert isinstance(branch, git.Head) - self._branch = branch - if name is not None: - self._name = name - - def _set_cache_(self, attr): - if attr == '_parent_commit': - # set a default value, which is the root tree of the current head - self._parent_commit = self.repo.commit() - elif attr in ('path', '_url', '_branch'): - reader = self.config_reader() - # default submodule values - self.path = reader.get_value('path') - self._url = reader.get_value('url') - # git-python extension values - optional - self._branch = mkhead(self.repo, reader.get_value(self.k_head_option, self.k_head_default)) - elif attr == '_name': - raise AttributeError("Cannot retrieve the name of a submodule if it was not set initially") - else: - super(Submodule, self)._set_cache_(attr) - # END handle attribute name - - def _get_intermediate_items(self, item): - """:return: all the submodules of our module repository""" - try: - return type(self).list_items(item.module()) - except InvalidGitRepositoryError: - return list() - # END handle intermeditate items - - def __eq__(self, other): - """Compare with another submodule""" - # we may only compare by name as this should be the ID they are hashed with - # Otherwise this type wouldn't be hashable - # return self.path == other.path and self.url == other.url and super(Submodule, self).__eq__(other) - return self._name == other._name - - def __ne__(self, other): - """Compare with another submodule for inequality""" - return not (self == other) - - def __hash__(self): - """Hash this instance using its logical id, not the sha""" - return hash(self._name) - - def __str__(self): - return self._name - - def __repr__(self): - return "git.%s(name=%s, path=%s, url=%s, branch=%s)" % (type(self).__name__, self._name, self.path, self.url, self.branch) - - @classmethod - def _config_parser(cls, repo, parent_commit, read_only): - """:return: Config Parser constrained to our submodule in read or write mode - :raise IOError: If the .gitmodules file cannot be found, either locally or in the repository - at the given parent commit. Otherwise the exception would be delayed until the first - access of the config parser""" - parent_matches_head = repo.head.commit == parent_commit - if not repo.bare and parent_matches_head: - fp_module = cls.k_modules_file - fp_module_path = os.path.join(repo.working_tree_dir, fp_module) - if not os.path.isfile(fp_module_path): - raise IOError("%s file was not accessible" % fp_module_path) - # END handle existance - fp_module = fp_module_path - else: - try: - fp_module = cls._sio_modules(parent_commit) - except KeyError: - raise IOError("Could not find %s file in the tree of parent commit %s" % (cls.k_modules_file, parent_commit)) - # END handle exceptions - # END handle non-bare working tree - - if not read_only and (repo.bare or not parent_matches_head): - raise ValueError("Cannot write blobs of 'historical' submodule configurations") - # END handle writes of historical submodules - - return SubmoduleConfigParser(fp_module, read_only = read_only) - - def _clear_cache(self): - # clear the possibly changed values - for name in self._cache_attrs: - try: - delattr(self, name) - except AttributeError: - pass - # END try attr deletion - # END for each name to delete - - @classmethod - def _sio_modules(cls, parent_commit): - """:return: Configuration file as StringIO - we only access it through the respective blob's data""" - sio = StringIO(parent_commit.tree[cls.k_modules_file].data_stream.read()) - sio.name = cls.k_modules_file - return sio - - def _config_parser_constrained(self, read_only): - """:return: Config Parser constrained to our submodule in read or write mode""" - parser = self._config_parser(self.repo, self._parent_commit, read_only) - parser.set_submodule(self) - return SectionConstraint(parser, sm_section(self.name)) - - #{ Edit Interface - - @classmethod - def add(cls, repo, name, path, url=None, branch=None, no_checkout=False): - """Add a new submodule to the given repository. This will alter the index - as well as the .gitmodules file, but will not create a new commit. - If the submodule already exists, no matter if the configuration differs - from the one provided, the existing submodule will be returned. - :param repo: Repository instance which should receive the submodule - :param name: The name/identifier for the submodule - :param path: repository-relative or absolute path at which the submodule - should be located - It will be created as required during the repository initialization. - :param url: git-clone compatible URL, see git-clone reference for more information - If None, the repository is assumed to exist, and the url of the first - remote is taken instead. This is useful if you want to make an existing - repository a submodule of anotherone. - :param branch: branch at which the submodule should (later) be checked out. - The given branch must exist in the remote repository, and will be checked - out locally as a tracking branch. - It will only be written into the configuration if it not None, which is - when the checked out branch will be the one the remote HEAD pointed to. - The result you get in these situation is somewhat fuzzy, and it is recommended - to specify at least 'master' here - :param no_checkout: if True, and if the repository has to be cloned manually, - no checkout will be performed - :return: The newly created submodule instance - :note: works atomically, such that no change will be done if the repository - update fails for instance""" - if repo.bare: - raise InvalidGitRepositoryError("Cannot add submodules to bare repositories") - # END handle bare repos - - path = to_native_path_linux(path) - if path.endswith('/'): - path = path[:-1] - # END handle trailing slash - - # INSTANTIATE INTERMEDIATE SM - sm = cls(repo, cls.NULL_BIN_SHA, cls.k_default_mode, path, name) - if sm.exists(): - # reretrieve submodule from tree - return repo.head.commit.tree[path] - # END handle existing - - br = mkhead(repo, branch or cls.k_head_default) - has_module = sm.module_exists() - branch_is_default = branch is None - if has_module and url is not None: - if url not in [r.url for r in sm.module().remotes]: - raise ValueError("Specified URL '%s' does not match any remote url of the repository at '%s'" % (url, sm.abspath)) - # END check url - # END verify urls match - - mrepo = None - if url is None: - if not has_module: - raise ValueError("A URL was not given and existing repository did not exsit at %s" % path) - # END check url - mrepo = sm.module() - urls = [r.url for r in mrepo.remotes] - if not urls: - raise ValueError("Didn't find any remote url in repository at %s" % sm.abspath) - # END verify we have url - url = urls[0] - else: - # clone new repo - kwargs = {'n' : no_checkout} - if not branch_is_default: - kwargs['b'] = str(br) - # END setup checkout-branch - mrepo = git.Repo.clone_from(url, path, **kwargs) - # END verify url - - # update configuration and index - index = sm.repo.index - writer = sm.config_writer(index=index, write=False) - writer.set_value('url', url) - writer.set_value('path', path) - - sm._url = url - if not branch_is_default: - # store full path - writer.set_value(cls.k_head_option, br.path) - sm._branch = br.path - # END handle path - del(writer) - - # NOTE: Have to write the repo config file as well, otherwise - # the default implementation will be offended and not update the repository - # Maybe this is a good way to assure it doesn't get into our way, but - # we want to stay backwards compatible too ... . Its so redundant ! - repo.config_writer().set_value(sm_section(sm.name), 'url', url) - - # we deliberatly assume that our head matches our index ! - pcommit = repo.head.commit - sm._parent_commit = pcommit - sm.binsha = mrepo.head.commit.binsha - index.add([sm], write=True) - - return sm - - def update(self, recursive=False, init=True, to_latest_revision=False): - """Update the repository of this submodule to point to the checkout - we point at with the binsha of this instance. - :param recursive: if True, we will operate recursively and update child- - modules as well. - :param init: if True, the module repository will be cloned into place if necessary - :param to_latest_revision: if True, the submodule's sha will be ignored during checkout. - Instead, the remote will be fetched, and the local tracking branch updated. - This only works if we have a local tracking branch, which is the case - if the remote repository had a master branch, or of the 'branch' option - was specified for this submodule and the branch existed remotely - :note: does nothing in bare repositories - :note: method is definitely not atomic if recurisve is True - :return: self""" - if self.repo.bare: - return self - #END pass in bare mode - - - # ASSURE REPO IS PRESENT AND UPTODATE - ##################################### - try: - mrepo = self.module() - for remote in mrepo.remotes: - remote.fetch() - #END fetch new data - except InvalidGitRepositoryError: - if not init: - return self - # END early abort if init is not allowed - import git - - # there is no git-repository yet - but delete empty paths - module_path = join_path_native(self.repo.working_tree_dir, self.path) - if os.path.isdir(module_path): - try: - os.rmdir(module_path) - except OSError: - raise OSError("Module directory at %r does already exist and is non-empty" % module_path) - # END handle OSError - # END handle directory removal - - # don't check it out at first - nonetheless it will create a local - # branch according to the remote-HEAD if possible - mrepo = git.Repo.clone_from(self.url, module_path, n=True) - - # see whether we have a valid branch to checkout - try: - # find a remote which has our branch - we try to be flexible - remote_branch = find_first_remote_branch(mrepo.remotes, self.branch) - local_branch = self.branch - if not local_branch.is_valid(): - # Setup a tracking configuration - branch doesn't need to - # exist to do that - local_branch.set_tracking_branch(remote_branch) - #END handle local branch - - # have a valid branch, but no checkout - make sure we can figure - # that out by marking the commit with a null_sha - # have to write it directly as .commit = NULLSHA tries to resolve the sha - # This will bring the branch into existance - refpath = join_path_native(mrepo.git_dir, local_branch.path) - refdir = os.path.dirname(refpath) - if not os.path.isdir(refdir): - os.makedirs(refdir) - #END handle directory - open(refpath, 'w').write(self.NULL_HEX_SHA) - # END initial checkout + branch creation - - # make sure HEAD is not detached - mrepo.head.ref = local_branch - except IndexError: - print >> sys.stderr, "Warning: Failed to checkout tracking branch %s" % self.branch - #END handle tracking branch - #END handle initalization - - - # DETERMINE SHAS TO CHECKOUT - ############################ - binsha = self.binsha - hexsha = self.hexsha - is_detached = mrepo.head.is_detached - if to_latest_revision: - msg_base = "Cannot update to latest revision in repository at %r as " % mrepo.working_dir - if not is_detached: - rref = mrepo.head.ref.tracking_branch() - if rref is not None: - rcommit = rref.commit - binsha = rcommit.binsha - hexsha = rcommit.hexsha - else: - print >> sys.stderr, "%s a tracking branch was not set for local branch '%s'" % (msg_base, mrepo.head.ref) - # END handle remote ref - else: - print >> sys.stderr, "%s there was no local tracking branch" % msg_base - # END handle detached head - # END handle to_latest_revision option - - # update the working tree - if mrepo.head.commit.binsha != binsha: - if is_detached: - mrepo.git.checkout(hexsha) - else: - # TODO: allow to specify a rebase, merge, or reset - # TODO: Warn if the hexsha forces the tracking branch off the remote - # branch - this should be prevented when setting the branch option - mrepo.head.reset(hexsha, index=True, working_tree=True) - # END handle checkout - # END update to new commit only if needed - - # HANDLE RECURSION - ################## - if recursive: - for submodule in self.iter_items(self.module()): - submodule.update(recursive, init, to_latest_revision) - # END handle recursive update - # END for each submodule - - return self - - @unbare_repo - def move(self, module_path, configuration=True, module=True): - """Move the submodule to a another module path. This involves physically moving - the repository at our current path, changing the configuration, as well as - adjusting our index entry accordingly. - :param module_path: the path to which to move our module, given as - repository-relative path. Intermediate directories will be created - accordingly. If the path already exists, it must be empty. - Trailling (back)slashes are removed automatically - :param configuration: if True, the configuration will be adjusted to let - the submodule point to the given path. - :param module: if True, the repository managed by this submodule - will be moved, not the configuration. This will effectively - leave your repository in an inconsistent state unless the configuration - and index already point to the target location. - :return: self - :raise ValueError: if the module path existed and was not empty, or was a file - :note: Currently the method is not atomic, and it could leave the repository - in an inconsistent state if a sub-step fails for some reason - """ - if module + configuration < 1: - raise ValueError("You must specify to move at least the module or the configuration of the submodule") - #END handle input - - module_path = to_native_path_linux(module_path) - if module_path.endswith('/'): - module_path = module_path[:-1] - # END handle trailing slash - - # VERIFY DESTINATION - if module_path == self.path: - return self - #END handle no change - - dest_path = join_path_native(self.repo.working_tree_dir, module_path) - if os.path.isfile(dest_path): - raise ValueError("Cannot move repository onto a file: %s" % dest_path) - # END handle target files - - index = self.repo.index - tekey = index.entry_key(module_path, 0) - # if the target item already exists, fail - if configuration and tekey in index.entries: - raise ValueError("Index entry for target path did alredy exist") - #END handle index key already there - - # remove existing destination - if module: - if os.path.exists(dest_path): - if len(os.listdir(dest_path)): - raise ValueError("Destination module directory was not empty") - #END handle non-emptyness - - if os.path.islink(dest_path): - os.remove(dest_path) - else: - os.rmdir(dest_path) - #END handle link - else: - # recreate parent directories - # NOTE: renames() does that now - pass - #END handle existance - # END handle module - - # move the module into place if possible - cur_path = self.abspath - renamed_module = False - if module and os.path.exists(cur_path): - os.renames(cur_path, dest_path) - renamed_module = True - #END move physical module - - - # rename the index entry - have to manipulate the index directly as - # git-mv cannot be used on submodules ... yeah - try: - if configuration: - try: - ekey = index.entry_key(self.path, 0) - entry = index.entries[ekey] - del(index.entries[ekey]) - nentry = git.IndexEntry(entry[:3]+(module_path,)+entry[4:]) - index.entries[tekey] = nentry - except KeyError: - raise InvalidGitRepositoryError("Submodule's entry at %r did not exist" % (self.path)) - #END handle submodule doesn't exist - - # update configuration - writer = self.config_writer(index=index) # auto-write - writer.set_value('path', module_path) - self.path = module_path - del(writer) - # END handle configuration flag - except Exception: - if renamed_module: - os.renames(dest_path, cur_path) - # END undo module renaming - raise - #END handle undo rename - - return self - - @unbare_repo - def remove(self, module=True, force=False, configuration=True, dry_run=False): - """Remove this submodule from the repository. This will remove our entry - from the .gitmodules file and the entry in the .git/config file. - :param module: If True, the module we point to will be deleted - as well. If the module is currently on a commit which is not part - of any branch in the remote, if the currently checked out branch - is ahead of its tracking branch, if you have modifications in the - working tree, or untracked files, - In case the removal of the repository fails for these reasons, the - submodule status will not have been altered. - If this submodule has child-modules on its own, these will be deleted - prior to touching the own module. - :param force: Enforces the deletion of the module even though it contains - modifications. This basically enforces a brute-force file system based - deletion. - :param configuration: if True, the submodule is deleted from the configuration, - otherwise it isn't. Although this should be enabled most of the times, - this flag enables you to safely delete the repository of your submodule. - :param dry_run: if True, we will not actually do anything, but throw the errors - we would usually throw - :return: self - :note: doesn't work in bare repositories - :raise InvalidGitRepositoryError: thrown if the repository cannot be deleted - :raise OSError: if directories or files could not be removed""" - if not (module + configuration): - raise ValueError("Need to specify to delete at least the module, or the configuration") - # END handle params - - # DELETE MODULE REPOSITORY - ########################## - if module and self.module_exists(): - if force: - # take the fast lane and just delete everything in our module path - # TODO: If we run into permission problems, we have a highly inconsistent - # state. Delete the .git folders last, start with the submodules first - mp = self.abspath - method = None - if os.path.islink(mp): - method = os.remove - elif os.path.isdir(mp): - method = shutil.rmtree - elif os.path.exists(mp): - raise AssertionError("Cannot forcibly delete repository as it was neither a link, nor a directory") - #END handle brutal deletion - if not dry_run: - assert method - method(mp) - #END apply deletion method - else: - # verify we may delete our module - mod = self.module() - if mod.is_dirty(untracked_files=True): - raise InvalidGitRepositoryError("Cannot delete module at %s with any modifications, unless force is specified" % mod.working_tree_dir) - # END check for dirt - - # figure out whether we have new commits compared to the remotes - # NOTE: If the user pulled all the time, the remote heads might - # not have been updated, so commits coming from the remote look - # as if they come from us. But we stay strictly read-only and - # don't fetch beforhand. - for remote in mod.remotes: - num_branches_with_new_commits = 0 - rrefs = remote.refs - for rref in rrefs: - num_branches_with_new_commits = len(mod.git.cherry(rref)) != 0 - # END for each remote ref - # not a single remote branch contained all our commits - if num_branches_with_new_commits == len(rrefs): - raise InvalidGitRepositoryError("Cannot delete module at %s as there are new commits" % mod.working_tree_dir) - # END handle new commits - # END for each remote - - # gently remove all submodule repositories - for sm in self.children(): - sm.remove(module=True, force=False, configuration=False, dry_run=dry_run) - # END for each child-submodule - - # finally delete our own submodule - if not dry_run: - shutil.rmtree(mod.working_tree_dir) - # END delete tree if possible - # END handle force - # END handle module deletion - - # DELETE CONFIGURATION - ###################### - if configuration and not dry_run: - # first the index-entry - index = self.repo.index - try: - del(index.entries[index.entry_key(self.path, 0)]) - except KeyError: - pass - #END delete entry - index.write() - - # now git config - need the config intact, otherwise we can't query - # inforamtion anymore - self.repo.config_writer().remove_section(sm_section(self.name)) - self.config_writer().remove_section() - # END delete configuration - - return self - - def set_parent_commit(self, commit, check=True): - """Set this instance to use the given commit whose tree is supposed to - contain the .gitmodules blob. - :param commit: Commit'ish reference pointing at the root_tree - :param check: if True, relatively expensive checks will be performed to verify - validity of the submodule. - :raise ValueError: if the commit's tree didn't contain the .gitmodules blob. - :raise ValueError: if the parent commit didn't store this submodule under the - current path - :return: self""" - pcommit = self.repo.commit(commit) - pctree = pcommit.tree - if self.k_modules_file not in pctree: - raise ValueError("Tree of commit %s did not contain the %s file" % (commit, self.k_modules_file)) - # END handle exceptions - - prev_pc = self._parent_commit - self._parent_commit = pcommit - - if check: - parser = self._config_parser(self.repo, self._parent_commit, read_only=True) - if not parser.has_section(sm_section(self.name)): - self._parent_commit = prev_pc - raise ValueError("Submodule at path %r did not exist in parent commit %s" % (self.path, commit)) - # END handle submodule did not exist - # END handle checking mode - - # update our sha, it could have changed - self.binsha = pctree[self.path].binsha - - self._clear_cache() - - return self - - @unbare_repo - def config_writer(self, index=None, write=True): - """:return: a config writer instance allowing you to read and write the data - belonging to this submodule into the .gitmodules file. - - :param index: if not None, an IndexFile instance which should be written. - defaults to the index of the Submodule's parent repository. - :param write: if True, the index will be written each time a configuration - value changes. - :note: the parameters allow for a more efficient writing of the index, - as you can pass in a modified index on your own, prevent automatic writing, - and write yourself once the whole operation is complete - :raise ValueError: if trying to get a writer on a parent_commit which does not - match the current head commit - :raise IOError: If the .gitmodules file/blob could not be read""" - writer = self._config_parser_constrained(read_only=False) - if index is not None: - writer.config._index = index - writer.config._auto_write = write - return writer - - #} END edit interface - - #{ Query Interface - - @unbare_repo - def module(self): - """:return: Repo instance initialized from the repository at our submodule path - :raise InvalidGitRepositoryError: if a repository was not available. This could - also mean that it was not yet initialized""" - # late import to workaround circular dependencies - module_path = self.abspath - try: - repo = git.Repo(module_path) - if repo != self.repo: - return repo - # END handle repo uninitialized - except (InvalidGitRepositoryError, NoSuchPathError): - raise InvalidGitRepositoryError("No valid repository at %s" % self.path) - else: - raise InvalidGitRepositoryError("Repository at %r was not yet checked out" % module_path) - # END handle exceptions - - def module_exists(self): - """:return: True if our module exists and is a valid git repository. See module() method""" - try: - self.module() - return True - except Exception: - return False - # END handle exception - - def exists(self): - """:return: True if the submodule exists, False otherwise. Please note that - a submodule may exist (in the .gitmodules file) even though its module - doesn't exist""" - # keep attributes for later, and restore them if we have no valid data - # this way we do not actually alter the state of the object - loc = locals() - for attr in self._cache_attrs: - if hasattr(self, attr): - loc[attr] = getattr(self, attr) - # END if we have the attribute cache - #END for each attr - self._clear_cache() - - try: - try: - self.path - return True - except Exception: - return False - # END handle exceptions - finally: - for attr in self._cache_attrs: - if attr in loc: - setattr(self, attr, loc[attr]) - # END if we have a cache - # END reapply each attribute - # END handle object state consistency - - @property - def branch(self): - """:return: The branch instance that we are to checkout""" - return self._branch - - @property - def url(self): - """:return: The url to the repository which our module-repository refers to""" - return self._url - - @property - def parent_commit(self): - """:return: Commit instance with the tree containing the .gitmodules file - :note: will always point to the current head's commit if it was not set explicitly""" - return self._parent_commit - - @property - def name(self): - """:return: The name of this submodule. It is used to identify it within the - .gitmodules file. - :note: by default, the name is the path at which to find the submodule, but - in git-python it should be a unique identifier similar to the identifiers - used for remotes, which allows to change the path of the submodule - easily - """ - return self._name - - def config_reader(self): - """:return: ConfigReader instance which allows you to qurey the configuration values - of this submodule, as provided by the .gitmodules file - :note: The config reader will actually read the data directly from the repository - and thus does not need nor care about your working tree. - :note: Should be cached by the caller and only kept as long as needed - :raise IOError: If the .gitmodules file/blob could not be read""" - return self._config_parser_constrained(read_only=True) - - def children(self): - """:return: IterableList(Submodule, ...) an iterable list of submodules instances - which are children of this submodule - :raise InvalidGitRepositoryError: if the submodule is not checked-out""" - return self._get_intermediate_items(self) - - #} END query interface - - #{ Iterable Interface - - @classmethod - def iter_items(cls, repo, parent_commit='HEAD'): - """:return: iterator yielding Submodule instances available in the given repository""" - pc = repo.commit(parent_commit) # parent commit instance - try: - parser = cls._config_parser(repo, pc, read_only=True) - except IOError: - raise StopIteration - # END handle empty iterator - - rt = pc.tree # root tree - - for sms in parser.sections(): - n = sm_name(sms) - p = parser.get_value(sms, 'path') - u = parser.get_value(sms, 'url') - b = cls.k_head_default - if parser.has_option(sms, cls.k_head_option): - b = parser.get_value(sms, cls.k_head_option) - # END handle optional information - - # get the binsha - index = repo.index - try: - sm = rt[p] - except KeyError: - # try the index, maybe it was just added - try: - entry = index.entries[index.entry_key(p, 0)] - sm = cls(repo, entry.binsha, entry.mode, entry.path) - except KeyError: - raise InvalidGitRepositoryError("Gitmodule path %r did not exist in revision of parent commit %s" % (p, parent_commit)) - # END handle keyerror - # END handle critical error - - # fill in remaining info - saves time as it doesn't have to be parsed again - sm._name = n - sm._parent_commit = pc - sm._branch = mkhead(repo, b) - sm._url = u - - yield sm - # END for each section - - #} END iterable interface - - -class RootModule(Submodule): - """A (virtual) Root of all submodules in the given repository. It can be used - to more easily traverse all submodules of the master repository""" - - __slots__ = tuple() - - k_root_name = '__ROOT__' - - def __init__(self, repo): - # repo, binsha, mode=None, path=None, name = None, parent_commit=None, url=None, ref=None) - super(RootModule, self).__init__( - repo, - binsha = self.NULL_BIN_SHA, - mode = self.k_default_mode, - path = '', - name = self.k_root_name, - parent_commit = repo.head.commit, - url = '', - branch = mkhead(repo, self.k_head_default) - ) - - - def _clear_cache(self): - """May not do anything""" - pass - - #{ Interface - - def update(self, previous_commit=None, recursive=True, force_remove=False, init=True, to_latest_revision=False): - """Update the submodules of this repository to the current HEAD commit. - This method behaves smartly by determining changes of the path of a submodules - repository, next to changes to the to-be-checked-out commit or the branch to be - checked out. This works if the submodules ID does not change. - Additionally it will detect addition and removal of submodules, which will be handled - gracefully. - - :param previous_commit: If set to a commit'ish, the commit we should use - as the previous commit the HEAD pointed to before it was set to the commit it points to now. - If None, it defaults to ORIG_HEAD otherwise, or the parent of the current - commit if it is not given - :param recursive: if True, the children of submodules will be updated as well - using the same technique - :param force_remove: If submodules have been deleted, they will be forcibly removed. - Otherwise the update may fail if a submodule's repository cannot be deleted as - changes have been made to it (see Submodule.update() for more information) - :param init: If we encounter a new module which would need to be initialized, then do it. - :param to_latest_revision: If True, instead of checking out the revision pointed to - by this submodule's sha, the checked out tracking branch will be merged with the - newest remote branch fetched from the repository's origin""" - if self.repo.bare: - raise InvalidGitRepositoryError("Cannot update submodules in bare repositories") - # END handle bare - - repo = self.repo - - # HANDLE COMMITS - ################## - cur_commit = repo.head.commit - if previous_commit is None: - symref = repo.head.orig_head() - try: - previous_commit = symref.commit - except Exception: - pcommits = cur_commit.parents - if pcommits: - previous_commit = pcommits[0] - else: - # in this special case, we just diff against ourselve, which - # means exactly no change - previous_commit = cur_commit - # END handle initial commit - # END no ORIG_HEAD - else: - previous_commit = repo.commit(previous_commit) # obtain commit object - # END handle previous commit - - - psms = self.list_items(repo, parent_commit=previous_commit) - sms = self.list_items(self.module()) - spsms = set(psms) - ssms = set(sms) - - # HANDLE REMOVALS - ################### - for rsm in (spsms - ssms): - # fake it into thinking its at the current commit to allow deletion - # of previous module. Trigger the cache to be updated before that - #rsm.url - rsm._parent_commit = repo.head.commit - rsm.remove(configuration=False, module=True, force=force_remove) - # END for each removed submodule - - # HANDLE PATH RENAMES - ##################### - # url changes + branch changes - for csm in (spsms & ssms): - psm = psms[csm.name] - sm = sms[csm.name] - - if sm.path != psm.path and psm.module_exists(): - # move the module to the new path - psm.move(sm.path, module=True, configuration=False) - # END handle path changes - - if sm.module_exists(): - # handle url change - if sm.url != psm.url: - # Add the new remote, remove the old one - # This way, if the url just changes, the commits will not - # have to be re-retrieved - nn = '__new_origin__' - smm = sm.module() - rmts = smm.remotes - - # don't do anything if we already have the url we search in place - if len([r for r in rmts if r.url == sm.url]) == 0: - - - assert nn not in [r.name for r in rmts] - smr = smm.create_remote(nn, sm.url) - smr.fetch() - - # If we have a tracking branch, it should be available - # in the new remote as well. - if len([r for r in smr.refs if r.remote_head == sm.branch.name]) == 0: - raise ValueError("Submodule branch named %r was not available in new submodule remote at %r" % (sm.branch.name, sm.url)) - # END head is not detached - - # now delete the changed one - rmt_for_deletion = None - for remote in rmts: - if remote.url == psm.url: - rmt_for_deletion = remote - break - # END if urls match - # END for each remote - - # if we didn't find a matching remote, but have exactly one, - # we can safely use this one - if rmt_for_deletion is None: - if len(rmts) == 1: - rmt_for_deletion = rmts[0] - else: - # if we have not found any remote with the original url - # we may not have a name. This is a special case, - # and its okay to fail here - # Alternatively we could just generate a unique name and leave all - # existing ones in place - raise InvalidGitRepositoryError("Couldn't find original remote-repo at url %r" % psm.url) - #END handle one single remote - # END handle check we found a remote - - orig_name = rmt_for_deletion.name - smm.delete_remote(rmt_for_deletion) - # NOTE: Currently we leave tags from the deleted remotes - # as well as separate tracking branches in the possibly totally - # changed repository ( someone could have changed the url to - # another project ). At some point, one might want to clean - # it up, but the danger is high to remove stuff the user - # has added explicitly - - # rename the new remote back to what it was - smr.rename(orig_name) - - # early on, we verified that the our current tracking branch - # exists in the remote. Now we have to assure that the - # sha we point to is still contained in the new remote - # tracking branch. - smsha = sm.binsha - found = False - rref = smr.refs[self.branch.name] - for c in rref.commit.traverse(): - if c.binsha == smsha: - found = True - break - # END traverse all commits in search for sha - # END for each commit - - if not found: - # adjust our internal binsha to use the one of the remote - # this way, it will be checked out in the next step - # This will change the submodule relative to us, so - # the user will be able to commit the change easily - print >> sys.stderr, "WARNING: Current sha %s was not contained in the tracking branch at the new remote, setting it the the remote's tracking branch" % sm.hexsha - sm.binsha = rref.commit.binsha - #END reset binsha - - #NOTE: All checkout is performed by the base implementation of update - - # END skip remote handling if new url already exists in module - # END handle url - - if sm.branch != psm.branch: - # finally, create a new tracking branch which tracks the - # new remote branch - smm = sm.module() - smmr = smm.remotes - try: - tbr = git.Head.create(smm, sm.branch.name) - except git.GitCommandError, e: - if e.status != 128: - raise - #END handle something unexpected - - # ... or reuse the existing one - tbr = git.Head(smm, git.Head.to_full_path(sm.branch.name)) - #END assure tracking branch exists - - tbr.set_tracking_branch(find_first_remote_branch(smmr, sm.branch)) - # figure out whether the previous tracking branch contains - # new commits compared to the other one, if not we can - # delete it. - try: - tbr = find_first_remote_branch(smmr, psm.branch) - if len(smm.git.cherry(tbr, psm.branch)) == 0: - psm.branch.delete(smm, psm.branch) - #END delete original tracking branch if there are no changes - except InvalidGitRepositoryError: - # ignore it if the previous branch couldn't be found in the - # current remotes, this just means we can't handle it - pass - # END exception handling - - #NOTE: All checkout is done in the base implementation of update - - #END handle branch - #END handle - # END for each common submodule - - # FINALLY UPDATE ALL ACTUAL SUBMODULES - ###################################### - for sm in sms: - # update the submodule using the default method - sm.update(recursive=True, init=init, to_latest_revision=to_latest_revision) - - # update recursively depth first - question is which inconsitent - # state will be better in case it fails somewhere. Defective branch - # or defective depth. The RootSubmodule type will never process itself, - # which was done in the previous expression - if recursive: - type(self)(sm.module()).update(recursive=True, force_remove=force_remove, - init=init, to_latest_revision=to_latest_revision) - #END handle recursive - # END for each submodule to update - - def module(self): - """:return: the actual repository containing the submodules""" - return self.repo - #} END interface -#} END classes -- cgit v1.2.1