normalize.c 13.5 KB
Newer Older
Ben Straub committed
1 2 3 4 5 6 7
#include "clar_libgit2.h"

#include "repository.h"
#include "git2/reflog.h"
#include "reflog.h"

// Helpers
8 9 10 11
static void ensure_refname_normalized(
	unsigned int flags,
	const char *input_refname,
	const char *expected_refname)
Ben Straub committed
12 13 14
{
	char buffer_out[GIT_REFNAME_MAX];

15
	cl_git_pass(git_reference_normalize_name(buffer_out, sizeof(buffer_out), input_refname, flags));
Ben Straub committed
16

17
	cl_assert_equal_s(expected_refname, buffer_out);
18
}
Ben Straub committed
19

20
static void ensure_refname_invalid(unsigned int flags, const char *input_refname)
21 22
{
	char buffer_out[GIT_REFNAME_MAX];
Ben Straub committed
23

24 25 26
	cl_assert_equal_i(
		GIT_EINVALIDSPEC,
		git_reference_normalize_name(buffer_out, sizeof(buffer_out), input_refname, flags));
Ben Straub committed
27 28
}

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
void test_refs_normalize__can_normalize_a_direct_reference_name(void)
{
	ensure_refname_normalized(
		GIT_REF_FORMAT_NORMAL, "refs/dummy/a", "refs/dummy/a");
	ensure_refname_normalized(
		GIT_REF_FORMAT_NORMAL, "refs/stash", "refs/stash");
	ensure_refname_normalized(
		GIT_REF_FORMAT_NORMAL, "refs/tags/a", "refs/tags/a");
	ensure_refname_normalized(
		GIT_REF_FORMAT_NORMAL, "refs/heads/a/b", "refs/heads/a/b");
	ensure_refname_normalized(
		GIT_REF_FORMAT_NORMAL, "refs/heads/a./b", "refs/heads/a./b");
	ensure_refname_normalized(
		GIT_REF_FORMAT_NORMAL, "refs/heads/v@ation", "refs/heads/v@ation");
	ensure_refname_normalized(
44
		GIT_REF_FORMAT_NORMAL, "refs///heads///a", "refs/heads/a");
45
}
Ben Straub committed
46

47
void test_refs_normalize__cannot_normalize_any_direct_reference_name(void)
Ben Straub committed
48
{
49 50 51 52 53 54 55 56 57
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "a");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "/a");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "//a");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "");
	ensure_refname_invalid(
58 59
		GIT_REF_FORMAT_NORMAL, "/refs/heads/a/");
	ensure_refname_invalid(
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
		GIT_REF_FORMAT_NORMAL, "refs/heads/a/");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "refs/heads/a.");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "refs/heads/a.lock");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "refs/heads/foo?bar");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "refs/heads\foo");
	ensure_refname_normalized(
		GIT_REF_FORMAT_NORMAL, "refs/heads/v@ation", "refs/heads/v@ation");
	ensure_refname_normalized(
		GIT_REF_FORMAT_NORMAL, "refs///heads///a", "refs/heads/a");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "refs/heads/.a/b");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "refs/heads/foo/../bar");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "refs/heads/foo..bar");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "refs/heads/./foo");
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "refs/heads/v@{ation");
Ben Straub committed
83 84 85 86
}

void test_refs_normalize__symbolic(void)
{
87 88 89 90 91
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "heads\foo");
	ensure_refname_invalid(
92 93
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "/");
	ensure_refname_invalid(
94 95 96
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "///");

	ensure_refname_normalized(
97
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "ALL_CAPS_AND_UNDERSCORES", "ALL_CAPS_AND_UNDERSCORES");
98
	ensure_refname_normalized(
99
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/MixedCasing", "refs/MixedCasing");
100 101 102 103 104 105 106 107 108
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs///heads///a", "refs/heads/a");

	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "HEAD", "HEAD");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "MERGE_HEAD", "MERGE_HEAD");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "FETCH_HEAD", "FETCH_HEAD");
Ben Straub committed
109 110 111
}

/* Ported from JGit, BSD licence.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
 * See https://github.com/spearce/JGit/commit/e4bf8f6957bbb29362575d641d1e77a02d906739
 *
 * Copyright (C) 2009, Google Inc.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 * - Neither the name of the Git Development Community nor the
 *   names of its contributors may be used to endorse or promote
 *   products derived from this software without specific prior
 *   written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
Ben Straub committed
150 151
void test_refs_normalize__jgit_suite(void)
{
152
	// tests borrowed from JGit
Ben Straub committed
153 154

/* EmptyString */
155 156 157 158
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "/");
Ben Straub committed
159 160

/* MustHaveTwoComponents */
161 162 163
	ensure_refname_invalid(
		GIT_REF_FORMAT_NORMAL, "master");
	ensure_refname_normalized(
164
		GIT_REF_FORMAT_NORMAL, "heads/master", "heads/master");
Ben Straub committed
165 166

/* ValidHead */
167 168 169 170 171 172 173 174
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master", "refs/heads/master");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/pu", "refs/heads/pu");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/z", "refs/heads/z");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/FoO", "refs/heads/FoO");
Ben Straub committed
175 176

/* ValidTag */
177 178
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/tags/v1.0", "refs/tags/v1.0");
Ben Straub committed
179 180

