Field Detail

• private java.lang.String gitlabContext

• private java.lang.String gitlabEndpoint

• private int gitlabPort

• private GitlabSCMProtocol gitlabSCMProtocol

• private java.lang.String internalEndpoint

• private java.lang.String scmContext

• private final java.lang.String scmHost

• private final int scmPort

• private final GitlabSCMProtocol scmProtocol

Constructor Detail

• GitlabSCMProvider(int scmPort, GitlabSCMProtocol scmProtocol, java.lang.String scmHost, java.lang.String scmContext = "", GitlabSCMProtocol gitlabSCMProtocol, java.lang.String gitlabEndpoint, int gitlabPort, java.lang.String gitlabContext = "")

  Constructor for class GitlabSCMProvider.

  throws:

  IllegalArgumentException if a required field is null or empty

  Parameters:

  scmPort - the scm port used when interacting with the scm provider to, for example clone e.g - HTTP, HTTPS or SSH

  scmProtocol - the clone protocol used when interacting with the scm provider to, for example clone e.g - HTTP, HTTPS or SSH

  scmHost - the clone url or host (for internal communication) when interacting with the scm provider e.g 10.0.0.1

  scmContext - GitLab url context when interacting with the scm provider e.g /gitlab in http:///gitlab/

  gitlabSCMProtocol - the cloning protocol used when performing cartridge loading operations - HTTP, HTTPS or SSH

  gitlabEndpoint - the url used when performing cartridge loading operations e.g. 10.0.0.1

  gitlabPort - the port used when performing cartridge loading operations e.g. 80

  gitlabContext - the url context used when performing cartridge loading operations e.g /gitlab in http:///gitlab/

Method Detail

• private void copyDataFromRepositoryInUrlsTxt(java.lang.String workspace, java.lang.String repoName, java.lang.String namespace, java.lang.String repoFromUrlsTxt)

  Clone a repository from GitLab and populate it by pulling the data from the corresponding repository in urls.txt FIXME clone using SSH or in a way in which the access token is not stored in .git/config - fine for now as this is for evaluation purposes

  Parameters:

  workspace - the current workspace

  repoName - the repository name

  namespace - the GitLab group namespace

  repoFromUrlsTxt - the clone url of the repository from urls.txt

  Returns:

  nothing

• @java.lang.Override void createScmRepos(java.lang.String workspace, java.lang.String repoNamespace, java.lang.String codeReviewEnabled, java.lang.String overwriteRepos)

  Gets a list of repositories from urls.txt, validates them and then calls forkRepositoriesFromUrls to fork each repository in GitLab If urls is empty, non readable or does not exist then exit without doing anything

  Parameters:

  workspace - the current workspace

  repoNamespace - the current namespace (called group namespace in GitLab)

  codeReviewEnabled - not used in GitLab

  overwriteRepos - value of the overwriteRepos repos checkbox in jenkins. Can be "true" or "false"

  Returns:

  nothing

• private void deleteAndRecreateRepository(java.lang.String repoName, java.util.List existingProjectsInGroup, int groupNamespaceId)

  Deletes a GitLab repository and recreates it

  Parameters:

  repoName - the repository name

  existingProjectsInGroup - list of existing repositories in that group - used to get the ID of the repository to be deleted

  groupNamespaceId - The id of the group which is used when recreating the repository in that group

  Returns:

  nothing

• private java.lang.String extractRepoNameFromUrl(java.lang.String url)

  Extracts the repository name from an HTTP git repository url e.g for https://github.com/Accenture/adop-cartridge-java-environment-template.git return adop-cartridge-java-environment-template Gerrit repository names will not be extracted from Gerrit urls unless a substring /gerrit/, http(s)/gerrit or .gerrit. exists

  Parameters:

  git - clone repository url

  Returns:

  repository name

• private void forkRepositoriesFromUrls(java.util.List<java.lang.String> repos, java.lang.String workspace, java.lang.String overwriteRepos, java.lang.String namespace)

  Given a list of public repositories from urls.txt, this method forks each of them into a GitLab group (common GitLab repository namespace e.g /namespace/repo1, /namespace/repo2) If the group does not already exist then it will be created. If the group already exists and a repository with the same name as one of the repos in urls.txt also exists then only overwrite the repo it if overwriteRepos is set to true

  throws:

  Exception if in search for a group more than one is found or if a group which was looked for and found cannot be found later

  Parameters:

  repos - a list of public repositories to fork from urls.txt

  workspace - the current workspace

  overwriteRepos - value of the overwrite repos checkbox in jenkins.

  namespace - the Group namespace e.g myrepos for myrepos/reponame

  Returns:

  nothing

• @java.lang.Override groovy.lang.Closure get(java.lang.String projectName, java.lang.String repoName, java.lang.String branchName, java.lang.String credentialId, groovy.lang.Closure extras)

  Return SCM section closuer for Jenkins DSL

  Parameters:

  projectName - name of the project.

  repoName - name of the repository to clone.

  branchName - name of branch.

  credentialId - name of the credential in the Jenkins credential manager to use.

  extras - extra closures to add to the SCM section.

  Returns:

  a closure representation of the SCM providers SCM section.

