Add support for git-credential-helper
This patch adds an additional field `options` to scm_dict, which can be
used to provide additional information to the backends.
It implements a single new option for GitWrapper. This option allows
setting a custom git credentials wrapper. This can be useful if Pungi
needs to get files from a git repository that requires authentication.
The helper can be as simple as this (assuming the username is already
provided in the url):
#!/bin/sh
echo password=i-am-secret
The helper would need to be referenced by an absolute path from the
pungi configuration, or prefixed with ! to have git interpret it as a
shell script and look it up in PATH.
See https://git-scm.com/docs/gitcredentials for more details.
Signed-off-by: Lubomír Sedlář <lsedlar@redhat.com>
JIRA: RHELCMP-11808
This commit is contained in:
Lubomír Sedlář
lsedlar
parent
e4c525ecbf
commit
ada8f4e346
8 changed files with 139 additions and 51 deletions
|
|
@ -21,6 +21,15 @@ from pungi import paths, checks
|
|||
from pungi.module_util import Modulemd
|
||||
|
||||
|
||||
GIT_WITH_CREDS = [
|
||||
"git",
|
||||
"-c",
|
||||
"credential.useHttpPath=true",
|
||||
"-c",
|
||||
"credential.helper=!ch",
|
||||
]
|
||||
|
||||
|
||||
class BaseTestCase(unittest.TestCase):
|
||||
def assertFilesEqual(self, fn1, fn2):
|
||||
with open(fn1, "rb") as f1:
|
||||
|
|
|
|||
|
|
@ -440,7 +440,7 @@ class LiveMediaConfigTestCase(ConfigTestCase):
|
|||
live_media_version="Rawhide",
|
||||
)
|
||||
|
||||
resolve_git_url.side_effect = lambda x: x.replace("HEAD", "CAFE")
|
||||
resolve_git_url.side_effect = lambda x, _helper: x.replace("HEAD", "CAFE")
|
||||
|
||||
self.assertValidation(cfg)
|
||||
self.assertEqual(cfg["live_media_ksurl"], "git://example.com/repo.git#CAFE")
|
||||
|
|
|
|||
|
|
@ -13,8 +13,10 @@ import random
|
|||
import os
|
||||
import six
|
||||
|
||||
from parameterized import parameterized
|
||||
|
||||
from pungi.wrappers import scm
|
||||
from tests.helpers import touch
|
||||
from tests.helpers import touch, GIT_WITH_CREDS
|
||||
from kobo.shortcuts import run
|
||||
|
||||
|
||||
|
|
@ -109,37 +111,45 @@ class FileSCMTestCase(SCMBaseTest):
|
|||
self.assertIn("No directories matched", str(ctx.exception))
|
||||
|
||||
|
||||
CREDENTIALS_CONFIG = {"credential_helper": "!ch"}
|
||||
|
||||
|
||||
class GitSCMTestCase(SCMBaseTest):
|
||||
def assertCalls(self, mock_run, url, branch, command=None):
|
||||
def assertCalls(self, mock_run, url, branch, command=None, with_creds=False):
|
||||
git = GIT_WITH_CREDS if with_creds else ["git"]
|
||||
command = [command] if command else []
|
||||
self.assertEqual(
|
||||
[call[0][0] for call in mock_run.call_args_list],
|
||||
[
|
||||
["git", "init"],
|
||||
["git", "fetch", "--depth=1", url, branch],
|
||||
git + ["fetch", "--depth=1", url, branch],
|
||||
["git", "checkout", "FETCH_HEAD"],
|
||||
]
|
||||
+ command,
|
||||
)
|
||||
|
||||
@mock.patch("pungi.wrappers.scm.run")
|
||||
def test_get_file(self, run):
|
||||
@parameterized.expand([("without_creds", {}), ("with_creds", CREDENTIALS_CONFIG)])
|
||||
def test_get_file(self, _name, config):
|
||||
def process(cmd, workdir=None, **kwargs):
|
||||
touch(os.path.join(workdir, "some_file.txt"))
|
||||
touch(os.path.join(workdir, "other_file.txt"))
|
||||
|
||||
run.side_effect = process
|
||||
with mock.patch("pungi.wrappers.scm.run") as run:
|
||||
run.side_effect = process
|
||||
retval = scm.get_file_from_scm(
|
||||
{
|
||||
"scm": "git",
|
||||
"repo": "git://example.com/git/repo.git",
|
||||
"file": "some_file.txt",
|
||||
"options": config,
|
||||
},
|
||||
self.destdir,
|
||||
)
|
||||
|
||||
retval = scm.get_file_from_scm(
|
||||
{
|
||||
"scm": "git",
|
||||
"repo": "git://example.com/git/repo.git",
|
||||
"file": "some_file.txt",
|
||||
},
|
||||
self.destdir,
|
||||
)
|
||||
self.assertStructure(retval, ["some_file.txt"])
|
||||
self.assertCalls(run, "git://example.com/git/repo.git", "master")
|
||||
self.assertCalls(
|
||||
run, "git://example.com/git/repo.git", "master", with_creds=bool(config)
|
||||
)
|
||||
|
||||
@mock.patch("pungi.wrappers.scm.run")
|
||||
def test_get_file_function(self, run):
|
||||
|
|
@ -163,9 +173,10 @@ class GitSCMTestCase(SCMBaseTest):
|
|||
self.assertEqual(retval, destination)
|
||||
self.assertCalls(run, "git://example.com/git/repo.git", "master")
|
||||
|
||||
@mock.patch("pungi.wrappers.scm.run")
|
||||
def test_get_file_fetch_fails(self, run):
|
||||
@parameterized.expand([("without_creds", {}), ("with_creds", CREDENTIALS_CONFIG)])
|
||||
def test_get_file_fetch_fails(self, _name, config):
|
||||
url = "git://example.com/git/repo.git"
|
||||
git = GIT_WITH_CREDS if config else ["git"]
|
||||
|
||||
def process(cmd, workdir=None, **kwargs):
|
||||
if "fetch" in cmd:
|
||||
|
|
@ -175,18 +186,20 @@ class GitSCMTestCase(SCMBaseTest):
|
|||
touch(os.path.join(workdir, "some_file.txt"))
|
||||
touch(os.path.join(workdir, "other_file.txt"))
|
||||
|
||||
run.side_effect = process
|
||||
with mock.patch("pungi.wrappers.scm.run") as run:
|
||||
run.side_effect = process
|
||||
retval = scm.get_file_from_scm(
|
||||
{"scm": "git", "repo": url, "file": "some_file.txt", "options": config},
|
||||
self.destdir,
|
||||
)
|
||||
|
||||
retval = scm.get_file_from_scm(
|
||||
{"scm": "git", "repo": url, "file": "some_file.txt"}, self.destdir
|
||||
)
|
||||
self.assertStructure(retval, ["some_file.txt"])
|
||||
self.assertEqual(
|
||||
[call[0][0] for call in run.call_args_list],
|
||||
[
|
||||
["git", "init"],
|
||||
[
|
||||
"git",
|
||||
git
|
||||
+ [
|
||||
"fetch",
|
||||
"--depth=1",
|
||||
"git://example.com/git/repo.git",
|
||||
|
|
@ -194,7 +207,7 @@ class GitSCMTestCase(SCMBaseTest):
|
|||
],
|
||||
["git", "init"],
|
||||
["git", "remote", "add", "origin", url],
|
||||
["git", "remote", "update", "origin"],
|
||||
git + ["remote", "update", "origin"],
|
||||
["git", "checkout", "master"],
|
||||
],
|
||||
)
|
||||
|
|
@ -243,20 +256,28 @@ class GitSCMTestCase(SCMBaseTest):
|
|||
|
||||
self.assertEqual(str(ctx.exception), "'make' failed with exit code 1")
|
||||
|
||||
@mock.patch("pungi.wrappers.scm.run")
|
||||
def test_get_dir(self, run):
|
||||
@parameterized.expand([("without_creds", {}), ("with_creds", CREDENTIALS_CONFIG)])
|
||||
def test_get_dir(self, _name, config):
|
||||
def process(cmd, workdir=None, **kwargs):
|
||||
touch(os.path.join(workdir, "subdir", "first"))
|
||||
touch(os.path.join(workdir, "subdir", "second"))
|
||||
|
||||
run.side_effect = process
|
||||
with mock.patch("pungi.wrappers.scm.run") as run:
|
||||
run.side_effect = process
|
||||
retval = scm.get_dir_from_scm(
|
||||
{
|
||||
"scm": "git",
|
||||
"repo": "git://example.com/git/repo.git",
|
||||
"dir": "subdir",
|
||||
"options": config,
|
||||
},
|
||||
self.destdir,
|
||||
)
|
||||
|
||||
retval = scm.get_dir_from_scm(
|
||||
{"scm": "git", "repo": "git://example.com/git/repo.git", "dir": "subdir"},
|
||||
self.destdir,
|
||||
)
|
||||
self.assertStructure(retval, ["first", "second"])
|
||||
self.assertCalls(run, "git://example.com/git/repo.git", "master")
|
||||
self.assertCalls(
|
||||
run, "git://example.com/git/repo.git", "master", with_creds=bool(config)
|
||||
)
|
||||
|
||||
@mock.patch("pungi.wrappers.scm.run")
|
||||
def test_get_dir_and_generate(self, run):
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ import six
|
|||
from pungi import compose
|
||||
from pungi import util
|
||||
|
||||
from tests.helpers import touch, PungiTestCase, mk_boom
|
||||
from tests.helpers import touch, PungiTestCase, mk_boom, GIT_WITH_CREDS
|
||||
|
||||
|
||||
class TestGitRefResolver(unittest.TestCase):
|
||||
|
|
@ -32,6 +32,20 @@ class TestGitRefResolver(unittest.TestCase):
|
|||
universal_newlines=True,
|
||||
)
|
||||
|
||||
@mock.patch("pungi.util.run")
|
||||
def test_successful_resolve_with_credentials(self, run):
|
||||
run.return_value = (0, "CAFEBABE\tHEAD\n")
|
||||
|
||||
url = util.resolve_git_url(
|
||||
"https://git.example.com/repo.git?somedir#HEAD", "!ch"
|
||||
)
|
||||
|
||||
self.assertEqual(url, "https://git.example.com/repo.git?somedir#CAFEBABE")
|
||||
run.assert_called_once_with(
|
||||
GIT_WITH_CREDS + ["ls-remote", "https://git.example.com/repo.git", "HEAD"],
|
||||
universal_newlines=True,
|
||||
)
|
||||
|
||||
@mock.patch("pungi.util.run")
|
||||
def test_successful_resolve_branch(self, run):
|
||||
run.return_value = (0, "CAFEBABE\trefs/heads/f24\n")
|
||||
|
|
@ -211,11 +225,12 @@ class TestGitRefResolver(unittest.TestCase):
|
|||
self.assertEqual(resolver(url2), "2")
|
||||
self.assertEqual(resolver(url3, ref2), "beef")
|
||||
self.assertEqual(
|
||||
mock_resolve_url.call_args_list, [mock.call(url1), mock.call(url2)]
|
||||
mock_resolve_url.call_args_list,
|
||||
[mock.call(url1, None), mock.call(url2, None)],
|
||||
)
|
||||
self.assertEqual(
|
||||
mock_resolve_ref.call_args_list,
|
||||
[mock.call(url3, ref1), mock.call(url3, ref2)],
|
||||
[mock.call(url3, ref1, None), mock.call(url3, ref2, None)],
|
||||
)
|
||||
|
||||
@mock.patch("pungi.util.resolve_git_url")
|
||||
|
|
@ -227,7 +242,7 @@ class TestGitRefResolver(unittest.TestCase):
|
|||
resolver(url)
|
||||
with self.assertRaises(util.GitUrlResolveError):
|
||||
resolver(url)
|
||||
self.assertEqual(mock_resolve.call_args_list, [mock.call(url)])
|
||||
self.assertEqual(mock_resolve.call_args_list, [mock.call(url, None)])
|
||||
|
||||
|
||||
class TestGetVariantData(unittest.TestCase):
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue