[feat] Load workspace during integration test from a file. #2106

a-wallen · 2023-03-25T01:24:16Z

Uses a workspace uploaded from a .zip file during an integration test. Before any tests are run, the TestWorkspaceService unzips the workspace folder into .ephemeral/$name. This folder is ignored by source. After the workspace is unzipped, the TestWorkspaceService tells the application to read the workspace from .ephemeral/$name

If contributors need to write tests for Kanban board, they can create a new AppFlowy workspace with just a Kanban board, compress the folder, and add it to test_workspaces under integration_test.

a-wallen · 2023-03-25T01:26:19Z

fixes #2085

a-wallen · 2023-03-27T20:51:43Z

I'd like to be able to delete the workspace when the integration test are being torn down, but since the application is still open and reading the workspace file, the operating system blocks the operation.

a-wallen · 2023-03-29T01:12:47Z

frontend/appflowy_flutter/integration_test/util/data.dart

+    final File out = File(p.join(parent.path, '$_name.zip'));
+    if (await out.exists()) return out;
+    await out.create();
+    final ByteData data = await rootBundle.load(_asset);


Ran into issues reading files directly from the file system. There can be discrepancies between the local machine and the ones that run these tests on GitHub Actions. See this issue.

a-wallen · 2023-03-29T01:15:30Z

.github/workflows/integration_test.yml

@@ -110,11 +110,11 @@ jobs:
        working-directory: frontend/appflowy_flutter
        run: |
          if [ "$RUNNER_OS" == "Linux" ]; then
-            flutter test integration_test -d Linux --coverage
+            flutter test integration_test/runner.dart -d Linux --coverage


This PR adds a new integration test file. Although running flutter test integration test [-args] should work here, it appears that integration tests are unhappy when split between files. We should keep integration tests separated for readability and we can run them all from one test file runner.dart. See this issue for context.

LucasXu0 · 2023-03-29T01:36:26Z

frontend/appflowy_flutter/pubspec.yaml

@@ -165,6 +166,7 @@ flutter:
    - assets/images/common/
    - assets/images/grid/setting/
    - assets/translations/
+    - assets/test/workspaces/


If you put the test resource here, won't it be included in the release product?

That's correct. Tomorrow, I'll try to see whether I can exclude those assets from the release build.

IIUC, files outside the lib directory won't be included in the build unless referenced in the pubspec.yaml. Hence, there needs to be some mechanism that removes this line from the pubspec.yaml for the release build.

Could be an idea to have integration tests in a separate package (integration test package).

Otherwise we can write a script to amend the pubspec yaml, in that case the CI script should output it and await approval before releases, which is not that nice..

I think that having the integration tests as a separate package is a nice idea. It's better than writing a script to modify the pubspec.yaml. That'll be confusing for someone that doesn't have context. I've never had to pull an integration test suite into a separate package, so I'll let you know how that goes @Xazin. Thanks for your reviews.

So, we're going to separate the integration_test package now?

I tried, but the integration tests can't run without a flutter project so it's not a good option anymore.

Along the same lines, we can create a separate repo/branch that excludes the test assets with a .gitignore file. Another option is to use a build script to remove the files and updates the pubspec.yaml before running flutter build.

frontend/appflowy_flutter/integration_test/util/data.dart

a-wallen · 2023-03-31T22:13:33Z

Per @appflowy's request, the PR will use a build script to ignore the test assets in release. Assets between the BEGIN: EXCLUDE_IN_RELEASE and END_EXCLUDE_IN_RELEASE tags will be "removed" before building. To build the application, either run the dart script in frontend/scripts/flutter_release_build/build_flowy.dart or run the task AF: flutter build release (host_platform).

…ter/flutter#101031

frontend/scripts/flutter_release_build/tool.dart

Co-authored-by: Mihir <84044317+squidrye@users.noreply.github.com>

a-wallen · 2023-04-04T05:23:19Z

AppFlowy/AppFlowy#2083 had the changes in this PR and just landed. Closing this since it would be somewhat redundant.

a-wallen force-pushed the load_workspace_integration branch from 8c8a974 to 21c1b25 Compare March 25, 2023 01:24

annieappflowy added tests tasks related to writing tests infra engineering tasks that are not related to UX/UI features labels Mar 28, 2023

a-wallen marked this pull request as ready for review March 29, 2023 01:10

a-wallen changed the title ~~[feat] wip: load workspace during integration test from a file.~~ [feat] Load workspace during integration test from a file. Mar 29, 2023

a-wallen commented Mar 29, 2023

View reviewed changes

a-wallen requested a review from LucasXu0 March 29, 2023 01:15

