Skip to content

[MPLUGINTESTING-93] Documentation for Plugin testing#597

Closed
aamotharald wants to merge 13 commits intoapache:masterfrom
aamotharald:docu/MPLUGINTESTING-93
Closed

[MPLUGINTESTING-93] Documentation for Plugin testing#597
aamotharald wants to merge 13 commits intoapache:masterfrom
aamotharald:docu/MPLUGINTESTING-93

Conversation

@aamotharald
Copy link
Copy Markdown

Added Docu on how to test with JUnit5.
Converted the Docu from apt to md .
This PR should only get merged once org.apache.maven.plugin-testing:maven-plugin-testing-harness:3.4.0 has been released as on 3.3.0 there is no JUnit5 testing support at all.

@slawekjaranowski slawekjaranowski self-requested a review December 17, 2024 10:41
@slawekjaranowski slawekjaranowski self-assigned this Dec 21, 2024
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Copy link
Copy Markdown
Contributor

@Bukama Bukama left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the migration. Got some comments, you may want to consider.

P.S. I personally prefer to write only one sentence per line in a documentation as code file, but I don't know if maven has clear rules about this.

Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
@elharo elharo changed the title MPLUGINTESTING-93 Documentation for Plugin testing [MPLUGINTESTING-93] Documentation for Plugin testing Dec 23, 2024
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
@aamotharald
Copy link
Copy Markdown
Author

Thanks @slawekjaranowski @elharo and @Bukama for your review! I learned a lot and was able to address your review comments with (for me) sound solutions.

Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated

### Using PlexusTestCase

Mojo variables are injected by Guice (an open-source software framework for the Java platform), sometimes with a Codehaus Plexus (a collection of components used by Apache Maven) adapter to support the legacy `@Component` annotation.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete "to support the legacy @Component annotation."

I've eliminated all of those

Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md
@Bukama
Copy link
Copy Markdown
Contributor

Bukama commented Jan 6, 2025

Can't add anything to what @elharo has already mentioned.

Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated

### Using PlexusTestCase

Mojo variables are injected by Guice (an open-source software framework for the Java platform), sometimes with a Codehaus Plexus (a collection of components used by Apache Maven) adapter.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete "(an open-source software framework for the Java platform)" as it doesn't add much. Folks can Google it if they've never heard of it

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and might as wellm delete "(a collection of components used by Apache Maven)" too

Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md Outdated
Comment thread content/markdown/plugin-developers/plugin-testing.md
Comment thread content/markdown/plugin-developers/plugin-testing.md
Comment thread content/markdown/plugin-developers/plugin-testing.md
@elharo elharo added the documentation Improvements or additions to documentation label Jan 22, 2025
@slawekjaranowski
Copy link
Copy Markdown
Member

Thanks for work ... By the way I would like to have such documentation in project in branch 3.x
https://github.com/apache/maven-plugin-testing/tree/maven-plugin-testing-3.x

I'm still think that release of 3.4.0 - maven-plugin-testing should be done ... on my list 😄

@Bukama
Copy link
Copy Markdown
Contributor

Bukama commented Aug 3, 2025

@aamotharald Sorry for the long time not responding. We are still interested in the changes of your PR. Would you refresh it (put in last comments and resolve conflicts) :)

@slawekjaranowski
Copy link
Copy Markdown
Member

@aamotharald thanks for the effort, we have done similar updates in:

so I close it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants