caddyserver / caddyserver/certmagic

Test suite for storage implementations

Open
#58 5 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Go
Stars
5.6k
Forks
354
Avg merge
9d 23h
Merged PRs (30d)
3

Description

Hi,

I would love to write a DynamoDb certmagic.Storage implementation (as per #41) - and have done so. What I'm not confident about is whether it correctly implements the interface, e.g. in terms of respective the recursive parameter for List() etc.

Is there a suite of tests that I can run against my implementation to make sure it is correct?

Thank you for such a wonderful package.

EDIT: The work in progress is here. I haven't implemented locking, etc yet. But might be helpful for discussion purposes https://github.com/glassechidna/awscertmagic/blob/master/dynamodb.go

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 with the certmagic.Storage interface, especially the List method's recursive parameter, and review the linked dynamodb.go implementation for expected behavior. Add reusable tests that a storage implementation can run, covering the interface semantics; done means an implementation can verify its behavior against the suite, including recursive listing.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.