Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better name for @DockerRequired #39

Open
rhusar opened this issue Nov 4, 2024 · 5 comments · May be fixed by #43
Open

Better name for @DockerRequired #39

rhusar opened this issue Nov 4, 2024 · 5 comments · May be fixed by #43

Comments

@rhusar
Copy link
Collaborator

rhusar commented Nov 4, 2024

Let's find a better name for @DockerRequired. We in reality require any containerization software that is compatible with Testcontainers (their explicit wording 'Docker-API compatible container runtime'), thus including podman. Random ideas:

  • RequiresContainerRuntime
  • ContainerRuntimeRequired
  • ContainersRequired
  • RequiresContainers
  • ContainerizationRequired
  • RequiresContainerization
  • RequiresDockerAPICompatibleRuntime
  • CompatibleContainerRuntimeRequired
  • ContainerEnvironmentRequired
  • ContainerRuntimeCompatible
  • OpenContainersRequired
@jasondlee jasondlee linked a pull request Nov 18, 2024 that will close this issue
@jamezp
Copy link
Collaborator

jamezp commented Nov 20, 2024

I've got a new suggestion of @RequiresTestcontainers to make it more generic and really what this is about.

@rhusar
Copy link
Collaborator Author

rhusar commented Nov 20, 2024

I've got a new suggestion of @RequiresTestcontainers to make it more generic and really what this is about.

I like the that, but in reality is checks for docker/podman runtime? :-) Wouldn't that make it a bit of a misnomer?

@jamezp
Copy link
Collaborator

jamezp commented Nov 20, 2024

It does, but that's an implementation detail. We only check if it exists because that's what Testcontainers requires. If for whatever reason they switched to something else, it wouldn't make much sense. The idea is we're saying "Something in this test requires Testcontainers".

@jasondlee
Copy link
Collaborator

It does, but that's an implementation detail. We only check if it exists because that's what Testcontainers requires. If for whatever reason they switched to something else, it wouldn't make much sense. The idea is we're saying "Something in this test requires Testcontainers".

That's why I like (d?) @ContainerRequired. It doesn't imply or require a specific containerization engine.

@jamezp
Copy link
Collaborator

jamezp commented Nov 20, 2024

I'd be a +1 for @ContainerRequired too if we don't like @RequiresTestcontainers. The term "container" is overloaded, but I don't have a better suggestion other than explicitly saying "Testcontainers".

I do also like @OpenContainersRequired given that is the initiative name https://opencontainers.org/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants