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

[PF-2987] Add dependabot for 3rd party library upgrades, remove lockfiles and spotbugs #115

Merged
merged 6 commits into from
Feb 29, 2024

Conversation

cahrens
Copy link
Contributor

@cahrens cahrens commented Feb 26, 2024

Same configuration as in terra-common-library.

Also removes lockfiles and spotbugs, similar to what we have done in our other libraries (for example, DataBiosphere/terra-common-lib#148 and DataBiosphere/terra-common-lib#147).

@cahrens cahrens requested review from a team, nmalfroy and jsotobroad and removed request for a team February 26, 2024 21:54
@@ -1,140 +0,0 @@
# This is a Gradle generated file for dependency locking.
Copy link
Contributor

Choose a reason for hiding this comment

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

not that I"m complaining but why the removal of hte .lockfiles?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We've been removing lockfiles in all of our repos to make dependency upgrades easier.

timezone: "America/New_York"
target-branch: "develop"
reviewers:
- "@DataBiosphere/platform-foundation-codeowners"
Copy link
Contributor

Choose a reason for hiding this comment

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

just double checking that these reviewers are the group we want for this (out of ignorance on my part 😬)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, we talked about this today at the "round table" meeting. It might not be the perfect group for reviews, but we don't wish to maintain a second group.

@cahrens cahrens changed the title [PF-2987] Add dependabot for 3rd party library upgrades [PF-2987] Add dependabot for 3rd party library upgrades, remove lockfiles and spotbugs Feb 26, 2024
@cahrens
Copy link
Contributor Author

cahrens commented Feb 26, 2024

I don't understand why this isn't kicking off any tests (given the source code changes).

@cahrens
Copy link
Contributor Author

cahrens commented Feb 26, 2024

It looks like tests are not triggered on commits. I am putting this PR into draft until we get unit tests running.

@cahrens cahrens marked this pull request as draft February 26, 2024 22:19
import org.apache.commons.lang3.ClassUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.apache.commons.lang3.tuple.Pair;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.lang.Nullable;
Copy link
Contributor Author

@cahrens cahrens Feb 27, 2024

Choose a reason for hiding this comment

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

javax.annotation.Nullable was coming from spotbugs (https://www.javadoc.io/doc/com.google.code.findbugs/jsr305/latest/javax/annotation/Nullable.html).

There seem to be lots of options for @nullable, so I went with a package that was already available with our current dependencies. We do use this package in some of our other repos. https://github.com/search?q=org%3ADataBiosphere%20org.springframework.lang.Nullable&type=code

Copy link
Member

Choose a reason for hiding this comment

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

I think a better fix would be to use jakarta.annotation.Nullable, as it doesn't require a framework dependency.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It didn't seem that was available with our current dependencies/framework, but perhaps IntelliJ was lying to me?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it might need an additional dependency like https://mvnrepository.com/artifact/jakarta.annotation/jakarta.annotation-api

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, I started looking into adding that, but then punted since we use org.springframework.lang.Nullable in some of our other repos.

@cahrens cahrens marked this pull request as ready for review February 27, 2024 23:19
Copy link
Contributor

@jsotobroad jsotobroad left a comment

Choose a reason for hiding this comment

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

It sounds like we're not sure if we want to remove spotbugs yet since sonarqube isnt in this repo. Would it be worthwhile to separate the dependabot changes from the spotbugs stuff to get that in?

The changes look fine overall.

@cahrens
Copy link
Contributor Author

cahrens commented Feb 28, 2024

It sounds like we're not sure if we want to remove spotbugs yet since sonarqube isnt in this repo. Would it be worthwhile to separate the dependabot changes from the spotbugs stuff to get that in?

The changes look fine overall.

This, @jsotobroad . I agree that I could pull out the spotbugs removal, but first I'm going to reach out to infosec folks and see if we can just get sonarqube running on this repo.

@cahrens
Copy link
Contributor Author

cahrens commented Feb 29, 2024

It sounds like we're not sure if we want to remove spotbugs yet since sonarqube isnt in this repo. Would it be worthwhile to separate the dependabot changes from the spotbugs stuff to get that in?
The changes look fine overall.

This, @jsotobroad . I agree that I could pull out the spotbugs removal, but first I'm going to reach out to infosec folks and see if we can just get sonarqube running on this repo.

@jsotobroad , @TomConner is OK with us going ahead and removing spotbugs. So this PR is now ready for review.

https://broadinstitute.slack.com/archives/CADU7L0SZ/p1709132894654009

@cahrens cahrens requested a review from jsotobroad February 29, 2024 15:12
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@@ -50,7 +48,7 @@ jobs:
cache: 'gradle'
- name: Run tests
run: ./gradlew test

# TODO: Work with AppSec to get Sonar scans setup for this repo
Copy link
Contributor

Choose a reason for hiding this comment

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

👋

@cahrens cahrens requested a review from okotsopoulos February 29, 2024 15:25
Copy link
Contributor

@okotsopoulos okotsopoulos 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 taking this on! I have some Stairway work in flight and will be really happy to see the lockfiles go away :)

@cahrens cahrens merged commit 0f1e400 into develop Feb 29, 2024
3 checks passed
@cahrens cahrens deleted the PF-2987 branch February 29, 2024 15:29
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