Change annotation name

[jasondlee]

Rename DockerRequired to ContainerRequired
Clean up stray references to "docker"

Resolves #39.

[rhusar]

I was hoping to some aggressive discussion/voting on that issue. I have to say my favorite is @ContainerRuntimeRequired.

[jasondlee]

I was hoping to some aggressive discussion/voting on that issue. I have to say my favorite is @ContainerRuntimeRequired.

And we can have that. :) I just pushed this so I didn't lose the changes I had locally.

[rhusar]

After more discussions with @jamezp I believe this should be actually called '@TestcontainersRequired'. What we need the annotation to specify, is that Testcontainers client works. This is to my knowledge currently the same as podman or docker required, but this may not always be the case. Also, that's what the implementation checks for.

[jamezp]

After more discussions with @jamezp I believe this should be actually called '@TestcontainersRequired'. What we need the annotation to specify, is that Testcontainers client works. This is to my knowledge currently the same as podman or docker required, but this may not always be the case. Also, that's what the implementation checks for.

This makes the most sense to me as well.

[jamezp]

This is a very minor comment. Should this "a Testcontainer engine"? I don't have a real strong opinion either way.

[rhusar]

I also think this needs a different wording, but I am not yet sure what's the ideal wording :)

[jasondlee]

I'm fine to leave it as is, but no strong opinion either. I think, though, that the "engine" is either Docker or Podman (at this point), whereas Testcontainers is the... orchestration tool that starts a "container" using whatever "engine" is available in the environment.

[jasondlee]

I also think this needs a different wording, but I am not yet sure what's the ideal wording :)

Well, it seems that whole Javadoc is pretty outdated anyway. That sample code is pretty rough. Let me revisit that...

[rhusar]

Though "Testcontainer engine" is not a thing, how about going the descriptive way something like "the test will be skipped if Testcontainers requirements are not available." or just "Testcontainers are not available."

[jasondlee]

@rhusar @jamezp, Updated the sample code and just removed the comment altogether.

[jamezp]

I'm good with whatever wording we choose. I like the annotation name so I'm approving :)

[jasondlee]

I think we have a consensus, so I'm going to merge this. If you want any further changes, @rhusar, please follow up with an issue.

[rhusar]

Agreed! Thanks.