Skip to content

Commit

Permalink
Improves project test command clarity, README update and linting (PR #…
Browse files Browse the repository at this point in the history 
…396)

 Merge pull request #396 from kendraio/angular-test-documentation
  • Loading branch information
@lukestanley
lukestanley committed Feb 1, 2024
2 parents fd28d67 + 67bd23d commit e609dab
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 51 deletions.
77 changes: 30 additions & 47 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@

Kendraio App
============
# Kendraio App

Kendraio App is an open source dashboard application for rights owners, music makers, managers and record labels, enabling users to manage and track their digital media assets, collaborations and associated rights.

Expand All @@ -23,8 +21,7 @@ Kendraio App is an open source dashboard application for rights owners, music ma

![Angular Version](https://img.shields.io/github/package-json/dependency-version/kendraio/kendraio-app/@angular/core)

Contribute
----------
## Contribute

- Read the documentation: <https://kendraio-app.readthedocs.io>
- For help and support, join the conversation on Slack: <http://slack.kendra.io>
Expand All @@ -33,8 +30,7 @@ Contribute
- To download the source code, visit the repo: <https://github.com/kendraio/kendraio-app>
- Sponsored by [▲ Vercel](https://vercel.com?utm_source=kendraio&utm_campaign=oss), [Mailgun](https://www.mailgun.com), [Atlassian](https://www.atlassian.com), [Auth0](https://auth0.com)

Instant Development with Github Codespaces
------------------------------------------
## Instant Development with Github Codespaces

If you have access to github codespaces, you can start developing on Kendraio immediately.
The "code" button on our github page (https://github.com/kendraio/kendraio-app) will offer you
Expand All @@ -48,59 +44,50 @@ to "localhost:4200", click on this link to open the running Kndraio app in a new

You now have a live development environment. Create yourself a branch and you're off.

The Devcontainer.json file
===========================
A devcontainer.json file in your project tells Visual Studio Code (and other services and tools that support the format) how to access (or create) a development container with a well-defined tool and runtime stack. This file is used to automatically configure Codespaces, and it will also allow for local development using containers.
# The Devcontainer.json file

A devcontainer.json file in your project tells Visual Studio Code (and other services and tools that support the format) how to access (or create) a development container with a well-defined tool and runtime stack. This file is used to automatically configure Codespaces, and it will also allow for local development using containers.

Setting up a local development environment
------------------------------------------
## Setting up a local development environment

If you are not running inside a container, you will need to install node, npm, and the Angular CLI.

* Clone the repo.
* Run `npm install`

You can start the development server using `npm run serve:dev` or use `npm run e2e:serve_and_retest_on_change`, which will run the dev server and tests upon changes.
- Clone the repo.
- Run `npm install`

You can start the development server using `npm run serve:dev` or use `npm run test:serve_and_retest_on_change`, which will run the dev server and tests upon changes.

Running End-to-end tests with the development environment
------------------------------------------
## Running Unit and End-to-end tests with the development environment

`npm run e2e:serve_and_retest_on_change` will start the dev server, and run unit and E2E tests automatically upon file changes. It is useful for general local develoment.
`npm run test:serve_and_retest_on_change` will start the dev server, and run unit and E2E tests automatically upon file changes. It is useful for general local develoment.

`npm run e2e:retest_on_change` will re-run unit and E2E tests automatically upon file changes, but it needs a running server.
`npm run test:retest_on_change` will re-run unit and E2E tests automatically upon file changes, but it needs a running server.

`npm run e2e:autorun` is good for automatically running unit and E2E tests ONCE, using an already running server.
`npm run test:autorun` is good for automatically running unit and E2E tests ONCE, using an already running server.

`npm run e2e:serve_and_test` will start the dev server, and run unit and E2E headless tests once automatically and stop, producing a HTML report file and JSON file at `cypress/results/mochawesome.json` on first run.
`npm run test:serve_and_test` will start the dev server, and run unit and E2E headless tests once automatically and stop, producing a HTML report file and JSON file at `cypress/results/mochawesome.json` on first run.

The existing `npx ng e2e` Angular command works too, but requires clicking on the set of tests that need running. It builds and runs the server then runs E2E tests once.

Running tests in a container
============================
The predefined npm test commands have all been configured to run in a container, but if you are using alternative testing commands, you may find that testing fails due to the lack of a display. To get around this, use **xvfb-maybe**, which will set up a virtual display if one is needed.

To use xvfb-maybe, prefix any commandline with `npx xvfb-maybe`
eg:
* `npx xvfb-maybe ng test`

# Running tests in a container

The predefined npm test commands have all been configured to run in a container, but if you are using alternative testing commands, you may find that testing fails due to the lack of a display. To get around this, use **xvfb-maybe**, which will set up a virtual display if one is needed.

To use xvfb-maybe, prefix any commandline with `npx xvfb-maybe`
eg:

- `npx xvfb-maybe ng test`

Adding a "Block" (i.e. Task for the Flow editor)
--------------------------------------------------
## Adding a "Block" (i.e. Task for the Flow editor)

Use the Angular CLI to scaffold a new block: `npx ng g c blocks/my-block`
Edit the generated my-block.component.ts to make it a sub-class of BaseBlock.

Start by setting up your initial imports.

Start by setting up your initial imports.

```javascript
import { BaseBlockComponent } from '../base-block/base-block.component';
import {get} from 'lodash-es';
```javascript
import { BaseBlockComponent } from "../base-block/base-block.component";
import { get } from "lodash-es";
```

Take a look at one of the more recent blocks as an example, eg the AudioPlayer:
Expand All @@ -118,7 +105,7 @@ onConfigUpdate(config: any) {

onData(data: any, firstChange: boolean) {
// block is receiving data from the block before it in the flow
// if you need to pass data to the next block, call emit on output
// if you need to pass data to the next block, call emit on output
this.output.emit(this.model);
}
```
Expand All @@ -130,16 +117,12 @@ Add any required CSS to the stylesheet for the component.
To make the block show up in the App:
- Add the component to this horrible big switch block in the BlocksWorkflowComponent [src/app/components/blocks-workflow/blocks-workflow.component.html](src/app/components/blocks-workflow/blocks-workflow.component.html)
This is needed for the flow to show up in rendered workflows.
This is needed for the flow to show up in rendered workflows.
- Add a definition, and default configuration, for the block to the block types so it can appear in the "Add Task" dialog:
[src/app/dialogs/add-block-dialog/block-types.ts](src/app/dialogs/add-block-dialog/block-types.ts)
[src/app/dialogs/add-block-dialog/block-types.ts](src/app/dialogs/add-block-dialog/block-types.ts)
Adding a custom block editor interface
--------------------------------------
## Adding a custom block editor interface
The block editor is implemented using the blocks-editor component.
In order to create a custom editor, you will need to create a new component,
The block editor is implemented using the blocks-editor component.
In order to create a custom editor, you will need to create a new component,
and call it via [blocks-editor.component.html](/src/app/components/blocks-editor/blocks-editor.component.html)
8 changes: 4 additions & 4 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
"//comment1": "NB: Dynamic index html generation (SSO)",
"//comment2": "Before deploy, do prod build, and move index.html to functions folder",
"deploy": "mv dist/index.html functions/ && firebase deploy --only functions,hosting",
"e2e:serve_and_retest_on_change": "xvfb-maybe start-server-and-test serve:dev http://localhost:4200 'npm run e2e:retest_on_change'",
"e2e:retest_on_change": "xvfb-maybe nodemon -e js,jsx,ts,tsx,css,scss --exec 'ng test -- --watch=false; cypress run --headed --no-exit'",
"e2e:autorun": "xvfb-maybe ng test -- --watch=false; xvfb-maybe cypress run --headed",
"e2e:serve_and_test": "npx cypress install; xvfb-maybe start-server-and-test serve:dev http://localhost:4200 'ng test -- --watch=false; cypress run'",
"test:serve_and_retest_on_change": "xvfb-maybe start-server-and-test serve:dev http://localhost:4200 'npm run test:retest_on_change'",
"test:retest_on_change": "xvfb-maybe nodemon -e js,jsx,ts,tsx,css,scss --exec 'ng test --watch=false; cypress open --config watchForFileChanges=true'",
"test:autorun": "xvfb-maybe ng test --watch=false; xvfb-maybe cypress run --headed",
"test:serve_and_test": "npx cypress install; xvfb-maybe start-server-and-test serve:dev http://localhost:4200 'ng test --watch=false; cypress run'",
"lint": "ng lint"
},
"private": true,
Expand Down

0 comments on commit e609dab

Please sign in to comment.