GitJournal/test/flattened_notes_folder_test.dart

/*
 * SPDX-FileCopyrightText: 2019-2021 Vishesh Handa <me@vhanda.in>
 *
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

import 'dart:math';

import 'package:dart_git/dart_git.dart';
import 'package:gitjournal/core/file/file_storage.dart';
import 'package:gitjournal/core/folder/flattened_notes_folder.dart';
import 'package:gitjournal/core/folder/notes_folder_config.dart';
import 'package:gitjournal/core/folder/notes_folder_fs.dart';
import 'package:gitjournal/core/note.dart';
import 'package:gitjournal/core/note_storage.dart';
import 'package:gitjournal/core/notes/note.dart';
import 'package:path/path.dart' as p;
import 'package:shared_preferences/shared_preferences.dart';
import 'package:test/test.dart';
import 'package:universal_io/io.dart' as io;

import 'lib.dart';

void main() {
  setUpAll(gjSetupAllTests);

  var random = Random();

  String _getRandomFilePath(String basePath) {
    assert(basePath.startsWith(p.separator));
    while (true) {
      var filePath = p.join(basePath, "${random.nextInt(1000)}.md");
      if (io.File(filePath).existsSync()) {
        continue;
      }

      return filePath;
    }
  }

  group('Flattened Notes Folder Test', () {
    late io.Directory tempDir;
    late String repoPath;
    late NotesFolderFS rootFolder;
    late NotesFolderConfig config;
    late FileStorage fileStorage;

    setUp(() async {
      tempDir = await io.Directory.systemTemp.createTemp('__fnft__');
      repoPath = tempDir.path + p.separator;

      SharedPreferences.setMockInitialValues({});
      config = NotesFolderConfig('', await SharedPreferences.getInstance());
      fileStorage = await FileStorage.fake(repoPath);

      rootFolder = NotesFolderFS.root(config, fileStorage);

      for (var i = 0; i < 3; i++) {
        var fp = _getRandomFilePath(rootFolder.fullFolderPath);
        var note = Note.newNote(rootFolder,
            fileName: p.basename(fp), fileFormat: NoteFileFormat.Markdown);
        note = note.copyWith(
          modified: DateTime(2020, 1, 10 + (i * 2)),
          body: "$i\n",
        );
        note = await NoteStorage.save(note);
      }

      io.Directory(p.join(repoPath, "sub1")).createSync();
      io.Directory(p.join(repoPath, "sub1", "p1")).createSync();
      io.Directory(p.join(repoPath, "sub2")).createSync();

      var sub1Folder = NotesFolderFS(rootFolder, "sub1", config);
      for (var i = 0; i < 2; i++) {
        var fp = _getRandomFilePath(sub1Folder.fullFolderPath);
        var note = Note.newNote(sub1Folder,
            fileName: p.basename(fp), fileFormat: NoteFileFormat.Markdown);

        note = note.copyWith(
          modified: DateTime(2020, 1, 10 + (i * 2)),
          body: "sub1-$i\n",
        );
        note = await NoteStorage.save(note);
      }

      var sub2Folder = NotesFolderFS(rootFolder, "sub2", config);
      for (var i = 0; i < 2; i++) {
        var fp = _getRandomFilePath(sub2Folder.fullFolderPath);
        var note = Note.newNote(sub2Folder,
            fileName: p.basename(fp), fileFormat: NoteFileFormat.Markdown);

        note = note.copyWith(
          modified: DateTime(2020, 1, 10 + (i * 2)),
          body: "sub2-$i\n",
        );
        note = await NoteStorage.save(note);
      }

      var p1Folder = NotesFolderFS(sub1Folder, p.join("sub1", "p1"), config);
      for (var i = 0; i < 2; i++) {
        var fp = _getRandomFilePath(p1Folder.fullFolderPath);
        var note = Note.newNote(p1Folder,
            fileName: p.basename(fp), fileFormat: NoteFileFormat.Markdown);

        note = note.copyWith(
          modified: DateTime(2020, 1, 10 + (i * 2)),
          body: "p1-$i\n",
        );
        note = await NoteStorage.save(note);
      }

      var repo = GitRepository.load(repoPath);
      repo.commit(
        message: "Prepare Test Env",
        author: GitAuthor(name: 'Name', email: "name@example.com"),
        addAll: true,
      );

      await rootFolder.fileStorage.reload();

      expect(fileStorage.blobCTimeBuilder.map, isNotEmpty);
      expect(fileStorage.fileMTimeBuilder.map, isNotEmpty);

      await rootFolder.loadRecursively();
      expect(rootFolder.notes, isNotEmpty);
    });

    tearDown(() async {
      tempDir.deleteSync(recursive: true);
    });

    test('Should load the notes flattened', () async {
      var f = FlattenedNotesFolder(rootFolder, title: "foo");
      expect(f.hasNotes, true);
      expect(f.isEmpty, false);
      expect(f.name, "foo");
      expect(f.subFolders.length, 0);
      expect(f.notes.length, 9);

      var notes = List<Note>.from(f.notes);
      notes.sort((Note n1, Note n2) => n1.body.compareTo(n2.body));

      expect(notes[0].body, "0\n");
      expect(notes[1].body, "1\n");
      expect(notes[2].body, "2\n");
      expect(notes[3].body, "p1-0\n");
      expect(notes[4].body, "p1-1\n");
      expect(notes[5].body, "sub1-0\n");
      expect(notes[6].body, "sub1-1\n");
      expect(notes[7].body, "sub2-0\n");
      expect(notes[8].body, "sub2-1\n");
    });

    test('Should add a note properly', () async {
      var f = FlattenedNotesFolder(rootFolder, title: "");

      var p1 = (f.fsFolder as NotesFolderFS).getFolderWithSpec("sub1/p1")!;
      var fp = p.join(p1.folderPath, "new.md");
      var note = Note.newNote(p1,
          fileName: p.basename(fp), fileFormat: NoteFileFormat.Markdown);
      note = note.copyWith(
        modified: DateTime(2020, 2, 1),
        body: "new\n",
      );
      note = await NoteStorage.save(note);

      p1.add(note);

      expect(f.notes.length, 10);

      var notes = List<Note>.from(f.notes);
      notes.sort((Note n1, Note n2) => n1.body.compareTo(n2.body));

      expect(notes[0].body, "0\n");
      expect(notes[1].body, "1\n");
      expect(notes[2].body, "2\n");
      expect(notes[3].body, "new\n");
      expect(notes[4].body, "p1-0\n");
      expect(notes[5].body, "p1-1\n");
      expect(notes[6].body, "sub1-0\n");
      expect(notes[7].body, "sub1-1\n");
      expect(notes[8].body, "sub2-0\n");
      expect(notes[9].body, "sub2-1\n");

      // FIXME: Check if the callback for added is called with the correct index
    });

    // Test adding a note
    // Test removing a note
    // Test loading it incrementally
    // Test renaming a file
  });
}