plone / plone/plone.restapi

Decouple acceptance test suite from the plone.restapi implementation.

Open
#162 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

05 type: question
Dominant language
Python
Stars
109
Forks
107
Avg merge
2d 3h
Merged PRs (30d)
4

Description

It would be useful to have a suite of acceptance tests that can be run against any backend that tries to provide the same API as plone.restapi (for example: Nick). In other words: a test suite that can be pointed as a configured API URL, rather than setting up plone.restapi in process.

This would be useful for:

  • checking compatibility
  • comparing performance

Maybe it is possible to convert the existing test suite (especially the functional tests that produce the examples in the docs) with help from an LLM.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing acceptance and functional test suite, especially the tests that produce documentation examples, and how it currently sets up plone.restapi in process. Determine how the suite could accept a configured API URL and run against another backend. Done means the tests can target a compatible backend without requiring plone.restapi in process.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.