Project Branches API

[lamdav]

The Gitlab docs list other methods of gathering information or updating protected branches.

https://docs.gitlab.com/ce/api/protected_branches.html#list-protected-branches

[gmessner]

@lamdav
Great contribution. Though I'd like to get your input/consideration on two aspects:

1. GitLab4J tries mimic/mirror the GitLab API docs as close as possible, should this be its own sub-API called ProtectedBranchesApi ?
2. I think that the approach of using the Branch class for this might not be the best approach. Users of GitLab4J often ask why fields are often null, and when fetching info on protected branches most of the Branch class fields will be null, and when fetching Branch info the protected branch fields will be null. Suggest creating ProtectedBranch just for this use.

[lamdav]

@gmessner

1. If the intent is to mimic/mirror it, I think it will be a good idea to create a sub-api called ProtectedBranchesApi. It will also avoid the naming collision with unprotectBranch.
2. I agree. I will create a separate ProtectedBranch model for this.

[lamdav]

https://stackoverflow.com/questions/5529532/how-to-get-a-test-resource-file

To keep the resource under the test directory of the project. If this is undesired, I can remove it.

[gmessner]

A few things here:

1. Not a fan of having it down in a src/test/resource directory, it leads to the potential of secrets being accidentally checked in. I would prefer it in the root of the project, and name it:

example-test-gitlab4j.properties

When moved to the root the code in TestUtils would need to look something like:

try (InputStream input = new FileInputStream("test-gitlab4j.properties")) {

2. Include test-gitlab4j.properties in the .gitignore file so it is not accidentally checked in.

3. There are about 10 additional properties that need to be set to fully test things, I'll get you those when I have some time tomorrow afternoon.

Last but not least. I am working on a GitLab server docker image that will be used to test GitLab4J, this way the test-gitlab4j.properties file can actually be created and left as is. I expect to have this finished and checked in within the next 2-3 weeks.

[lamdav]

Goes along with the above comment. Gives a new contributor an idea of how to setup for testing.

[gmessner]

Try to keep this list and the examples in alphabetical order.

[gmessner]

A few things here:

1. Not a fan of having it down in a src/test/resource directory, it leads to the potential of secrets being accidentally checked in. I would prefer it in the root of the project, and name it:

example-test-gitlab4j.properties

When moved to the root the code in TestUtils would need to look something like:

try (InputStream input = new FileInputStream("test-gitlab4j.properties")) {

2. Include test-gitlab4j.properties in the .gitignore file so it is not accidentally checked in.

3. There are about 10 additional properties that need to be set to fully test things, I'll get you those when I have some time tomorrow afternoon.

Last but not least. I am working on a GitLab server docker image that will be used to test GitLab4J, this way the test-gitlab4j.properties file can actually be created and left as is. I expect to have this finished and checked in within the next 2-3 weeks.

[gmessner]

@lamdav
You've done a lot of work on this and it is very close to being complete, what do you think about me just merging it now, I will then add some updates, create a PR and have you review. Sound like a plan?

[lamdav]

@gmessner Sounds good to me!

[gmessner]

@lamdav
I submitted the PR, you'll find it here:
Feature/protected branch and example test properties (#156)