1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-12-03 04:02:43 +01:00
phorge-phorge/src/applications/diffusion/query/branch/git/DiffusionGitBranchQuery.php

115 lines
3.4 KiB
PHP
Raw Normal View History

<?php
/*
Allow Git repositories to track only some branches Summary: Some installs use Git as the backbone of a CI framework or use a Git remote to share patches. The tracker scripts currently recognize associated revisions as "Committed" when they appear in any branch, even if that branch is "alincoln-personal-development_test_hack" or whatever. To address the broadest need here, allow Git repositories to be configured to track only certain branches instead of all branches. This doesn't allow you to import a branch into Diffusion but ignore it in Differential. Supporting that is somewhat technically complicated because the parser currently goes like this: - Look at HEAD of all branches. - For any commits we haven't seen before, follow them back to something we have seen (or the root). - "Discover" everything new. Since this doesn't track <branch, commit> pairs, we currently don't have enough information to tell when a commit appears in a branch for the first time, so we don't have anywhere we can put a test for whether that branch is tracked and do the Differential hook only if it is. However, I think this cruder patch satisfies most of the need and is simple and obvious in its implementation. See also D1263. Test Plan: - Updated a Git repository with various filters: "", "master, remote", "derp", " ,,, master ,,,,," - Edited SVN and Mercurial repositories to verify they didn't get caught in the crossfire. - Ran daemon in debug mode on libphutil with filter "derp", got exception about no tracked branches. Ran with filter "master", got tracking. Ran with no filter, got tracking. - Looked at Diffusion with "derp" and "master", saw no branches and "master" respectively. - Added unit tests to cover filtering logic. Reviewers: btrahan, jungejason, nh, fratrik Reviewed By: fratrik CC: aran, fratrik, epriestley Maniphest Tasks: T270 Differential Revision: https://secure.phabricator.com/D1290
2011-12-29 18:14:55 +01:00
* Copyright 2012 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
final class DiffusionGitBranchQuery extends DiffusionBranchQuery {
protected function executeQuery() {
$drequest = $this->getRequest();
$repository = $drequest->getRepository();
$local_path = $repository->getDetail('local-path');
list($stdout) = $repository->execxLocalCommand(
'branch -r --verbose --no-abbrev');
$branch_list = self::parseGitRemoteBranchOutput(
$stdout,
$only_this_remote = DiffusionBranchInformation::DEFAULT_GIT_REMOTE);
$branches = array();
foreach ($branch_list as $name => $head) {
Allow Git repositories to track only some branches Summary: Some installs use Git as the backbone of a CI framework or use a Git remote to share patches. The tracker scripts currently recognize associated revisions as "Committed" when they appear in any branch, even if that branch is "alincoln-personal-development_test_hack" or whatever. To address the broadest need here, allow Git repositories to be configured to track only certain branches instead of all branches. This doesn't allow you to import a branch into Diffusion but ignore it in Differential. Supporting that is somewhat technically complicated because the parser currently goes like this: - Look at HEAD of all branches. - For any commits we haven't seen before, follow them back to something we have seen (or the root). - "Discover" everything new. Since this doesn't track <branch, commit> pairs, we currently don't have enough information to tell when a commit appears in a branch for the first time, so we don't have anywhere we can put a test for whether that branch is tracked and do the Differential hook only if it is. However, I think this cruder patch satisfies most of the need and is simple and obvious in its implementation. See also D1263. Test Plan: - Updated a Git repository with various filters: "", "master, remote", "derp", " ,,, master ,,,,," - Edited SVN and Mercurial repositories to verify they didn't get caught in the crossfire. - Ran daemon in debug mode on libphutil with filter "derp", got exception about no tracked branches. Ran with filter "master", got tracking. Ran with no filter, got tracking. - Looked at Diffusion with "derp" and "master", saw no branches and "master" respectively. - Added unit tests to cover filtering logic. Reviewers: btrahan, jungejason, nh, fratrik Reviewed By: fratrik CC: aran, fratrik, epriestley Maniphest Tasks: T270 Differential Revision: https://secure.phabricator.com/D1290
2011-12-29 18:14:55 +01:00
if (!$repository->shouldTrackBranch($name)) {
continue;
}
2011-03-21 01:46:02 +01:00
$branch = new DiffusionBranchInformation();
$branch->setName($name);
$branch->setHeadCommitIdentifier($head);
$branches[] = $branch;
}
return $branches;
}
/**
* Parse the output of 'git branch -r --verbose --no-abbrev' or similar into
* a map. For instance:
*
* array(
* 'origin/master' => '99a9c082f9a1b68c7264e26b9e552484a5ae5f25',
* );
*
* If you specify $only_this_remote, branches will be filtered to only those
* on the given remote, **and the remote name will be stripped**. For example:
*
* array(
* 'master' => '99a9c082f9a1b68c7264e26b9e552484a5ae5f25',
* );
*
* @param string stdout of git branch command.
* @param string Filter branches to those on a specific remote.
* @return map Map of 'branch' or 'remote/branch' to hash at HEAD.
*/
public static function parseGitRemoteBranchOutput(
$stdout,
$only_this_remote = null) {
2011-03-21 01:46:02 +01:00
$map = array();
$lines = array_filter(explode("\n", $stdout));
foreach ($lines as $line) {
$matches = null;
2011-03-21 01:46:02 +01:00
if (preg_match('/^ (\S+)\s+-> (\S+)$/', $line, $matches)) {
// This is a line like:
//
// origin/HEAD -> origin/master
//
// ...which we don't currently do anything interesting with, although
// in theory we could use it to automatically choose the default
// branch.
continue;
}
if (!preg_match('/^[ *] (\S+)\s+([a-z0-9]{40}) /', $line, $matches)) {
throw new Exception("Failed to parse {$line}!");
}
$remote_branch = $matches[1];
$branch_head = $matches[2];
if ($only_this_remote) {
$matches = null;
if (!preg_match('#^([^/]+)/(.*)$#', $remote_branch, $matches)) {
throw new Exception(
"Failed to parse remote branch '{$remote_branch}'!");
}
$remote_name = $matches[1];
$branch_name = $matches[2];
if ($remote_name != $only_this_remote) {
continue;
}
$map[$branch_name] = $branch_head;
} else {
$map[$remote_branch] = $branch_head;
}
}
2011-03-21 01:46:02 +01:00
return $map;
}
}