32 Better Workspace Testing

[dendron-bot]

Goals

Create better testing harness for Dendron workspalce inside plugin-core

Context

We are currently making a few changes in both how our workspaces are initialized (eg. [[31 Native Workspace|dendron://dendron.dendron-site/dendron.rfc.31-native-workspace]]) as well as testing (eg. BDD light).
This means it's a good tiem to re-visit how we setup workspaces for testing so that it is performant and functional going forward

Proposal

• Update plugin tests to be able to test in code workspace
  • NOTE: this will be a big undertaking, recommend doing this incrementally
    • initially, create a test harness that can easily run native workspace test
    • slowly migrate existing tests to new test harness on a week by week/just in time basis
  • should be written according to BDD style

  suite("GIVEN Native Workspace", () => {
      describe("WHEN initialized with a single vault", () => {
          describe("AND WHEN a link is copied", () => {
              test("THEN return the copied link", () => {
                  runWithWorkspace({type: NATIVE,  ..., onInit: () => {
  
                  }});
              });
          });
      });
  });

Details

Example

Tradeoffs

[nickolay-kondratyev]

We probably want to change the signature of setup harness to return some object that can be used in later tests rather than passing in the function into the setup harness. To allow for multiple test blocks to use the same object.

Something like:

describe("GIVEN Native Workspace", () => {
  let ws: TestWorkspace;
  beforeAll(() => {
    testWorkspace = setupTestWorkspace({type: NATIVE,  ...})
  });

  describe("WHEN initialized with a single vault", () => {
    beforeAll(() => {
      // use 'testWorkspace' to initialize single vault
    });

    describe("AND WHEN a link is copied", () => {
      beforeAll(() => {
        // use 'testWorkspace' to copy link
      });

      test("THEN return the copied link", () => {
        // test that link was copied.
      });

      test("THEN test something else", () => {
        // test something else using the same 'testWorkspace'
      });
    });
  });
});