Add Support for Retrieving Template Repository Information for a Repo…

[jbenaventem]

Description

Add Support for Retrieving Template Repository Information for a Repository #1812

Before submitting a PR:

• Changes must not break binary backwards compatibility. If you are unclear on how to make the change you think is needed while maintaining backward compatibility, CONTRIBUTING.md for details.
• Add JavaDocs and other comments explaining the behavior.
• When adding or updating methods that fetch entities, add @link JavaDoc entries to the relevant documentation on https://docs.github.com/en/rest .
• Add tests that cover any added or changed code. This generally requires capturing snapshot test data. See CONTRIBUTING.md for details.
• Run mvn -D enable-ci clean install site locally. If this command doesn't succeed, your change will not pass CI.
• Push your changes to a branch other than main. You will create your PR from that branch.

[gsmet]

Thanks for the PR!

I added some feeback and questions.

[gsmet]

Why do you clone() the repo? This looks odd to me (and I usually refrain from using clone()).

[gsmet]

Also I suspect you will have to inject the root in the repository, unless it's done automatically by Jackson.

In any case, adding a test to test that you can actually execute an operation on the repository after getting it would be better.

[jbenaventem]

The clone method was because I've found an spotbug error "EI_EXPOSE_REP: May expose internal representation by returning reference to mutable object", it's for that reason I implements Clonable in this object, and return an object copy.

[gsmet]

I think you need to add the following annotation to the method instead:

@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected")

[jbenaventem]

Ok, It's another posibility, but I unknow the project security rules.

[jbenaventem]

Also I suspect you will have to inject the root in the repository, unless it's done automatically by Jackson.

In any case, adding a test to test that you can actually execute an operation on the repository after getting it would be better.

Sorry, my English is terrible, and I'm not sure about that comment.
Is the provided test sufficient?

    /**
     * Test get repository created from a template repository
     *
     * @throws Exception
     *             the exception
     */
    @Test
    public void testGetRepositoryWithTemplateRepositoryInfo() throws Exception {
        GHRepository testRepo = gitHub.getRepositoryById(repo.getId());
        assertThat(testRepo.getTemplateRepository(), notNullValue());
        assertThat(testRepo.getTemplateRepository().getOwnerName(), equalTo("octocat"));
        assertThat(testRepo.getTemplateRepository().isTemplate(), equalTo(true));
    }

[codecov]

Codecov Report

Attention: Patch coverage is 57.14286% with 3 lines in your changes are missing coverage. Please review.

Project coverage is 80.71%. Comparing base (1aa7178) to head (2105263).
Report is 4 commits behind head on main.

❗ Current head 2105263 differs from pull request most recent head 88cfdad. Consider uploading reports for the commit 88cfdad to get more accurate results

Files	Patch %	Lines
src/main/java/org/kohsuke/github/GHRepository.java	50.00%	2 Missing ⚠️
...n/java/org/kohsuke/github/GHRepositoryBuilder.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1817      +/-   ##
============================================
+ Coverage     80.66%   80.71%   +0.04%     
- Complexity     2342     2345       +3     
============================================
  Files           220      221       +1     
  Lines          7082     7119      +37     
  Branches        379      384       +5     
============================================
+ Hits           5713     5746      +33     
- Misses         1132     1136       +4     
  Partials        237      237              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jbenaventem]

@gsmet Thank you for the review. I've resolved almost comments.
About this comment

Also I suspect you will have to inject the root in the repository, unless it's done automatically by Jackson.
In any case, adding a test to test that you can actually execute an operation on the repository after getting it would be better.

I'm not sure if with this solution provided is enought or you're waiting something more.....

/**
 * Test get repository created from a template repository
 *
 * @throws Exception
 *             the exception
 */
@Test
public void testGetRepositoryWithTemplateRepositoryInfo() throws Exception {
    GHRepository testRepo = gitHub.getRepositoryById(repo.getId());
    assertThat(testRepo.getTemplateRepository(), notNullValue());
    assertThat(testRepo.getTemplateRepository().getOwnerName(), equalTo("octocat"));
    assertThat(testRepo.getTemplateRepository().isTemplate(), equalTo(true));
}