Testing applications with GitLab

GitLab is a web-based Git repository management site and system. GitLab also lets developers run a continuous process for writing, testing, and deploying code.

In this tutorial, you will set up GitLab on a virtual machine, create a single project in the C++ programming language, configure a project test script, and test its execution.

To create and test a project in the GitLab environment:

1. Before you start.

2. Required paid resources.

3. Create a VM with GitLab.

4. Configure GitLab.

5. Set privacy settings.

6. Create a project.

7. Set up and run testing for the project.

8. Configure and register a Runner.

9. Create a test script.

10. Create an error in the project.

11. How to delete created resources.

Prepare your cloudPrepare your cloud

Sign up for Yandex Cloud and create a billing account:

1. Go to the management console and log in to Yandex Cloud or create an account if you do not have one yet.
2. On the Yandex Cloud Billing page, make sure you have a billing account linked and it has the ACTIVE or TRIAL_ACTIVE status. If you do not have a billing account, create one.

If you have an active billing account, you can go to the cloud page to create or select a folder for your infrastructure to operate in.

Learn more about clouds and folders.

Required paid resourcesRequired paid resources

The cost for maintaining a GitLab server includes:

• A fee for a disk and a continuously running VM (see Yandex Compute Cloud pricing).
• A fee for using a dynamic or a static public IP (see Yandex Virtual Private Cloud pricing).

Create a virtual machine with GitLabCreate a virtual machine with GitLab

1. On the management console folder page, click Create resource and select Virtual machine.
2. In the Name field, enter the VM name as gitlab.
3. Select an availability zone to place the VM in.
4. Under Image/boot disk selection, click the Cloud Marketplace tab and select GitLab as your public image.
5. Under Disks, select a 20 GB SSD.
6. Under Computing resources:

   • Choose a VM platform.

   • Specify the necessary number of vCPUs and amount of RAM.

     For GitLab to run properly, specify the following configuration:

     • Platform: Intel Ice Lake.
     • Guaranteed vCPU share: 100%.
     • vCPU: 4.
     • RAM: 8 GB.
7. Under Network settings:
   • Select the Network and Subnet to connect the VM to. If the required network or subnet is not listed, create it.
   • Under Public address, keep Auto to assign your VM a random external IP address from the Yandex Cloud pool, or select a static address from the list if you reserved one in advance.
8. Under Access, specify the information required to access the VM:
   • In the Login field, enter your preferred login for the user to create on the VM.
   • In the SSH key field, paste your public SSH key. You need to create a key pair for the SSH connection yourself. See the section about how to connect to VMs via SSH.
9. Click Create VM.
10. Wait about five minutes for the VM to be created and for all its services to start. After all of the services fully launch, GitLab will become available through its web interface in the browser.

Configure GitLabConfigure GitLab

1. On the Compute Cloud page, select the created gitlab VM and copy its public IP.

2. Connect to the VM via SSH.

3. Get the GitLab administrator password using the VM command:

   sudo cat /etc/gitlab/initial_root_password
   

4. Copy the password (without spaces) from the Password row to the clipboard or a separate file.

5. In the browser, open a link in the format http://<public VM IP address>. The GitLab web interface will open.

6. Log in using the administrator account:

   • Username or email: root.
   • Password: The previously copied password.

   If you are unable to log in, reset the administrator account password.

7. Change the administrator account password.

8. Log in to the system again using the administrator account and the new password.

Set privacy settingsSet privacy settings

Disable sign-up for other users on the login page:

1. Click Configure GitLab.
2. In the left panel, go to Settings and select General.
3. Under Sign-up restrictions, click Expand.
4. Disable Sign-up enabled.
5. Click Save changes.

Now, only the administrator can register a new user from the Users tab in Overview.

Create a projectCreate a project

To create a project:

1. On the GitLab home page, select Create a project.

2. On the page that opens, specify:

   • Project name: My Project.
   • Project group and ID: root and my-project.
   • If necessary, give a description and the scope of the project.

3. Click Create project.

   

4. Once you create the project, in the left panel, go to Settings and select CI/CD.

5. Under Auto DevOps, click Expand, disable the option Default to Auto DevOps pipeline, and save changes by clicking Save changes.

   

6. Add a project file.

   1. In the left panel, go to Project and select Details.

   2. On the project page, click New file.

   3. Name the file test.cpp. Add the code of a program that checks the product of multiplying 2 x 2 and outputs Hello World if it's 4:

      #include <iostream>
      #include <cassert>
      
      int main() {
        assert(2 * 2 == 4);
        std::cout << "Hello world!" << std::endl;
        return 0;
      }
      

      

   4. Enter a commit name in the Commit message field.

   5. Click Commit changes.

Set up and run testing for the projectSet up and run testing for the project

