Skip to content

Add init_submodules and update_submodules interfaces #692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 22, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 137 additions & 0 deletions src/repository.c
Original file line number Diff line number Diff line change
Expand Up @@ -1288,6 +1288,141 @@ Repository_listall_submodules(Repository *self, PyObject *args)
}


PyDoc_STRVAR(Repository_init_submodules__doc__,
"init_submodule(submodules=None, overwrite=False)\n"
"\n"
"Initialize all submodules in repository.\n"
"submodules: List of submodules to initialize. Default argument initializes all submodules.\n"
"overwrite: Flag indicating if initialization should overwrite submodule entries.\n");

static int foreach_sub_init_cb(git_submodule *submodule, const char *name, void *payload)
{
return git_submodule_init(submodule, *(int*)payload);
}

PyObject *
Repository_init_submodules(Repository* self, PyObject *args, PyObject *kwds)
{
PyObject *list = Py_None;
PyObject *oflag = Py_False;
char *kwlist[] = {"submodules", "overwrite", NULL};
int err, fflag;
PyObject *iter, *subpath, *next;
const char *c_subpath;
git_submodule *submodule;

if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OO", kwlist, &list, &oflag))
return NULL;

fflag = PyObject_IsTrue(oflag);

if (fflag != 0 && fflag != 1)
fflag = 0;

//Init all submodules listed in repository
if (list == Py_None) {
err = git_submodule_foreach(self->repo, foreach_sub_init_cb, &fflag);
if (err != 0)
return Error_set(err);
Py_RETURN_NONE;
}

iter = PyObject_GetIter(list);
if (!iter)
return NULL;

while (1) {
next = PyIter_Next(iter);
if (!next)
break;

c_subpath = py_str_borrow_c_str(&subpath, next, NULL);

git_submodule_lookup(&submodule, self->repo, c_subpath);
Py_DECREF(subpath);
if (!submodule) {
PyErr_SetString(PyExc_KeyError,
"Submodule does not exist");
return NULL;
}

err = git_submodule_init(submodule, fflag);
if (err != 0) {
return Error_set(err);
}
}

Py_RETURN_NONE;
}

PyDoc_STRVAR(Repository_update_submodules__doc__,
"update_submodules(submodules=None, init=False)\n"
"\n"
"Updates the specified submodules, or all if None are specified\n"
"init: Flag indicating if submodules should be automatically initialized if necessary.\n");

static int foreach_sub_update_cb(git_submodule *submodule, const char *name, void *payload)
{
git_submodule_update_options opts = GIT_SUBMODULE_UPDATE_OPTIONS_INIT;
return git_submodule_update(submodule, *(int*)payload, &opts);
}

PyObject *
Repository_update_submodules(Repository *self, PyObject *args, PyObject *kwds)
{
PyObject *list = Py_None;
PyObject *py_init = Py_False;
PyObject *iter, *next, *subpath;
int init, err;
const char *c_subpath;
git_submodule *submodule;
git_submodule_update_options opts = GIT_SUBMODULE_UPDATE_OPTIONS_INIT;

char *kwlist[] = {"submodules", "init", NULL};

if (!PyArg_ParseTupleAndKeywords(args, kwds, "|OO", kwlist, &list, &py_init))
return NULL;

init = PyObject_IsTrue(py_init);

if (init != 0 && init != 1)
init = 0;

if (list == Py_None) {
err = git_submodule_foreach(self->repo, foreach_sub_update_cb, &init);
if (err != 0)
return Error_set(err);
Py_RETURN_NONE;
}

iter = PyObject_GetIter(list);
if (!iter)
return NULL;

while (1) {
next = PyIter_Next(iter);
if (!next)
break;

c_subpath = py_str_borrow_c_str(&subpath, next, NULL);

git_submodule_lookup(&submodule, self->repo, c_subpath);
Py_DECREF(subpath);
if (!submodule) {
PyErr_SetString(PyExc_KeyError,
"Submodule does not exist");
return NULL;
}

err = git_submodule_update(submodule, init, &opts);
if (err != 0) {
return Error_set(err);
}
}

Py_RETURN_NONE;
}

PyDoc_STRVAR(Repository_lookup_reference__doc__,
"lookup_reference(name) -> Reference\n"
"\n"
Expand Down Expand Up @@ -1714,6 +1849,8 @@ PyMethodDef Repository_methods[] = {
METHOD(Repository, listall_references, METH_NOARGS),
METHOD(Repository, listall_reference_objects, METH_NOARGS),
METHOD(Repository, listall_submodules, METH_NOARGS),
METHOD(Repository, init_submodules, METH_VARARGS | METH_KEYWORDS),
METHOD(Repository, update_submodules, METH_VARARGS | METH_KEYWORDS),
METHOD(Repository, lookup_reference, METH_O),
METHOD(Repository, revparse_single, METH_O),
METHOD(Repository, status, METH_NOARGS),
Expand Down
Binary file modified test/data/submodulerepo.tar
Binary file not shown.
28 changes: 26 additions & 2 deletions test/test_submodule.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,17 @@
# Import from the future
from __future__ import absolute_import

import os

import pygit2
import unittest

from . import utils

SUBM_NAME = 'submodule'
SUBM_PATH = 'submodule'
SUBM_URL = 'test.com/submodule.git'
SUBM_HEAD_SHA = '784855caf26449a1914d2cf62d12b9374d76ae78'
SUBM_URL = 'https://github.com/libgit2/pygit2'
SUBM_HEAD_SHA = '819cbff552e46ac4b8d10925cc422a30aa04e78e'

class SubmoduleTest(utils.SubmoduleRepoTestCase):

Expand All @@ -53,6 +55,8 @@ def test_listall_submodules(self):

def test_submodule_open(self):
s = self.repo.lookup_submodule(SUBM_PATH)
self.repo.init_submodules()
self.repo.update_submodules()
r = s.open()
self.assertIsNotNone(r)
self.assertEqual(str(r.head.target), SUBM_HEAD_SHA)
Expand All @@ -69,5 +73,25 @@ def test_url(self):
s = self.repo.lookup_submodule(SUBM_PATH)
self.assertEqual(SUBM_URL, s.url)

def test_init_and_update(self):
subrepo_file_path = os.path.join(self.repo_path, 'submodule', 'setup.py')
self.assertFalse(os.path.exists(subrepo_file_path))
self.repo.init_submodules()
self.repo.update_submodules()
self.assertTrue(os.path.exists(subrepo_file_path))

def test_specified_update(self):
subrepo_file_path = os.path.join(self.repo_path, 'submodule', 'setup.py')
self.assertFalse(os.path.exists(subrepo_file_path))
self.repo.init_submodules(submodules=['submodule'])
self.repo.update_submodules(submodules=['submodule'])
self.assertTrue(os.path.exists(subrepo_file_path))

def test_oneshot_update(self):
subrepo_file_path = os.path.join(self.repo_path, 'submodule', 'setup.py')
self.assertFalse(os.path.exists(subrepo_file_path))
self.repo.update_submodules(init=True)
self.assertTrue(os.path.exists(subrepo_file_path))

if __name__ == '__main__':
unittest.main()