Commit eff14d384c3b0696e3ef0979bfc58d5558a2ab23

Russell Belfer 2012-09-10T23:15:54

Merge pull request #906 from nulltoken/topic/git_reference_peel git reference peel

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
diff --git a/include/git2/checkout.h b/include/git2/checkout.h
index ac31b34..deb8287 100644
--- a/include/git2/checkout.h
+++ b/include/git2/checkout.h
@@ -40,13 +40,13 @@ typedef struct git_checkout_opts {
  * @param repo repository to check out (must be non-bare)
  * @param opts specifies checkout options (may be NULL)
  * @param stats structure through which progress information is reported
- * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information about the error)
+ * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information
+ * about the error)
  */
-GIT_EXTERN(int) git_checkout_head(git_repository *repo,
-											 git_checkout_opts *opts,
-											 git_indexer_stats *stats);
-
-
+GIT_EXTERN(int) git_checkout_head(
+	git_repository *repo,
+	git_checkout_opts *opts,
+	git_indexer_stats *stats);
 
 /**
  * Updates files in the working tree to match a commit pointed to by a ref.
@@ -54,11 +54,13 @@ GIT_EXTERN(int) git_checkout_head(git_repository *repo,
  * @param ref reference to follow to a commit
  * @param opts specifies checkout options (may be NULL)
  * @param stats structure through which progress information is reported
- * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information about the error)
+ * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information
+ * about the error)
  */
-GIT_EXTERN(int) git_checkout_reference(git_reference *ref,
-													git_checkout_opts *opts,
-													git_indexer_stats *stats);
+GIT_EXTERN(int) git_checkout_reference(
+	git_reference *ref,
+	git_checkout_opts *opts,
+	git_indexer_stats *stats);
 
 
 /** @} */