A Runner is a program that tests and builds projects in the GitLab environment by following provided instructions.

Configure and register a RunnerConfigure and register a Runner

1. Use SSH to connect to the VM and change to administrator mode in the console:

   sudo -i
   

2. Download the Runner:

   curl -L --output /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-amd64
   

3. Make the Runner executable:

   chmod +x /usr/local/bin/gitlab-runner
   

4. Create a separate user to start the Runner:

   useradd --comment 'GitLab Runner' --create-home gitlab-runner --shell /bin/bash
   

5. Install and start the Runner:

   gitlab-runner install --user=gitlab-runner --working-directory=/home/gitlab-runner
   gitlab-runner start
   

6. Register your runner in GitLab:

   1. Launch interactive registration with the gitlab-runner register command.

   2. Enter your GitLab server address. When you see the prompt:

      Please enter the gitlab-ci coordinator URL (e.g. https://gitlab.com)
      

      enter http://<public-IP-address-of-your-VM>.

   3. Enter the registration token for the Runner. To retrieve it, go to the project page in GitLab, select Settings on the left-hand panel, and click the CI/CD tab. Then click Expand under Runners. Under Set up a specific Runner manually, copy the token from step 3 and enter it in the request response:

      Please enter the gitlab-ci token for this runner
      <token>
      

      

   4. When you see the prompt:

      Please enter the gitlab-ci description for this runner
      

      enter a description for the Runner: My runner.

   5. Don't specify anything in the tag field, just press Enter. Otherwise, by default, the Runner won't run without specifying the appropriate tags for the project.

   6. Specify the runtime environment. In our case, when prompted:

      Please enter the executor: ssh, docker+machine, docker-ssh+machine, kubernetes, docker, parallels, virtualbox, docker-ssh, shell:
      

      enter: shell.

Runner installation and setup is complete. If everything is done correctly, the Runners activated for this project section with the registered Runner should appear on the page where you copied the registration token.

Create a test scriptCreate a test script

Create a test script to execute the Runner. The script is described in a special file named .gitlab-ci.yml. It should be located in the project root directory. According to the script, the Runner will compile the project source file, convert it to an executable file, and then run it.

Since testing is performed on the VM operating system, you need to install the apps required for testing: git to clone a project from the repository and g++ to compile the project.

To create a test script:

1. Connect to the VM via SSH and install the necessary apps:

   sudo apt update
   sudo apt install -y git g++
   

2. Add a test script:

   1. In the GitLab web interface, go to the left-hand panel, click Project, and select the Details tab.

   2. On the page that opens, click Set up CI&CD.

   3. A page opens asking you to add a new file named .gitlab-ci.yml, in which you should describe the script in YAML format. Add the script text:

      stages:
        - build
        - test
        - pack
      
      cache:
        paths:
          - hello
      
      build:
        stage: build
        script: g++ test.cpp -o hello
      
      test:
        stage: test
        script: ./hello
      
      pack:
        stage: pack
        script: gzip -c hello > hello.gz
        artifacts:
          paths:
            - hello.gz
      

      The script indicates that the process is divided into three stages that are performed sequentially:

      • build: At the first stage, the project is compiled and converted to an executable file named hello.
      • test: At the second stage, the executable file is run.
      • pack: In the third step, an archive with the executable is created, which you can download via the GitLab web interface after the script completes successfully. In the artifacts block, there's a list of files available for download.

      The cache block shows which files and directories are transferred between stages. If you omit it, the hello file won't be available at the test stage and an error will occur.

      

   4. Click Commit changes

After committing, the system automatically starts testing the last commit. You can view the testing process and results in the CI/CD section in the left panel. The resulting line should contain the first test and passed status. By clicking the cloud icon, you can download the build artifacts.

Create an error in the projectCreate an error in the project

Now, make the project run with an error that the Runner should help you find during testing. To do this:

1. Go to the project repository and open the test.cpp file.

2. Click Edit.

3. In the check, assert that the product of multiplying 2 x 2 should be 5. In this case, an error occurs when the program is run and it fails.

   ...
   assert(2 * 2 == 5);
   ...
   

4. Name the commit Wrong assert in test.cpp.

5. Click Commit Changes.

Open the CI/CD section. In the Stages column, you can see that, as a result of the test, the first stage, build, completed successfully and the second stage, test, ended with an error. The third stage, pack, was skipped and the final artifacts weren't generated.

If you click the failed progress status and go to Failed Jobs, you can see the error text saying that assertion failed:

How to delete created resourcesHow to delete created resources

To stop paying for your deployed server, just delete the created gitlab VM.

If you reserved a static public IP address specifically for this VM:

1. Select Virtual Private Cloud in your folder.
2. Go to the IP addresses tab.
3. Find the required address, click , and select Delete.