Skip to content

Commit

Permalink
Clean up test comments and describe text, update tinylicious readme (m…
Browse files Browse the repository at this point in the history
  • Loading branch information
ChumpChief authored Jul 10, 2024
1 parent 76d9569 commit df50641
Show file tree
Hide file tree
Showing 12 changed files with 17 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

import { globals } from "../jest.config.cjs";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("contactCollection", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
Expand Down
1 change: 0 additions & 1 deletion examples/apps/task-selection/tests/diceRoller.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

import { globals } from "../jest.config.cjs";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("diceRoller", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@

import { globals } from "../jest.config.cjs";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("inventoryList", () => {
describe("tree-comparison", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
// so this time isn't attributed to the first test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

import { globals } from "../jest.config.cjs";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("external-controller-diceRoller", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

import { globals } from "../jest.config.cjs";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("diceRoller", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ import { IMigrator } from "@fluid-example/example-utils";
import { globals } from "../jest.config.cjs";
import { IContainer } from "@fluidframework/container-definitions/internal";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("inventoryList", () => {
describe("same-container migration", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
// so this time isn't attributed to the first test
Expand Down Expand Up @@ -42,6 +41,7 @@ describe("inventoryList", () => {
await expect(containsOne).toEqual(true);
});

// Test skipped, not functioning currently
it.skip("migrates and shows the correct code version after migration", async () => {
// Validate the migration status shows "one" initially
await Promise.all([
Expand Down Expand Up @@ -92,6 +92,7 @@ describe("inventoryList", () => {
});
});

// Test skipped, not functioning currently
describe.skip("With summarizer connected", () => {
beforeEach(async () => {
await page.goto(`${globals.PATH}`, { waitUntil: "load" });
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ import { IMigrator } from "@fluid-example/example-utils";
import { globals } from "../jest.config.cjs";
import { IContainer } from "@fluidframework/container-definitions/internal";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("inventoryList", () => {
describe("separate-container migration", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
// so this time isn't attributed to the first test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@

import { globals } from "../jest.config.cjs";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("inventoryList", () => {
describe("tree-shim", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
// so this time isn't attributed to the first test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

import { globals } from "../jest.config.cjs";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("diceRoller", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

import { globals } from "../jest.config.cjs";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("diceRoller", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

import { globals } from "../jest.config.cjs";

// Tests disabled -- requires Tinylicious to be running, which our test environment doesn't do.
describe("diceRoller", () => {
beforeAll(async () => {
// Wait for the page to load first before running any tests
Expand Down
16 changes: 11 additions & 5 deletions server/routerlicious/packages/tinylicious/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,25 @@ Tinylicious is a minimal, self-contained, test implementation of the Fluid Frame

## What is this for?

Tinylicious includes most of the basic features needed to **test** data stores and containers. While we use the [Webpack Fluid Loader](../../packages/tools/webpack-fluid-loader)'s in browser service for much of our data store and container development, Tinylicious offers some advantages because it's a standalone process. For instance, testing a Fluid Container from 2+ simultaneously connected clients can be easier using Tinylicious.
Tinylicious includes most of the basic features needed to **test** data stores and containers. While we use the [Local Server](../local-server) as an in-browser service for much of our data store and container development, Tinylicious offers some advantages because it's a standalone process. For instance, testing a Fluid Container from 2+ simultaneously connected clients can be easier using Tinylicious.

If you're looking for a reference implementation of the Fluid service, don't look here! Go check out [Routerlicious](../routerlicious).

## Getting Started

You can install, build, and start this service by running the following
You can build this service by running the following in the /server/routerlicious directory (NOT in this directory):

```sh
npm i -g pnpm
pnpm i
npm run build
npm run start
pnpm build
```

Afterwards, you can start and stop this service with the following commands in this directory:

```sh
pnpm start
pnpm stop
```

## Configuration
Expand All @@ -28,7 +34,7 @@ variable named PORT to the desired number. For example:

```sh
$env:PORT=6502
npm run start
pnpm start
```

### Storage
Expand Down

0 comments on commit df50641

Please sign in to comment.