libgit2dart/test/reference_test.dart

import 'dart:io';

import 'package:libgit2dart/src/git_types.dart';
import 'package:test/test.dart';
import 'package:libgit2dart/libgit2dart.dart';
import 'helpers/util.dart';

void main() {
  late Repository repo;
  late Directory tmpDir;
  const lastCommit = '821ed6e80627b8769d170a293862f9fc60825226';
  const newCommit = 'c68ff54aabf660fcdd9a2838d401583fe31249e3';

  setUp(() async {
    tmpDir = await setupRepo(Directory('test/assets/testrepo/'));
    repo = Repository.open(tmpDir.path);
  });

  tearDown(() async {
    repo.free();
    await tmpDir.delete(recursive: true);
  });

  group('Reference', () {
    test('returns a list', () {
      expect(
        repo.references.list,
        [
          'refs/heads/feature',
          'refs/heads/master',
          'refs/tags/v0.1',
          'refs/tags/v0.2',
        ],
      );
    });

    test('returns correct type of reference', () {
      final head = repo.head;
      expect(head.type, ReferenceType.direct);
      head.free();

      final ref = repo.references['HEAD'];
      expect(ref.type, ReferenceType.symbolic);
      ref.free();
    });

    test('returns SHA hex of direct reference', () {
      final head = repo.head;
      expect(head.target.sha, lastCommit);
      head.free();
    });

    test('returns SHA hex of symbolic reference', () {
      final ref = repo.references['HEAD'];
      expect(ref.target.sha, lastCommit);
      ref.free();
    });

    test('returns the full name', () {
      final head = repo.head;
      expect(head.name, 'refs/heads/master');
      head.free();
    });

    test('returns the short name', () {
      final ref = repo.references.create(
        name: 'refs/remotes/origin/master',
        target: lastCommit,
      );

      final head = repo.head;

      expect(head.shorthand, 'master');
      expect(ref.shorthand, 'origin/master');

      head.free();
      ref.free();
    });

    test('checks if reference is a local branch', () {
      final ref = repo.references['refs/heads/feature'];
      expect(ref.isBranch, true);
      ref.free();
    });

    test('checks if reference is a note', () {
      final ref = repo.references['refs/heads/master'];
      expect(ref.isNote, false);
      ref.free();
    });

    test('checks if reference is a remote branch', () {
      final ref = repo.references.create(
        name: 'refs/remotes/origin/master',
        target: lastCommit,
      );

      expect(ref.isRemote, true);

      ref.free();
    });

    test('checks if reference is a tag', () {
      final ref = repo.references['refs/tags/v0.1'];
      expect(ref.isTag, true);
      ref.free();
    });

    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.references.create(
          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.references.create(
          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.references.create(
          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.references.create(
          name: 'refs/heads/log.message',
          target: lastCommit,
          logMessage: 'log message',
        );

        final reflog = ref.log;
        final reflogEntry = reflog[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.references.create(
            name: 'refs/tags/invalid',
            target: '78b',
          ),
          throwsA(isA<LibGit2Error>()),
        );
      });

      test('throws if name is not valid', () {
        expect(
          () => repo.references.create(
            name: 'refs/tags/invalid~',
            target: lastCommit,
          ),
          throwsA(isA<LibGit2Error>()),
        );
      });

      test('successfully creates with force flag if name already exists', () {
        final ref = repo.references.create(
          name: 'refs/tags/test',
          target: lastCommit,
        );

        final forceRef = repo.references.create(
          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.references.create(
          name: 'refs/tags/test',
          target: lastCommit,
        );

        expect(
          () => repo.references.create(
            name: 'refs/tags/test',
            target: lastCommit,
          ),
          throwsA(isA<LibGit2Error>()),
        );

        ref.free();
      });
    });

    group('create symbolic', () {
      test('successfully creates with valid target', () {
        final ref = repo.references.create(
          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.references.create(
          name: 'refs/tags/test',
          target: 'refs/heads/master',
        );

        final forceRef = repo.references.create(
          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.references.create(
          name: 'refs/tags/exists',
          target: 'refs/heads/master',
        );

        expect(
          () => repo.references.create(
            name: 'refs/tags/exists',
            target: 'refs/heads/master',
          ),
          throwsA(isA<LibGit2Error>()),
        );

        ref.free();
      });

      test('throws if name is not valid', () {
        expect(
          () => repo.references.create(
            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.references.create(
          name: 'HEAD',
          target: 'refs/heads/feature',
          force: true,
          logMessage: 'log message',
        );

        final reflog = ref.log;
        final reflogEntry = reflog[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.references.create(
        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(
          () => repo.references['refs/heads/not/there'],
          throwsA(isA<LibGit2Error>()),
        );
      });
    });

    test('returns log for reference', () {
      final ref = repo.references['refs/heads/master'];
      final reflog = ref.log;
      expect(reflog.last.message, 'commit (initial): init');

      reflog.free();
      ref.free();
    });

    group('set target', () {
      test('successfully sets with SHA hex', () {
        final ref = repo.references['refs/heads/master'];
        ref.setTarget(newCommit);
        expect(ref.target.sha, newCommit);

        ref.free();
      });

      test('successfully sets target with short SHA hex', () {
        final ref = repo.references['refs/heads/master'];
        ref.setTarget(newCommit.substring(0, 5));
        expect(ref.target.sha, newCommit);

        ref.free();
      });

      test('successfully sets symbolic target', () {
        final ref = repo.references['HEAD'];
        expect(ref.target.sha, lastCommit);

        ref.setTarget('refs/heads/feature');
        expect(ref.target.sha, '5aecfa0fb97eadaac050ccb99f03c3fb65460ad4');

        ref.free();
      });

      test('successfully sets target with log message', () {
        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');
        final reflog = ref.log;
        expect(reflog.first.message, 'log message');
        expect(reflog.first.committer.name, 'name');
        expect(reflog.first.committer.email, 'email');

        reflog.free();
        ref.free();
      });

      test('throws on invalid target', () {
        final ref = repo.references['HEAD'];
        expect(
          () => ref.setTarget('refs/heads/invalid~'),
          throwsA(isA<LibGit2Error>()),
        );

        ref.free();
      });
    });

    group('rename', () {
      test('successfully renames reference', () {
        final ref = repo.references.create(
          name: 'refs/tags/v1',
          target: lastCommit,
        );
        expect(ref.name, 'refs/tags/v1');

        ref.rename('refs/tags/v2');
        expect(ref.name, 'refs/tags/v2');

        ref.free();
      });

      test('throws on invalid name', () {
        final ref = repo.references.create(
          name: 'refs/tags/v1',
          target: lastCommit,
        );

        expect(
          () => ref.rename('refs/tags/invalid~'),
          throwsA(isA<LibGit2Error>()),
        );

        ref.free();
      });

      test('throws if name already exists', () {
        final ref1 = repo.references.create(
          name: 'refs/tags/v1',
          target: lastCommit,
        );

        final ref2 = repo.references.create(
          name: 'refs/tags/v2',
          target: lastCommit,
        );

        expect(
          () => ref1.rename('refs/tags/v2'),
          throwsA(isA<LibGit2Error>()),
        );

        ref1.free();
        ref2.free();
      });

      test('successfully renames with force flag set to true', () {
        final ref1 = repo.references.create(
          name: 'refs/tags/v1',
          target: lastCommit,
        );

        final ref2 = repo.references.create(
          name: 'refs/tags/v2',
          target: newCommit,
        );

        expect(ref2.target.sha, newCommit);

        ref1.rename('refs/tags/v2', force: true);
        expect(ref1.name, 'refs/tags/v2');

        ref1.free();
        ref2.free();
      });
    });

    test('checks equality', () {
      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);
      expect(ref1 == ref3, false);
      expect(ref1 != ref3, true);

      ref1.free();
      ref2.free();
      ref3.free();
    });

    test('successfully peels to non-tag object when no type is provided', () {
      final ref = repo.references['refs/heads/master'];
      final commit = repo[ref.target.sha] as Commit;
      final peeled = ref.peel() as Commit;

      expect(peeled.id, commit.id);

      peeled.free();
      commit.free();
      ref.free();
    });

    test('successfully peels to object of provided type', () {
      final ref = repo.references['refs/heads/master'];
      final commit = repo[ref.target.sha] as Commit;
      final tree = commit.tree;
      final peeledCommit = ref.peel(GitObject.commit) as Commit;
      final peeledTree = ref.peel(GitObject.tree) as Tree;

      expect(peeledCommit.id, commit.id);
      expect(peeledTree.id, tree.id);

      peeledCommit.free();
      commit.free();
      tree.free();
      ref.free();
    });

    test('successfully compresses references', () {
      final packedRefsFile = File('${tmpDir.path}/.git/packed-refs');
      expect(packedRefsFile.existsSync(), false);
      final oldRefs = repo.references.list;

      repo.references.compress();

      expect(packedRefsFile.existsSync(), true);
      final newRefs = repo.references.list;
      expect(newRefs, oldRefs);
    });
  });
}