/* NoLockSuffix */
181
	ensure_refname_invalid(GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master.lock");
Ben Straub committed
182 183

/* NoDirectorySuffix */
184 185
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master/");
Ben Straub committed
186 187

/* NoSpace */
188 189
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/i haz space");
Ben Straub committed
190 191 192 193 194 195

/* NoAsciiControlCharacters */
	{
		char c;
		char buffer[GIT_REFNAME_MAX];
		for (c = '\1'; c < ' '; c++) {
196
			p_snprintf(buffer, sizeof(buffer), "refs/heads/mast%cer", c);
197
			ensure_refname_invalid(GIT_REF_FORMAT_ALLOW_ONELEVEL, buffer);
Ben Straub committed
198 199 200 201
		}
	}

/* NoBareDot */
202 203 204 205 206 207 208 209
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/.");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/..");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/./master");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/../master");
Ben Straub committed
210 211

/* NoLeadingOrTrailingDot */
212 213 214 215 216 217 218 219
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, ".");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/.bar");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/..bar");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/bar.");
Ben Straub committed
220 221

/* ContainsDot */
222 223 224 225
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/m.a.s.t.e.r", "refs/heads/m.a.s.t.e.r");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master..pu");
Ben Straub committed
226 227

/* NoMagicRefCharacters */
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master^");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/^master");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "^refs/heads/master");

	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master~");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/~master");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "~refs/heads/master");

	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master:");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/:master");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, ":refs/heads/master");
Ben Straub committed
248 249

/* ShellGlob */
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master?");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/?master");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "?refs/heads/master");

	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master[");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/[master");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "[refs/heads/master");

	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master*");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/*master");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "*refs/heads/master");
Ben Straub committed
270 271

/* ValidSpecialCharacters */
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
	ensure_refname_normalized
		(GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/!", "refs/heads/!");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/\"", "refs/heads/\"");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/#", "refs/heads/#");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/$", "refs/heads/$");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/%", "refs/heads/%");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/&", "refs/heads/&");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/'", "refs/heads/'");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/(", "refs/heads/(");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/)", "refs/heads/)");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/+", "refs/heads/+");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/,", "refs/heads/,");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/-", "refs/heads/-");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/;", "refs/heads/;");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/<", "refs/heads/<");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/=", "refs/heads/=");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/>", "refs/heads/>");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/@", "refs/heads/@");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/]", "refs/heads/]");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/_", "refs/heads/_");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/`", "refs/heads/`");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/{", "refs/heads/{");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/|", "refs/heads/|");
	ensure_refname_normalized(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/}", "refs/heads/}");
Ben Straub committed
318 319 320 321

	// This is valid on UNIX, but not on Windows
	// hence we make in invalid due to non-portability
	//
322 323
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/\\");
Ben Straub committed
324 325 326 327

/* UnicodeNames */
	/*
	 * Currently this fails.
328
	 * ensure_refname_normalized(GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/\u00e5ngstr\u00f6m", "refs/heads/\u00e5ngstr\u00f6m");
Ben Straub committed
329 330 331
	 */

/* RefLogQueryIsValidRef */
332 333 334 335 336 337 338 339 340 341 342
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master@{1}");
	ensure_refname_invalid(
		GIT_REF_FORMAT_ALLOW_ONELEVEL, "refs/heads/master@{1.hour.ago}");
}

void test_refs_normalize__buffer_has_to_be_big_enough_to_hold_the_normalized_version(void)
{
	char buffer_out[21];

	cl_git_pass(git_reference_normalize_name(
343
		buffer_out, 21, "refs//heads///long///name", GIT_REF_FORMAT_NORMAL));
344
	cl_git_fail(git_reference_normalize_name(
345
		buffer_out, 20, "refs//heads///long///name", GIT_REF_FORMAT_NORMAL));
Ben Straub committed
346
}
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

#define ONE_LEVEL_AND_REFSPEC \
	GIT_REF_FORMAT_ALLOW_ONELEVEL \
	| GIT_REF_FORMAT_REFSPEC_PATTERN

void test_refs_normalize__refspec_pattern(void)
{
	ensure_refname_invalid(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "heads/*foo/bar");
	ensure_refname_invalid(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "heads/foo*/bar");
	ensure_refname_invalid(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "heads/f*o/bar");

	ensure_refname_invalid(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "foo");
	ensure_refname_normalized(
364
		ONE_LEVEL_AND_REFSPEC, "FOO", "FOO");
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400

	ensure_refname_normalized(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "foo/bar", "foo/bar");
	ensure_refname_normalized(
		ONE_LEVEL_AND_REFSPEC, "foo/bar", "foo/bar");

	ensure_refname_normalized(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "*/foo", "*/foo");
	ensure_refname_normalized(
		ONE_LEVEL_AND_REFSPEC, "*/foo", "*/foo");

	ensure_refname_normalized(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "foo/*/bar", "foo/*/bar");
	ensure_refname_normalized(
		ONE_LEVEL_AND_REFSPEC, "foo/*/bar", "foo/*/bar");

	ensure_refname_invalid(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "*");
	ensure_refname_normalized(
		ONE_LEVEL_AND_REFSPEC, "*", "*");

	ensure_refname_invalid(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "foo/*/*");
	ensure_refname_invalid(
		ONE_LEVEL_AND_REFSPEC, "foo/*/*");

	ensure_refname_invalid(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "*/foo/*");
	ensure_refname_invalid(
		ONE_LEVEL_AND_REFSPEC, "*/foo/*");

	ensure_refname_invalid(
		GIT_REF_FORMAT_REFSPEC_PATTERN, "*/*/foo");
	ensure_refname_invalid(
		ONE_LEVEL_AND_REFSPEC, "*/*/foo");
}