• @java.lang.Override groovy.lang.Closure getMultibranch(java.lang.String projectName, java.lang.String repoName, java.lang.String credentialId, groovy.lang.Closure extras)

  Return a closure representation of the SCM section for multibranch pipelines (Jenkins DSL).

  Parameters:

  projectName - name of the project.

  repoName - name of the repository to checkout.

  credentialId - name of the credential in the Jenkins credential manager to use.

  extras - extra closures to add to the multibranch SCM section.

  Returns:

  a closure representation of the SCM providers multibranch SCM section.

• private int getRepoId(java.util.List listOfExistingRepos, java.lang.String targetRepoName)

  Given a list of repository objects parsed from JSON it looks for a repository with a particular name and if it finds it, it extracts its id

  throws:

  IllegalArgumentException if the target repository is not in the list

  throws:

  Exception if the target repository is found but an id cannot be extracted

  Parameters:

  List - of Repository objects

  the - repository name to be searched for in the list

  Returns:

  id of the target repository

• java.lang.String getScmUrl()

  Method which returns GitLab repository clone urls for http/https/ssh

  throws:

  IllegalArgumentException if the SCM protocol type is not supported.

  Returns:

  SCM url for the provider. e.g. Gitlab-SSH ssh://git@10.0.0.0:22/myproject/ Gitlab-HTTP-with-context http://10.0.0.0:80/gitlab/myproject/ Gitlab-HTTP-without-context http://10.0.0.0:80/myproject/ Gitlab-HTTPS-with-context https://10.0.0.0:443/gitlab/myproject/ Gitlab-HTTPS-without-context https://10.0.0.0:443/myproject/

• boolean isGerritUrl(java.lang.String url)

  Checks whether or not a clone repository url is for Gerrit. It only captures the simplest cases where the string does not contain .git and one or of the substrings /gerrit/, http(s)/gerrit .gerrit. are present

  Parameters:

  url - the repository url to be checked

  Returns:

  true if a substring /gerrit/, http(s)/gerrit or .gerrit. exists and false otherwise

• private void processRepositories(java.util.List repos, java.util.List existingProjectsInGroup, int groupNamespaceId, java.lang.String workspace, java.lang.String namespace, java.lang.String overwriteRepos)

  Given a list of repositories from urls.txt and a list of repositories which exist under a group, this method forks each repository in urls.txt to GitLab if it does not exist. If it does exist, it overwrites it if overwriteRepos in Jenkins was set to true

  Parameters:

  repos - A list of public repositories to fork

  existingProjectsInGroup - A list of all the repositories that already exist in a given GitLab namespace

  groupNamespaceId - The id of the group which is needed for API requests on that group

  workspace - The current workspace

  namespace - The GitLab group namespace

  overwriteRepos - true if the box overwriteRepos in Jenkins was ticked, false otherwise

  Returns:

  nothing

• private boolean repositoryAlreadyExistsInGroup(java.util.List listOfRepos, java.lang.String targetRepoName)

  Given a list of repository names and a target repository name, it checks that the list contains the target repository name

  Parameters:

  List - of Repositories

  the - repository name to be searched for in the list

  Returns:

  true if the repository exists, false otherwise

• @java.lang.Override groovy.lang.Closure trigger(java.lang.String projectName, java.lang.String repoName, java.lang.String branchName)

  Returns a closure representation of the SCM provider's trigger SCM section for Jenkins DSL. This particular SCM provider only requires a branch name as manual configuration is needed on the repository's side to integrate it with the desired Jenkins job via a webhook

  Parameters:

  projectName - project name.

  repoName - repository name.

  branchName - branch name to trigger.

  Returns:

  a closure representation of the SCM providers trigger SCM section.

• private boolean urlsTxtPermissionsAndPropertiesAreOk(java.io.File urlsFile, java.lang.String urlsFilePath)

  Checks that urls.txt exists, is readable and non empty

  Parameters:

  urlsFile - the file as an object

  urlsFilePath - the path to the file

  Returns:

  true if urls.txt exists, is readable and non empty, false otherwise

• private void validate()

  Validates that all the fields required to create an object out of this class are not null or empty

  throws:

  IllegalArgumentException if a field is null or empty

  Returns:

  nothing

• private void validateRepo(java.lang.String repo)

  Validates a repository clone URL by checking the protocol against the GitLabSCM protocol enum (SSH is not allowed at the moment)

  throws:

  IllegalArgumentException if a a repository is invalid

  Parameters:

  Repository - name

• private void validateRepos(java.util.List<java.lang.String> repos)

  Given a list of repositories, this method validates each of them by calling the validate method

  throws:

  IllegalArgumentException if the repositories list is empty

  Parameters:

  A - list of repositories to validate

  Returns:

  Nothing

• private java.lang.String validateResponseToGetGroupRequest(java.util.List response, java.lang.String namespace)

  Validates the response of an HTTP request to search for a group. Makes sure that only one group was returned

  throws:

  Exception if more than one group or no groups were found

  Parameters:

  response - a list of JSON objects after parsing the response to the REST request

  namespace - The group namespace (common namespace for a collection of repositories e.g /namespace/repo1, /namespace/repo2