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

Unit Tests, Artifact Publishing & Updated Documentation #33

Merged
merged 30 commits into from
Sep 23, 2024

Conversation

dmccoystephenson
Copy link
Contributor

Unit Tests

Problem

No unit tests were previously implemented.

Solution

Unit tests have now been added.

New Classes

To improve testability, the following classes have been introduced to encapsulate specific operations:

  • HttpClientFactory
  • HttpEntityStringifier
  • KeyStoreReader
  • RestTemplateFactory
  • SSLContextFactory

The Message class has also been moved to its own file.

Typo Correction

The typo "certficates" has been corrected to "certificates" throughout the project.

Testing

All unit tests pass, and the signing functionality has been confirmed to work.

Artifact Publishing

A GitHub Action has been added to publish Java artifacts to GitHub's hosted Maven Central.

Updated Documentation

Problem

The README was outdated and unclear.

Solution

The README has been updated for accuracy and clarity.

dmccoystephenson and others added 30 commits June 26, 2024 14:58
…ssage to external service using certificates
…uracy

Revised Documentation for Accuracy
…ease-notes

Version Change & Release Notes (2024 Q3 Release)
@dmccoystephenson dmccoystephenson marked this pull request as ready for review September 9, 2024 16:25
@@ -0,0 +1,31 @@
name: Publish Java Package
Copy link
Contributor

Choose a reason for hiding this comment

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

What will be the approx. artifact size and where we are using this ? As our ODE GitHub org is on free plan we have artifact storage limit of 500mb.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The project's JAR file is about 57 MB in size. It is not currently being used, but it is for potential future use. It may be possible to reduce the size of the JAR file in the future.

Copy link
Contributor

Choose a reason for hiding this comment

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

@dmccoystephenson seems like for Maven packages and other packages like npm, docker, etc storage limit will be not applied for public repo's. so I think we should be good to use artifacts. However for any private repo's this limits will apply. We have a backlog item for supporting GitHub artifacts setup in future release. Thanks!

@dan-du-car dan-du-car merged commit aec6ec8 into usdot-jpo-ode:develop Sep 23, 2024
4 checks passed
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 this pull request may close these issues.

6 participants