app_dart/test/service/commit_service_test.dart

// Copyright 2021 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:cocoon_integration_test/testing.dart';
import 'package:cocoon_server_test/mocks.dart';
import 'package:cocoon_server_test/test_logging.dart';
import 'package:cocoon_service/src/model/firestore/commit.dart' as fs;
import 'package:cocoon_service/src/service/commit_service.dart';
import 'package:github/github.dart';
import 'package:mockito/mockito.dart';
import 'package:test/test.dart';

void main() {
  useTestLoggerPerTest();

  late FakeConfig config;
  late CommitService commitService;
  late MockGithubService githubService;
  late MockRepositoriesService repositories;
  late MockGitHub github;
  late FakeFirestoreService firestore;

  const owner = 'flutter';
  const repository = 'flutter';
  const branch = 'coolest-branch';
  const sha = '1234';
  const message = 'Adding null safety';
  const avatarUrl = 'https://avatars.githubusercontent.com/u/fake-user-num';
  const username = 'AwesomeGithubUser';
  const dateTimeAsString = '2023-08-18T19:27:00Z';

  setUp(() {
    github = MockGitHub();
    githubService = MockGithubService();
    firestore = FakeFirestoreService();
    when(githubService.github).thenReturn(github);
    repositories = MockRepositoriesService();
    when(github.repositories).thenReturn(repositories);
    config = FakeConfig(githubService: githubService);
    commitService = CommitService(config: config, firestore: firestore);
  });

  group('handleCreateGithubRequest', () {
    test('adds commit to db if it does not exist in Firestore', () async {
      when(
        githubService.getReference(
          RepositorySlug(owner, repository),
          'heads/$branch',
        ),
      ).thenAnswer((Invocation invocation) {
        return Future<GitReference>.value(
          GitReference(ref: 'refs/$branch', object: GitObject('', sha, '')),
        );
      });

      when(
        repositories.getCommit(RepositorySlug(owner, repository), sha),
      ).thenAnswer((Invocation invocation) {
        return Future<RepositoryCommit>.value(
          RepositoryCommit(
            sha: sha,
            author: User(login: username, avatarUrl: avatarUrl),
            commit: GitCommit(message: message),
          ),
        );
      });

      final createEvent = generateCreateBranchEvent(
        branch,
        '$owner/$repository',
      );
      await commitService.handleCreateGithubRequest(createEvent);

      expect(
        firestore,
        existsInStorage(fs.Commit.metadata, [
          isCommit
              .hasSha(sha)
              .hasRepositoryPath('$owner/$repository')
              .hasBranch(branch)
              .hasAuthor(username)
              .hasAvatar(avatarUrl)
              .hasMessage(message),
        ]),
      );
    });

    // Regression test for https://github.com/flutter/flutter/issues/168684.
    test('does not update commit in db if SHA exists in Firestore', () async {
      firestore.putDocument(
        generateFirestoreCommit(1, branch: branch, sha: sha),
      );

      when(
        githubService.getReference(
          RepositorySlug(owner, repository),
          'heads/$branch-different',
        ),
      ).thenAnswer((Invocation invocation) {
        return Future<GitReference>.value(
          GitReference(
            ref: 'refs/$branch-different',
            object: GitObject('', sha, ''),
          ),
        );
      });

      when(
        repositories.getCommit(RepositorySlug(owner, repository), sha),
      ).thenAnswer((Invocation invocation) {
        return Future<RepositoryCommit>.value(
          RepositoryCommit(
            sha: sha,
            author: User(
              createdAt: DateTime.parse(dateTimeAsString),
              login: username,
              avatarUrl: avatarUrl,
            ),
            commit: GitCommit(message: message),
          ),
        );
      });

      final createEvent = generateCreateBranchEvent(
        '$branch-different',
        '$owner/$repository',
      );
      await commitService.handleCreateGithubRequest(createEvent);

      expect(
        firestore,
        existsInStorage(fs.Commit.metadata, [isCommit.hasBranch(branch)]),
      );
    });
  });

  group('handlePushGithubRequest', () {
    test('adds commit to db if it does not exist in Firestore', () async {
      final pushEvent = generatePushEvent(
        branch,
        owner,
        repository,
        message: message,
        sha: sha,
        avatarUrl: avatarUrl,
        username: username,
      );
      await commitService.handlePushGithubRequest(pushEvent);

      expect(
        firestore,
        existsInStorage(fs.Commit.metadata, [
          isCommit
              .hasSha(sha)
              .hasRepositoryPath('$owner/$repository')
              .hasBranch(branch)
              .hasAuthor(username)
              .hasAvatar(avatarUrl)
              .hasMessage(message),
        ]),
      );
    });

    // Regression test for https://github.com/flutter/flutter/issues/168684.
    test('does not update commit in db if SHA exists in Firestore', () async {
      firestore.putDocument(
        generateFirestoreCommit(1, branch: branch, sha: sha),
      );

      final pushEvent = generatePushEvent(
        '$branch-different',
        owner,
        repository,
        message: message,
        sha: sha,
        avatarUrl: avatarUrl,
        username: username,
      );
      await commitService.handlePushGithubRequest(pushEvent);

      expect(
        firestore,
        existsInStorage(fs.Commit.metadata, [isCommit.hasBranch(branch)]),
      );
    });
  });
}