diff --git a/include/git2/errors.h b/include/git2/errors.h
index f6671c4..e5f4359 100644
--- a/include/git2/errors.h
+++ b/include/git2/errors.h
@@ -26,6 +26,7 @@ enum {
 	GIT_EAMBIGUOUS = -5,
 	GIT_EBUFS = -6,
 	GIT_EUSER = -7,
+	GIT_EBAREREPO = -8,
 
 	GIT_PASSTHROUGH = -30,
 	GIT_ITEROVER = -31,
diff --git a/include/git2/refs.h b/include/git2/refs.h
index 660b48b..73b32a9 100644
--- a/include/git2/refs.h
+++ b/include/git2/refs.h
@@ -434,6 +434,26 @@ GIT_EXTERN(int) git_reference_normalize_name(
 	const char *name,
 	unsigned int flags);
 
+/**
+ * Recursively peel an reference until an object of the
+ * specified type is met.
+ *
+ * The retrieved `peeled` object is owned by the repository
+ * and should be closed with the `git_object_free` method.
+ *
+ * If you pass `GIT_OBJ_ANY` as the target type, then the object
+ * will be peeled until a non-tag object is met.
+ *
+ * @param peeled Pointer to the peeled git_object
+ * @param ref The reference to be processed
+ * @param target_type The type of the requested object
+ * @return 0 or an error code
+ */
+GIT_EXTERN(int) git_reference_peel(
+	git_object **out,
+	git_reference *ref,
+	git_otype type);
+
 /** @} */
 GIT_END_DECL
 #endif
diff --git a/src/blob.c b/src/blob.c
index 699adec..5a4a26b 100644
--- a/src/blob.c
+++ b/src/blob.c
@@ -212,8 +212,10 @@ int git_blob_create_fromfile(git_oid *oid, git_repository *repo, const char *pat
 	const char *workdir;
 	int error;
 
+	if ((error = git_repository__ensure_not_bare(repo, "create blob from file")) < 0)
+		return error;
+
 	workdir = git_repository_workdir(repo);
-	assert(workdir); /* error to call this on bare repo */
 
 	if (git_buf_joinpath(&full_path, workdir, path) < 0) {
 		git_buf_free(&full_path);
diff --git a/src/checkout.c b/src/checkout.c
index 88df212..d1720fc 100644
--- a/src/checkout.c
+++ b/src/checkout.c
@@ -22,9 +22,6 @@
 #include "filter.h"
 #include "blob.h"
 
-GIT_BEGIN_DECL
-
-
 typedef struct tree_walk_data
 {
 	git_indexer_stats *stats;
@@ -226,6 +223,3 @@ int git_checkout_reference(git_reference *ref,
 	git_reference_free(head);
 	return retcode;
 }
-
-
-GIT_END_DECL
diff --git a/src/clone.c b/src/clone.c
index 33953d7..e06e9ad 100644
--- a/src/clone.c
+++ b/src/clone.c
@@ -26,8 +26,6 @@
 #include "refs.h"
 #include "path.h"
 
-GIT_BEGIN_DECL
-
 struct HeadInfo {
 	git_repository *repo;
 	git_oid remote_head_oid;
@@ -247,8 +245,3 @@ int git_clone(git_repository **out,
 
 	return retcode;
 }
-
-
-
-
-GIT_END_DECL
diff --git a/src/iterator.c b/src/iterator.c
index 92fe671..e30e112 100644
--- a/src/iterator.c
+++ b/src/iterator.c
@@ -659,11 +659,8 @@ int git_iterator_for_workdir_range(
 
 	assert(iter && repo);
 
-	if (git_repository_is_bare(repo)) {
-		giterr_set(GITERR_INVALID,
-			"Cannot scan working directory for bare repo");
-		return -1;
-	}
+	if ((error = git_repository__ensure_not_bare(repo, "scan working directory")) < 0)
+		return error;
 
 	ITERATOR_BASE_INIT(wi, workdir, WORKDIR);
 
diff --git a/src/refs.c b/src/refs.c
index 211a587..cdf3cb9 100644
--- a/src/refs.c
+++ b/src/refs.c
@@ -1844,3 +1844,50 @@ int git_reference_is_remote(git_reference *ref)
 	assert(ref);
 	return git__prefixcmp(ref->name, GIT_REFS_REMOTES_DIR) == 0;
 }
+
+static int peel_error(int error, git_reference *ref, const char* msg)
+{
+	giterr_set(
+		GITERR_INVALID,
+		"The reference '%s' cannot be peeled - %s", git_reference_name(ref), msg);
+	return error;
+}
+
+static int reference_target(git_object **object, git_reference *ref)
+{
+	const git_oid *oid;
+
+	oid = git_reference_oid(ref);
+
+	return git_object_lookup(object, git_reference_owner(ref), oid, GIT_OBJ_ANY);
+}
+
+int git_reference_peel(
+		git_object **peeled,
+		git_reference *ref,
+		git_otype target_type)
+{
+	git_reference *resolved = NULL;
+	git_object *target = NULL;
+	int error;
+
+	assert(ref);
+
+	if ((error = git_reference_resolve(&resolved, ref)) < 0)
+		return peel_error(error, ref, "Cannot resolve reference");
+
+	if ((error = reference_target(&target, resolved)) < 0) {
+		peel_error(error, ref, "Cannot retrieve reference target");
+		goto cleanup;
+	}
+	
+	if (target_type == GIT_OBJ_ANY && git_object_type(target) != GIT_OBJ_TAG)
+		error = git_object__dup(peeled, target);
+	else 
+		error = git_object_peel(peeled, target, target_type);
+
+cleanup:
+	git_object_free(target);
+	git_reference_free(resolved);
+	return error;
+}
diff --git a/src/repository.h b/src/repository.h
index 4695edf..4aa8af2 100644
--- a/src/repository.h
+++ b/src/repository.h
@@ -149,4 +149,19 @@ void git_repository__cvar_cache_clear(git_repository *repo);
  */
 extern void git_submodule_config_free(git_repository *repo);
 
+GIT_INLINE(int) git_repository__ensure_not_bare(
+	git_repository *repo,
+	const char *operation_name)
+{
+	if (!git_repository_is_bare(repo))
+		return 0;
+
+	giterr_set(
+		GITERR_REPOSITORY,
+		"Cannot %s. This operation is not allowed against bare repositories.",
+		operation_name);
+
+	return GIT_EBAREREPO;
+}
+
 #endif
diff --git a/src/reset.c b/src/reset.c
index f9e16f7..5aaf948 100644
--- a/src/reset.c
+++ b/src/reset.c
@@ -34,8 +34,9 @@ int git_reset(
 	if (git_object_owner(target) != repo)
 		return reset_error_invalid("The given target does not belong to this repository.");
 
-	if (reset_type == GIT_RESET_MIXED && git_repository_is_bare(repo))
-		return reset_error_invalid("Mixed reset is not allowed in a bare repository.");
+	if (reset_type == GIT_RESET_MIXED
+		&& git_repository__ensure_not_bare(repo, "reset mixed") < 0)
+		return GIT_EBAREREPO;
 
 	if (git_object_peel(&commit, target, GIT_OBJ_COMMIT) < 0) {
 		reset_error_invalid("The given target does not resolve to a commit");
diff --git a/tests-clar/object/peel.c b/tests-clar/object/peel.c
index f4ea1eb..f748be7 100644
--- a/tests-clar/object/peel.c
+++ b/tests-clar/object/peel.c
@@ -12,7 +12,11 @@ void test_object_peel__cleanup(void)
 	git_repository_free(g_repo);
 }
 
-static void assert_peel(const char* expected_sha, const char *sha, git_otype requested_type)
+static void assert_peel(
+	const char *sha,
+	git_otype requested_type,
+	const char* expected_sha,
+	git_otype expected_type)
 {
 	git_oid oid, expected_oid;
 	git_object *obj;
@@ -26,6 +30,8 @@ static void assert_peel(const char* expected_sha, const char *sha, git_otype req
 	cl_git_pass(git_oid_fromstr(&expected_oid, expected_sha));
 	cl_assert_equal_i(0, git_oid_cmp(&expected_oid, git_object_id(peeled)));
 
+	cl_assert_equal_i(expected_type, git_object_type(peeled));
+
 	git_object_free(peeled);
 	git_object_free(obj);
 }
@@ -46,21 +52,28 @@ static void assert_peel_error(int error, const char *sha, git_otype requested_ty
 
 void test_object_peel__peeling_an_object_into_its_own_type_returns_another_instance_of_it(void)
 {
-	assert_peel("e90810b8df3e80c413d903f631643c716887138d", "e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_COMMIT);
-	assert_peel("7b4384978d2493e851f9cca7858815fac9b10980", "7b4384978d2493e851f9cca7858815fac9b10980", GIT_OBJ_TAG);
-	assert_peel("53fc32d17276939fc79ed05badaef2db09990016", "53fc32d17276939fc79ed05badaef2db09990016", GIT_OBJ_TREE);
-	assert_peel("0266163a49e280c4f5ed1e08facd36a2bd716bcf", "0266163a49e280c4f5ed1e08facd36a2bd716bcf", GIT_OBJ_BLOB);
+	assert_peel("e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_COMMIT,
+		"e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_COMMIT);
+	assert_peel("7b4384978d2493e851f9cca7858815fac9b10980", GIT_OBJ_TAG,
+		"7b4384978d2493e851f9cca7858815fac9b10980", GIT_OBJ_TAG);
+	assert_peel("53fc32d17276939fc79ed05badaef2db09990016", GIT_OBJ_TREE,
+		"53fc32d17276939fc79ed05badaef2db09990016", GIT_OBJ_TREE);
+	assert_peel("0266163a49e280c4f5ed1e08facd36a2bd716bcf", GIT_OBJ_BLOB,
+		"0266163a49e280c4f5ed1e08facd36a2bd716bcf", GIT_OBJ_BLOB);
 }
 
 void test_object_peel__can_peel_a_tag(void)
 {
-	assert_peel("e90810b8df3e80c413d903f631643c716887138d", "7b4384978d2493e851f9cca7858815fac9b10980", GIT_OBJ_COMMIT);
-	assert_peel("53fc32d17276939fc79ed05badaef2db09990016", "7b4384978d2493e851f9cca7858815fac9b10980", GIT_OBJ_TREE);
+	assert_peel("7b4384978d2493e851f9cca7858815fac9b10980", GIT_OBJ_COMMIT,
+		"e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_COMMIT);
+	assert_peel("7b4384978d2493e851f9cca7858815fac9b10980", GIT_OBJ_TREE,
+		"53fc32d17276939fc79ed05badaef2db09990016", GIT_OBJ_TREE);
 }
 
 void test_object_peel__can_peel_a_commit(void)
 {
-	assert_peel("53fc32d17276939fc79ed05badaef2db09990016", "e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_TREE);
+	assert_peel("e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_TREE,
+		"53fc32d17276939fc79ed05badaef2db09990016", GIT_OBJ_TREE);
 }
 
 void test_object_peel__cannot_peel_a_tree(void)
@@ -76,10 +89,12 @@ void test_object_peel__cannot_peel_a_blob(void)
 void test_object_peel__target_any_object_for_type_change(void)
 {
 	/* tag to commit */
-	assert_peel("e90810b8df3e80c413d903f631643c716887138d", "7b4384978d2493e851f9cca7858815fac9b10980", GIT_OBJ_ANY);
+	assert_peel("7b4384978d2493e851f9cca7858815fac9b10980", GIT_OBJ_ANY,
+		"e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_COMMIT);
 
 	/* commit to tree */
-	assert_peel("53fc32d17276939fc79ed05badaef2db09990016", "e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_ANY);
+	assert_peel("e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_ANY,
+		"53fc32d17276939fc79ed05badaef2db09990016", GIT_OBJ_TREE);
 
 	/* fail to peel tree */
 	assert_peel_error(GIT_ERROR, "53fc32d17276939fc79ed05badaef2db09990016", GIT_OBJ_ANY);
diff --git a/tests-clar/refs/peel.c b/tests-clar/refs/peel.c
new file mode 100644
index 0000000..35a290b
--- /dev/null
+++ b/tests-clar/refs/peel.c
@@ -0,0 +1,91 @@
+#include "clar_libgit2.h"
+
+static git_repository *g_repo;
+
+void test_refs_peel__initialize(void)
+{
+	cl_git_pass(git_repository_open(&g_repo, cl_fixture("testrepo.git")));
+}
+
+void test_refs_peel__cleanup(void)
+{
+	git_repository_free(g_repo);
+}
+
+static void assert_peel(
+	const char *ref_name,
+	git_otype requested_type,
+	const char* expected_sha,
+	git_otype expected_type)
+{
+	git_oid expected_oid;
+	git_reference *ref;
+	git_object *peeled;
+
+	cl_git_pass(git_reference_lookup(&ref, g_repo, ref_name));
+	
+	cl_git_pass(git_reference_peel(&peeled, ref, requested_type));
+
+	cl_git_pass(git_oid_fromstr(&expected_oid, expected_sha));
+	cl_assert_equal_i(0, git_oid_cmp(&expected_oid, git_object_id(peeled)));
+
+	cl_assert_equal_i(expected_type, git_object_type(peeled));
+
+	git_object_free(peeled);
+	git_reference_free(ref);
+}
+
+static void assert_peel_error(int error, const char *ref_name, git_otype requested_type)
+{
+	git_reference *ref;
+	git_object *peeled;
+
+	cl_git_pass(git_reference_lookup(&ref, g_repo, ref_name));
+	
+	cl_assert_equal_i(error, git_reference_peel(&peeled, ref, requested_type));
+
+	git_reference_free(ref);
+}
+
+void test_refs_peel__can_peel_a_tag(void)
+{
+	assert_peel("refs/tags/test", GIT_OBJ_TAG,
+		"b25fa35b38051e4ae45d4222e795f9df2e43f1d1", GIT_OBJ_TAG);
+	assert_peel("refs/tags/test", GIT_OBJ_COMMIT,
+		"e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_COMMIT);
+	assert_peel("refs/tags/test", GIT_OBJ_TREE,
+		"53fc32d17276939fc79ed05badaef2db09990016", GIT_OBJ_TREE);
+	assert_peel("refs/tags/point_to_blob", GIT_OBJ_BLOB,
+		"1385f264afb75a56a5bec74243be9b367ba4ca08", GIT_OBJ_BLOB);
+}
+
+void test_refs_peel__can_peel_a_branch(void)
+{
+	assert_peel("refs/heads/master", GIT_OBJ_COMMIT,
+		"a65fedf39aefe402d3bb6e24df4d4f5fe4547750", GIT_OBJ_COMMIT);
+	assert_peel("refs/heads/master", GIT_OBJ_TREE,
+		"944c0f6e4dfa41595e6eb3ceecdb14f50fe18162", GIT_OBJ_TREE);
+}
+
+void test_refs_peel__can_peel_a_symbolic_reference(void)
+{
+	assert_peel("HEAD", GIT_OBJ_COMMIT,
+		"a65fedf39aefe402d3bb6e24df4d4f5fe4547750", GIT_OBJ_COMMIT);
+	assert_peel("HEAD", GIT_OBJ_TREE,
+		"944c0f6e4dfa41595e6eb3ceecdb14f50fe18162", GIT_OBJ_TREE);
+}
+
+void test_refs_peel__cannot_peel_into_a_non_existing_target(void)
+{
+	assert_peel_error(GIT_ERROR, "refs/tags/point_to_blob", GIT_OBJ_TAG);
+}
+
+void test_refs_peel__can_peel_into_any_non_tag_object(void)
+{
+	assert_peel("refs/heads/master", GIT_OBJ_ANY,
+		"a65fedf39aefe402d3bb6e24df4d4f5fe4547750", GIT_OBJ_COMMIT);
+	assert_peel("refs/tags/point_to_blob", GIT_OBJ_ANY,
+		"1385f264afb75a56a5bec74243be9b367ba4ca08", GIT_OBJ_BLOB);
+	assert_peel("refs/tags/test", GIT_OBJ_ANY,
+		"e90810b8df3e80c413d903f631643c716887138d", GIT_OBJ_COMMIT);
+}
diff --git a/tests-clar/reset/mixed.c b/tests-clar/reset/mixed.c
index 7cfff65..d5f8e10 100644
--- a/tests-clar/reset/mixed.c
+++ b/tests-clar/reset/mixed.c
@@ -27,7 +27,7 @@ void test_reset_mixed__cannot_reset_in_a_bare_repository(void)
 
 	retrieve_target_from_oid(&target, bare, KNOWN_COMMIT_IN_BARE_REPO);
 
-	cl_git_fail(git_reset(bare, target, GIT_RESET_MIXED));
+	cl_assert_equal_i(GIT_EBAREREPO, git_reset(bare, target, GIT_RESET_MIXED));
 
 	git_repository_free(bare);
 }