| ... | @@ -3,33 +3,21 @@ |
... | @@ -3,33 +3,21 @@ |
|
|
The guide will help you to check your code's coding style and find issues with the code that generally compiler does not show.
|
|
The guide will help you to check your code's coding style and find issues with the code that generally compiler does not show.
|
|
|
|
|
|
|
|
|
|
|
|
|
1. Installing docker. Open up a new Terminal by pressing `Ctrl` + `Alt` + `t`
|
|
1. Download ready made docker-containers for the module - https://gitlab.iotiot.in/newbies/pre-office-office/docker-containers/-/archive/master/docker-containers-master.zip
|
|
|
```sh
|
|
2. Unzip the docker-containers-master.zip
|
|
|
sudo apt update
|
|
|
|
|
sudo apt install git
|
|
3. Open Up VScode.
|
|
|
git clone https://gitlab.iotiot.in/newbies/pre-office-office/docker-containers.git
|
|
4. Press `Ctrl` + `Shift` + `p` in VScode. A bar will open up at the top.
|
|
|
cd docker-containers
|
|
5. Search for `Remote-Containers`
|
|
|
sudo install-docker-ubuntu-16.04.sh
|
|
|
|
|
```
|
|
6. Click on "Remote-Containers: Open Folder in Containers".
|
|
|
- **Note:** The script will automatically install and **reboot** your system.
|
|
7. In the pop up Window, Navigate to Downloads --> docker-containers-master --> code-style-container.
|
|
|
- **Note:** These steps only work on Ubuntu 16.04 OS. Any other OS will cause an error.
|
|
|
|
|
|
|
8. Vscode will take some time to start up the container, once done the window will look like this below
|
|
|
- After the system reboots, Open up a new Terminal by pressing `Ctrl` + `Alt` + `t`.
|
|
|
|
|
- Run command `sudo docker --version` to verify that docker is successfully installed.
|
|
9. To open up terminal you can Press `Ctrl` + `j`.
|
|
|
```sh
|
|
|
|
|
# The output should be a docker version
|
|
10. Clone the project repository
|
|
|
$ sudo docker --version
|
|
|
|
|
Docker version 19.03.13, build 4484c46d9d
|
|
|
|
|
```
|
|
|
|
|
2. Start docker container by running command, in the same terminal
|
|
|
|
|
```sh
|
|
|
|
|
cd docker-containers/coding-style-container
|
|
|
|
|
sudo ./start
|
|
|
|
|
```
|
|
|
|
|
3. You will get a new Terminal prompt,
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4. Clone the project repository
|
|
|
|
|
```sh
|
|
```sh
|
|
|
git clone {your-project-repo}
|
|
git clone {your-project-repo}
|
|
|
cd {your-project-name}
|
|
cd {your-project-name}
|
| ... | @@ -40,12 +28,12 @@ The guide will help you to check your code's coding style and find issues with t |
... | @@ -40,12 +28,12 @@ The guide will help you to check your code's coding style and find issues with t |
|
|
cd devops-trial
|
|
cd devops-trial
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
5. Check for vulnerabilities using **flawfinder**, run command
|
|
11. Check for vulnerabilities using **flawfinder**, run command
|
|
|
```sh
|
|
```sh
|
|
|
flawfinder {folder-which-contains-your-code}
|
|
flawfinder {folder-which-contains-your-code}
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
6. Check for MISRA C/CPP violations, run commands
|
|
12. Check for MISRA C/CPP violations, run commands
|
|
|
```sh
|
|
```sh
|
|
|
cppcheck cppcheck --dump --quiet {folder-which-contains-your-code}/*
|
|
cppcheck cppcheck --dump --quiet {folder-which-contains-your-code}/*
|
|
|
python3 /usr/share/cppcheck/addons/misra.py {folder-which-contains-your-code}/*.dump
|
|
python3 /usr/share/cppcheck/addons/misra.py {folder-which-contains-your-code}/*.dump
|
| ... | | ... | |
