refactor!: change api entry points

This commit is contained in:
Aleksey Kulikov 2021-08-11 17:02:32 +03:00
parent 06b44597d5
commit 5feb12fdaa
9 changed files with 411 additions and 457 deletions

View file

@ -3,9 +3,6 @@ import 'dart:io';
import 'package:libgit2dart/libgit2dart.dart';
import 'package:test/test.dart';
import 'package:libgit2dart/src/index.dart';
import 'package:libgit2dart/src/repository.dart';
import 'package:libgit2dart/src/types.dart';
import 'package:libgit2dart/src/error.dart';
import 'helpers/util.dart';

View file

@ -1,11 +1,7 @@
import 'dart:io';
import 'package:libgit2dart/src/reflog.dart';
import 'package:test/test.dart';
import 'package:libgit2dart/src/repository.dart';
import 'package:libgit2dart/src/reference.dart';
import 'package:libgit2dart/src/error.dart';
import 'package:libgit2dart/libgit2dart.dart';
import 'helpers/util.dart';
void main() {
@ -32,225 +28,11 @@ void main() {
await Directory(tmpDir).delete(recursive: true);
});
group('.createDirect()', () {
test('successfully creates with Oid as target', () {
final ref = Reference.get(repo, 'refs/heads/master');
final refFromOid = Reference.create(
repository: repo,
name: 'refs/tags/from.oid',
target: ref.target,
);
expect(Reference.list(repo), contains('refs/tags/from.oid'));
refFromOid.free();
ref.free();
});
test('successfully creates with SHA hash as target', () {
final refFromHash = Reference.create(
repository: repo,
name: 'refs/tags/from.hash',
target: lastCommit,
);
expect(Reference.list(repo), contains('refs/tags/from.hash'));
refFromHash.free();
});
test('successfully creates with short SHA hash as target', () {
final refFromHash = Reference.create(
repository: repo,
name: 'refs/tags/from.short.hash',
target: '78b8bf',
);
expect(Reference.list(repo), contains('refs/tags/from.short.hash'));
refFromHash.free();
});
test('successfully creates with log message', () {
repo.setIdentity(name: 'name', email: 'email');
final ref = Reference.create(
repository: repo,
name: 'refs/heads/log.message',
target: lastCommit,
logMessage: 'log message',
);
final reflog = RefLog(ref);
final reflogEntry = reflog.entryAt(0);
expect(reflogEntry.message, 'log message');
expect(reflogEntry.committer['name'], 'name');
expect(reflogEntry.committer['email'], 'email');
reflog.free();
ref.free();
});
test('throws if target is not valid', () {
expect(
() => Reference.create(
repository: repo,
name: 'refs/tags/invalid',
target: '78b',
),
throwsA(isA<LibGit2Error>()),
);
});
test('throws if name is not valid', () {
expect(
() => Reference.create(
repository: repo,
name: 'refs/tags/invalid~',
target: lastCommit,
),
throwsA(isA<LibGit2Error>()),
);
});
test('successfully creates with force flag if name already exists', () {
final ref = Reference.create(
repository: repo,
name: 'refs/tags/test',
target: lastCommit,
);
final forceRef = Reference.create(
repository: repo,
name: 'refs/tags/test',
target: lastCommit,
force: true,
);
expect(forceRef.target.sha, lastCommit);
ref.free();
forceRef.free();
});
test('throws if name already exists', () {
final ref = Reference.create(
repository: repo,
name: 'refs/tags/test',
target: lastCommit,
);
expect(
() => Reference.create(
repository: repo,
name: 'refs/tags/test',
target: lastCommit,
),
throwsA(isA<LibGit2Error>()),
);
ref.free();
});
});
group('.createSymbolic()', () {
test('successfully creates with valid target', () {
final ref = Reference.create(
repository: repo,
name: 'refs/tags/symbolic',
target: 'refs/heads/master',
);
expect(Reference.list(repo), contains('refs/tags/symbolic'));
expect(ref.type, ReferenceType.symbolic);
ref.free();
});
test('successfully creates with force flag if name already exists', () {
final ref = Reference.create(
repository: repo,
name: 'refs/tags/test',
target: 'refs/heads/master',
);
final forceRef = Reference.create(
repository: repo,
name: 'refs/tags/test',
target: 'refs/heads/master',
force: true,
);
expect(forceRef.target.sha, lastCommit);
expect(forceRef.type, ReferenceType.symbolic);
ref.free();
forceRef.free();
});
test('throws if name already exists', () {
final ref = Reference.create(
repository: repo,
name: 'refs/tags/exists',
target: 'refs/heads/master',
);
expect(
() => Reference.create(
repository: repo,
name: 'refs/tags/exists',
target: 'refs/heads/master',
),
throwsA(isA<LibGit2Error>()),
);
ref.free();
});
test('throws if name is not valid', () {
expect(
() => Reference.create(
repository: repo,
name: 'refs/tags/invalid~',
target: 'refs/heads/master',
),
throwsA(isA<LibGit2Error>()),
);
});
test('successfully creates with log message', () {
repo.setIdentity(name: 'name', email: 'email');
final ref = Reference.create(
repository: repo,
name: 'HEAD',
target: 'refs/heads/feature',
force: true,
logMessage: 'log message',
);
final reflog = RefLog(ref);
final reflogEntry = reflog.entryAt(0);
expect(reflogEntry.message, 'log message');
expect(reflogEntry.committer['name'], 'name');
expect(reflogEntry.committer['email'], 'email');
reflog.free();
ref.free();
});
});
test('successfully deletes reference', () {
final ref = Reference.create(
repository: repo,
name: 'refs/tags/test',
target: lastCommit,
test('returns a list', () {
expect(
repo.references.list(),
['refs/heads/feature', 'refs/heads/master', 'refs/tags/v0.1'],
);
expect(Reference.list(repo), contains('refs/tags/test'));
ref.delete();
expect(Reference.list(repo), isNot(contains('refs/tags/test')));
ref.free();
});
test('returns correct type of reference', () {
@ -258,7 +40,7 @@ void main() {
expect(head.type, ReferenceType.direct);
head.free();
final ref = Reference.get(repo, 'HEAD');
final ref = repo.references['HEAD'];
expect(ref.type, ReferenceType.symbolic);
ref.free();
});
@ -270,7 +52,7 @@ void main() {
});
test('returns SHA hex of symbolic reference', () {
final ref = Reference.get(repo, 'HEAD');
final ref = repo.references['HEAD'];
expect(ref.target.sha, lastCommit);
ref.free();
});
@ -282,8 +64,7 @@ void main() {
});
test('returns the short name', () {
final ref = Reference.create(
repository: repo,
final ref = repo.createReference(
name: 'refs/remotes/origin/master',
target: lastCommit,
);
@ -297,33 +78,20 @@ void main() {
ref.free();
});
test('returns a map with all the references of repository', () {
expect(
Reference.list(repo),
['refs/heads/feature', 'refs/heads/master', 'refs/tags/v0.1'],
);
});
test('checks if reflog exists for the reference', () {
expect(Reference.hasLog(repo, 'refs/heads/master'), true);
expect(Reference.hasLog(repo, 'refs/tags/v0.1'), false);
});
test('checks if reference is a local branch', () {
final ref = Reference.get(repo, 'refs/heads/feature');
final ref = repo.references['refs/heads/feature'];
expect(ref.isBranch, true);
ref.free();
});
test('checks if reference is a note', () {
final ref = Reference.get(repo, 'refs/heads/master');
final ref = repo.references['refs/heads/master'];
expect(ref.isNote, false);
ref.free();
});
test('checks if reference is a remote branch', () {
final ref = Reference.create(
repository: repo,
final ref = repo.createReference(
name: 'refs/remotes/origin/master',
target: lastCommit,
);
@ -334,76 +102,251 @@ void main() {
});
test('checks if reference is a tag', () {
final ref = Reference.get(repo, 'refs/tags/v0.1');
final ref = repo.references['refs/tags/v0.1'];
expect(ref.isTag, true);
ref.free();
});
group('.lookup()', () {
test('finds a reference with provided name', () {
final ref = Reference.get(repo, 'refs/heads/master');
test('checks if reflog exists for the reference', () {
var ref = repo.references['refs/heads/master'];
expect(ref.hasLog, true);
ref = repo.references['refs/tags/v0.1'];
expect(ref.hasLog, false);
ref.free();
});
group('create direct', () {
test('successfully creates with Oid as target', () {
final ref = repo.references['refs/heads/master'];
final refFromOid = repo.createReference(
name: 'refs/tags/from.oid',
target: ref.target,
);
expect(repo.references.list(), contains('refs/tags/from.oid'));
refFromOid.free();
ref.free();
});
test('successfully creates with SHA hash as target', () {
final refFromHash = repo.createReference(
name: 'refs/tags/from.hash',
target: lastCommit,
);
expect(repo.references.list(), contains('refs/tags/from.hash'));
refFromHash.free();
});
test('successfully creates with short SHA hash as target', () {
final refFromHash = repo.createReference(
name: 'refs/tags/from.short.hash',
target: '78b8bf',
);
expect(repo.references.list(), contains('refs/tags/from.short.hash'));
refFromHash.free();
});
test('successfully creates with log message', () {
repo.setIdentity(name: 'name', email: 'email');
final ref = repo.createReference(
name: 'refs/heads/log.message',
target: lastCommit,
logMessage: 'log message',
);
final reflog = ref.log;
final reflogEntry = reflog.entryAt(0);
expect(reflogEntry.message, 'log message');
expect(reflogEntry.committer['name'], 'name');
expect(reflogEntry.committer['email'], 'email');
reflog.free();
ref.free();
});
test('throws if target is not valid', () {
expect(
() => repo.createReference(
name: 'refs/tags/invalid',
target: '78b',
),
throwsA(isA<LibGit2Error>()),
);
});
test('throws if name is not valid', () {
expect(
() => repo.createReference(
name: 'refs/tags/invalid~',
target: lastCommit,
),
throwsA(isA<LibGit2Error>()),
);
});
test('successfully creates with force flag if name already exists', () {
final ref = repo.createReference(
name: 'refs/tags/test',
target: lastCommit,
);
final forceRef = repo.createReference(
name: 'refs/tags/test',
target: lastCommit,
force: true,
);
expect(forceRef.target.sha, lastCommit);
ref.free();
forceRef.free();
});
test('throws if name already exists', () {
final ref = repo.createReference(
name: 'refs/tags/test',
target: lastCommit,
);
expect(
() => repo.createReference(
name: 'refs/tags/test',
target: lastCommit,
),
throwsA(isA<LibGit2Error>()),
);
ref.free();
});
});
group('create symbolic', () {
test('successfully creates with valid target', () {
final ref = repo.createReference(
name: 'refs/tags/symbolic',
target: 'refs/heads/master',
);
expect(repo.references.list(), contains('refs/tags/symbolic'));
expect(ref.type, ReferenceType.symbolic);
ref.free();
});
test('successfully creates with force flag if name already exists', () {
final ref = repo.createReference(
name: 'refs/tags/test',
target: 'refs/heads/master',
);
final forceRef = repo.createReference(
name: 'refs/tags/test',
target: 'refs/heads/master',
force: true,
);
expect(forceRef.target.sha, lastCommit);
expect(forceRef.type, ReferenceType.symbolic);
ref.free();
forceRef.free();
});
test('throws if name already exists', () {
final ref = repo.createReference(
name: 'refs/tags/exists',
target: 'refs/heads/master',
);
expect(
() => repo.createReference(
name: 'refs/tags/exists',
target: 'refs/heads/master',
),
throwsA(isA<LibGit2Error>()),
);
ref.free();
});
test('throws if name is not valid', () {
expect(
() => repo.createReference(
name: 'refs/tags/invalid~',
target: 'refs/heads/master',
),
throwsA(isA<LibGit2Error>()),
);
});
test('successfully creates with log message', () {
repo.setIdentity(name: 'name', email: 'email');
final ref = repo.createReference(
name: 'HEAD',
target: 'refs/heads/feature',
force: true,
logMessage: 'log message',
);
final reflog = ref.log;
final reflogEntry = reflog.entryAt(0);
expect(reflogEntry.message, 'log message');
expect(reflogEntry.committer['name'], 'name');
expect(reflogEntry.committer['email'], 'email');
reflog.free();
ref.free();
});
});
test('successfully deletes reference', () {
final ref = repo.createReference(
name: 'refs/tags/test',
target: lastCommit,
);
expect(repo.references.list(), contains('refs/tags/test'));
ref.delete();
expect(repo.references.list(), isNot(contains('refs/tags/test')));
ref.free();
});
group('finds', () {
test('with provided name', () {
final ref = repo.references['refs/heads/master'];
expect(ref.target.sha, lastCommit);
ref.free();
});
test('throws when error occured', () {
expect(
() => Reference.get(repo, 'refs/heads/not/there'),
throwsA(isA<LibGit2Error>()),
);
});
});
group('.lookupDWIM()', () {
test('finds a reference with provided name', () {
final remoteRef = Reference.create(
repository: repo,
name: 'refs/remotes/origin/master',
target: lastCommit,
);
expect(remoteRef.shorthand, 'origin/master');
final tagRef = Reference.create(
repository: repo,
name: 'refs/tags/v1',
target: lastCommit,
);
expect(tagRef.shorthand, 'v1');
var ref = Reference.getDWIM(repo, 'refs/heads/master');
expect(ref.name, 'refs/heads/master');
ref = Reference.getDWIM(repo, 'master');
expect(ref.name, 'refs/heads/master');
ref = Reference.getDWIM(repo, 'origin/master');
expect(ref.name, 'refs/remotes/origin/master');
ref = Reference.getDWIM(repo, 'v1');
expect(ref.name, 'refs/tags/v1');
remoteRef.free();
tagRef.free();
ref.free();
});
test('throws when error occured', () {
expect(
() => Reference.getDWIM(repo, 'refs/heads/not/there'),
() => repo.references['refs/heads/not/there'],
throwsA(isA<LibGit2Error>()),
);
});
});
test('returns log for reference', () {
final ref = Reference.get(repo, 'refs/heads/master');
expect(ref.log.last.message, 'commit (initial): init');
final ref = repo.references['refs/heads/master'];
final reflog = ref.log;
expect(reflog.list().last.message, 'commit (initial): init');
reflog.free();
ref.free();
});
group('.setTarget()', () {
test('successfully sets target with SHA hex', () {
final ref = Reference.get(repo, 'refs/heads/master');
group('set target', () {
test('successfully sets with SHA hex', () {
final ref = repo.references['refs/heads/master'];
ref.setTarget(newCommit);
expect(ref.target.sha, newCommit);
@ -411,7 +354,7 @@ void main() {
});
test('successfully sets target with short SHA hex', () {
final ref = Reference.get(repo, 'refs/heads/master');
final ref = repo.references['refs/heads/master'];
ref.setTarget(newCommit.substring(0, 5));
expect(ref.target.sha, newCommit);
@ -419,7 +362,7 @@ void main() {
});
test('successfully sets symbolic target', () {
final ref = Reference.get(repo, 'HEAD');
final ref = repo.references['HEAD'];
expect(ref.target.sha, lastCommit);
ref.setTarget('refs/heads/feature');
@ -429,21 +372,23 @@ void main() {
});
test('successfully sets target with log message', () {
final ref = Reference.get(repo, 'HEAD');
final ref = repo.references['HEAD'];
expect(ref.target.sha, lastCommit);
repo.setIdentity(name: 'name', email: 'email');
ref.setTarget('refs/heads/feature', 'log message');
expect(ref.target.sha, '5aecfa0fb97eadaac050ccb99f03c3fb65460ad4');
expect(ref.log.first.message, 'log message');
expect(ref.log.first.committer['name'], 'name');
expect(ref.log.first.committer['email'], 'email');
final reflog = ref.log;
expect(reflog.list().first.message, 'log message');
expect(reflog.list().first.committer['name'], 'name');
expect(reflog.list().first.committer['email'], 'email');
reflog.free();
ref.free();
});
test('throws on invalid target', () {
final ref = Reference.get(repo, 'HEAD');
final ref = repo.references['HEAD'];
expect(
() => ref.setTarget('refs/heads/invalid~'),
throwsA(isA<LibGit2Error>()),
@ -453,10 +398,9 @@ void main() {
});
});
group('.rename()', () {
group('rename', () {
test('successfully renames reference', () {
final ref = Reference.create(
repository: repo,
final ref = repo.createReference(
name: 'refs/tags/v1',
target: lastCommit,
);
@ -469,8 +413,7 @@ void main() {
});
test('throws on invalid name', () {
final ref = Reference.create(
repository: repo,
final ref = repo.createReference(
name: 'refs/tags/v1',
target: lastCommit,
);
@ -484,14 +427,12 @@ void main() {
});
test('throws if name already exists', () {
final ref1 = Reference.create(
repository: repo,
final ref1 = repo.createReference(
name: 'refs/tags/v1',
target: lastCommit,
);
final ref2 = Reference.create(
repository: repo,
final ref2 = repo.createReference(
name: 'refs/tags/v2',
target: lastCommit,
);
@ -506,14 +447,12 @@ void main() {
});
test('successfully renames with force flag set to true', () {
final ref1 = Reference.create(
repository: repo,
final ref1 = repo.createReference(
name: 'refs/tags/v1',
target: lastCommit,
);
final ref2 = Reference.create(
repository: repo,
final ref2 = repo.createReference(
name: 'refs/tags/v2',
target: newCommit,
);
@ -529,9 +468,9 @@ void main() {
});
test('checks equality', () {
final ref1 = Reference.get(repo, 'refs/heads/master');
final ref2 = Reference.get(repo, 'refs/heads/master');
final ref3 = Reference.get(repo, 'refs/heads/feature');
final ref1 = repo.references['refs/heads/master'];
final ref2 = repo.references['refs/heads/master'];
final ref3 = repo.references['refs/heads/feature'];
expect(ref1 == ref2, true);
expect(ref1 != ref2, false);
@ -542,32 +481,5 @@ void main() {
ref2.free();
ref3.free();
});
group('isValidName()', () {
test('returns true for valid names', () {
expect(Reference.isValidName('HEAD'), true);
expect(Reference.isValidName('refs/heads/master'), true);
expect(Reference.isValidName('refs/heads/perfectly/valid'), true);
expect(Reference.isValidName('refs/tags/v1'), true);
expect(Reference.isValidName('refs/special/ref'), true);
expect(Reference.isValidName('refs/heads/ünicöde'), true);
expect(Reference.isValidName('refs/tags/😀'), true);
});
test('returns false for invalid names', () {
expect(Reference.isValidName(''), false);
expect(Reference.isValidName(' refs/heads/master'), false);
expect(Reference.isValidName('refs/heads/in..valid'), false);
expect(Reference.isValidName('refs/heads/invalid~'), false);
expect(Reference.isValidName('refs/heads/invalid^'), false);
expect(Reference.isValidName('refs/heads/invalid:'), false);
expect(Reference.isValidName('refs/heads/invalid\\'), false);
expect(Reference.isValidName('refs/heads/invalid?'), false);
expect(Reference.isValidName('refs/heads/invalid['), false);
expect(Reference.isValidName('refs/heads/invalid*'), false);
expect(Reference.isValidName('refs/heads/@{no}'), false);
expect(Reference.isValidName('refs/heads/foo//bar'), false);
});
});
});
}

View file

@ -1,8 +1,7 @@
import 'dart:io';
import 'package:test/test.dart';
import 'package:libgit2dart/src/repository.dart';
import 'package:libgit2dart/src/error.dart';
import 'package:libgit2dart/libgit2dart.dart';
import 'helpers/util.dart';
void main() {