a-wallen force-pushed the load_workspace_integration branch from f50dc78 to 431c716 Compare March 29, 2023 01:34

LucasXu0 reviewed Mar 29, 2023

View reviewed changes

frontend/appflowy_flutter/integration_test/util/data.dart Outdated Show resolved Hide resolved

squidrye mentioned this pull request Mar 29, 2023

feat: insert below and replace in smart-edit highlights text #2107

Merged

a-wallen mentioned this pull request Apr 1, 2023

[feat] Create a "view" for all database references in a document #2083

Merged

a-wallen force-pushed the load_workspace_integration branch from ddc4c8a to 9ffc364 Compare April 1, 2023 23:33

a-wallen added 13 commits April 2, 2023 19:25

feat: add archive for compression

2419ab4

feat: add service to manage zipped work spaces

2d90926

feat: export service in barrel file

5518876

feat: ignore .ephemeral directory

65939da

feat: add first compressed workspace file

ad187cc

fix: directory path was wrong

3b3525c

feat: add a somewhat useful test

2c4cfe8

fix: move to same file (delete later)

32392f1

fix: use script path vs. working directory for CI

099718f

fix: read from asset bundle instead of file system

286fa34

fix: workaround to run integration in multiple files on desktop (flut…

88363e4

…ter/flutter#101031

feat: remove .ephemeral from .gitignore, no longer created

bb286ea

feat: document test changes

69d5e75

a-wallen added 8 commits April 2, 2023 19:25

fix: lucas suggestion

01b2d88

feat: mark assets as excluded in pubspec.yaml

128f550

feat: add class for build utilities

14e8500

feat: add script runner for release builds

35ed3c5

feat: add build script as task in flowy project

7034bc9

fix: typo in pubspec.yaml

161843e

chore: use constants for exclude tag

590d76e

feat: add appversion as argument to build tool

784e24f

a-wallen force-pushed the load_workspace_integration branch from 9ffc364 to 784e24f Compare April 3, 2023 05:26

feat: use dart script in release.yml

19d16d5

a-wallen force-pushed the load_workspace_integration branch from 25c7c04 to 19d16d5 Compare April 3, 2023 06:46

squidrye reviewed Apr 3, 2023

View reviewed changes

frontend/scripts/flutter_release_build/tool.dart Outdated Show resolved Hide resolved

a-wallen and others added 2 commits April 3, 2023 08:37

chore: remove task

baab67d

fix: careless error

17769a9

Co-authored-by: Mihir <84044317+squidrye@users.noreply.github.com>

a-wallen force-pushed the load_workspace_integration branch from 716d2ec to 17769a9 Compare April 3, 2023 18:40

a-wallen closed this Apr 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat] Load workspace during integration test from a file. #2106

[feat] Load workspace during integration test from a file. #2106

a-wallen commented Mar 25, 2023 •

edited

Loading

a-wallen commented Mar 25, 2023

a-wallen commented Mar 27, 2023

a-wallen Mar 29, 2023

a-wallen Mar 29, 2023

LucasXu0 Mar 29, 2023

a-wallen Mar 29, 2023

a-wallen Mar 29, 2023 •

edited

Loading

Xazin Mar 29, 2023

a-wallen Mar 29, 2023 •

edited

Loading

LucasXu0 Mar 31, 2023

a-wallen Mar 31, 2023

a-wallen commented Mar 31, 2023

a-wallen commented Apr 4, 2023

[feat] Load workspace during integration test from a file. #2106

[feat] Load workspace during integration test from a file. #2106

Conversation

a-wallen commented Mar 25, 2023 • edited Loading

a-wallen commented Mar 25, 2023

a-wallen commented Mar 27, 2023

a-wallen Mar 29, 2023

Choose a reason for hiding this comment

a-wallen Mar 29, 2023

Choose a reason for hiding this comment

LucasXu0 Mar 29, 2023

Choose a reason for hiding this comment

a-wallen Mar 29, 2023

Choose a reason for hiding this comment

a-wallen Mar 29, 2023 • edited Loading

Choose a reason for hiding this comment

Xazin Mar 29, 2023

Choose a reason for hiding this comment

a-wallen Mar 29, 2023 • edited Loading

Choose a reason for hiding this comment

LucasXu0 Mar 31, 2023

Choose a reason for hiding this comment

a-wallen Mar 31, 2023

Choose a reason for hiding this comment

a-wallen commented Mar 31, 2023

a-wallen commented Apr 4, 2023

a-wallen commented Mar 25, 2023 •

edited

Loading

a-wallen Mar 29, 2023 •

edited

Loading

a-wallen Mar 29, 2023 •

edited

Loading