Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gobengo/activitypub-testing-fedify
https://github.com/gobengo/activitypub-testing-fedify
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gobengo/activitypub-testing-fedify
- Owner: gobengo
- Created: 2024-06-21T20:25:41.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-14T22:04:47.000Z (2 months ago)
- Last Synced: 2024-10-03T15:28:48.981Z (about 1 month ago)
- Language: TypeScript
- Size: 315 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# activitypub-testing-fedify
[activitypub-testing](https://activitypub-testing.socialweb.coop/) + [fedify](https://fedify.dev/)
This repository runs the activitypub-testing test runner against a simple server powered by fedify.
## getting started
1. clone this repo
2. install dependencies `npm ci`
3. run tests with `npm test`
## scripts
### `bin/activitypub-testing`
runs `server.ts`, then run `activitypub-testing test actor` against the running server.
### `bin/docker-herokuish-buildpack-test`
[runs `herokuish buildpack test`](https://github.com/gliderlabs/herokuish?tab=readme-ov-file#running-an-app-tests-using-heroku-buildpacks) in a docker container. Herokuish should detect that this is a nodejs package, use heroku-buildpack-nodejs, and eventually `npm install` and `npm test`.
```shell
⚡ ./bin/docker-herokuish-buildpack-test
```
## github workflows
`/.github/workflows/` contains workflow definitions.
### workflows
#### main
main workflow. runs tests on every push.
##### jobs
###### test
test the activitypub-testing-fedify package using `npm test`.
#### activitypub-testing
on ever push, run `activitypub-testing test actor $server/users/me` against the server.
##### jobs
###### tap-summary
reports on the test results.
This is a WIP job
* [x] prototype with fake TAP in [tap/01-common.tap](./tap/01-common.tap)
* [ ] activitypub-testing should output TAP or JUnit
* [ ] prototype script that converts existing activitypub-testing JSON output to TAP
* [ ] replace 01-common.tap with TAP output from activitypub-testing in this tap-summary job
###### test-actor
runs `activitypub-testing test actor` against the server using `bin/activitypub-testing`
### run locally with nektos/act
Install [nektos/act](https://nektosact.com/introduction.html).
Then see jobs like
```
⚡ act -l
Stage Job ID Job name Workflow name Workflow file Events
0 test-actor `activitypub-testing test actor` node=${{ matrix.node-version }} activitypub-testing.yaml activitypub-testing.yaml push,workflow_dispatch
0 test-actor-yaml test-actor-yaml activitypub-testing.yaml activitypub-testing.yaml push,workflow_dispatch
0 test test main.yaml main.yaml push
```
Run all with `act` or a named job like `act -j test-actor`
```shell
⚡ act -j test-actor
[activitypub-testing.yaml/`activitypub-testing test actor` node=21.x-2] 🚀 Start image=ghcr.io/catthehacker/ubuntu:act-latest
[activitypub-testing.yaml/`activitypub-testing test actor` node=20.x-1] 🚀 Start image=ghcr.io/catthehacker/ubuntu:act-latest
…
```