The ActivityPub test suite

test.activitypub.rocks has been down for a long time, as pretty much everyone knows. More or less it’s server issues, and I can be blamed since I run the server (and wrote the test suite).

Why hasn’t it gone back up though? Mainly because I’m a) very busy b) know how poor the test suite is at fulfilling the needs of the community and that makes it hard to feel motivated to put in the work.

Here are some quirks about test.activitypub.rocks:

  • It was done in a rush to meet the standards deadline. The main purpose was to collect implementation reports, and given the rush some things are funny about it.
  • It was done in such a rush that it’s a completely separate program that’s just bundled straight into the same codebase as the test activitypub implementation I was writing, Pubstrate (which has some good ideas but which I won’t recommend either).
  • Technically it’s two test suites. Scratch that, it’s a test suite and a questionaire:
    • There’s a test suite for the client to server protocol, which really does resemble a test suite; it makes many requests against your server and sees if they work right. (It’s buggy, though.)
    • There’s a mostly-questionaire (but it runs a couple tests, I think) for the server-to-server protocol. Why? Because a) performing a test suite on an asynchronous protocol is already hard enough (when does the test complete? it can be done with timeouts, but it’s gross) and b) many of the requirements required that some authentication or authorization take place, but due to process reasons we couldn’t specify what that was, and c) at that point we already had an unusual amount of interop, so we decided that if multiple implementations could federate on a feature and could confirm that in the questionaire, we could consider that sufficient. (Even weirder, some of the questions would involve the server doing something to your server, but then still having a question for the user to confirm if the thing worked.)
  • A proper test suite wouldn’t work like this. It would be fully automated.

It does look pretty though, that’s the only thing I’ll give it credit for. :stuck_out_tongue:

Where to from here? There are really a few options:

  • Do nothing, things remain broken. Obviously not ideal!
  • I get back up the test suite. Again, it’s hard for me to get motivated about this but I could probably do it. But then I fear once I get it up all I’ll get in response is THIS is the test suite? WTF, this isn’t a test suite at all!
  • Someone else could get up the test suite based on the current codebase and I could transfer running it to them. Notably someone tried this already but they weren’t familiar with Guix, and that’s currently the easiest way to get it up and running :stuck_out_tongue:
  • Someone else could write a new, much better version of the test suite. In fact we discussed this on a recent SocialCG call and I was asked how I would feel about that, and I more or less said I thought that would be great. But someone needs to do it. Who? Maybe it’s you!

So… what next?

4 Likes

I favor the last option:

Someone else could write a new, much better version of the test suite

It’s even possible that I can help, but I’m a guile/scheme noob so there’s probably not much I can do with the legacy test suite.

To make sure it is not just me to be scared by scheme, elixir & friends I did a quick, unscientific search for activitypub-related repos on github and got 233 repos with this language distribution:

number of repos programming language
30 Python
25 Go
23 PHP
21 JavaScript
16 Rust
13 Ruby
10 TypeScript
9 HTML
7 Elixir
5 Clojure

IMHO the test suite should be implemented in a language which is both popular among activitypub hackers, and has good support for testing asynchronous protocols.

1 Like

I think that’s a nice-to-have. If someone is generous enough with their time to do a rewrite, I think that they should use the language they’re most comfortable with.

However, if they happened to pick Go, and happened to want to use go-fed apcore (which would help motivate my current slow-go near the finish line), I would gladly offer heavy collaboration (voice/video chat).

Golang can do.

Tentative requirements for this webapp:

  1. test suite results are generated as static HTML files that can be accessed publicly from a permalink; there is a summary page for all implementations, with the lastest test

  2. to start a test, the user has to log in to an “implementer dashboard” using her socialhub.activitypub.rocks account (we can use discourse as a SSO provider, there is an official golang implementation) and request it, filling a form

  3. test requests are stored in a queue and asynchronously processed; basic queue management: list tests, test status, cancel test, retry test

  4. notifications (“test failed”, “test passed” etc.) are posted to a discourse category (https://socialhub.activitypub.rocks/c/tests), quoting the user (@rocco) so that she is pinged

Types of test suites:

  • user has a client up and running:

    • c2s: test user’s client against our server
  • user has a server up and running:

    • c2s: test user’s server against our client
    • s2s: test user’s server against our server

The webapp must be dockerized so that it can be run standalone with a development local discourse instance.

It should be also possible to run each test suite locally from CLI so that the same tests can be run as local tests or as part of CI for each implementation (go implementations will benefit more from this).

1 Like