Final Demo Video (2-3 minute):

• Demo Video

Milestone 3 Report :

Steps:

• Create a .vault-pass file inside the root folder of DEVOPS-21 repository.
  • Content of this file -> csc-devops-2020
• Commands to execute:
  • npm install
  • npm link
  • pipeline setup --gh-user <username> --gh-pass <password>
  • pipeline prod up --api-token <digital-ocean-api token>
  • pipeline deploy checkbox.io -i inventory.ini
    • If manually providing inventory.ini file, then put it inside cm/ folder.
  • pipeline build iTrust -u <admin> -p <admin>
  • pipeline deploy iTrust -i inventory.ini
    • If manually providing inventory.ini file, then put it inside cm/ folder.
  • pipeline canary master broken

NOTE:

• We have used ssh keys in order to provision droplet in digital ocean. So for that follow below steps before running pipeline prod up`:
  

  • create ssh (private-public key pair) using keygen.
    
  • Add private key to /cm/roles/set_env/templates/private_key file.
    
  • Add public key to digital ocean and copy the fingerprint of that key.
    
  • set environment variable FINGERPRINT= <string copied above>

• Tomcat is running on port 9090 (instead of default 8080 port). And so the url after deploy will be IP:9090/iTrust2`.

• Provide digital ocean api-token when running prod up command.

Issues and experiences:

• Configuring Tomcat:

  • One of the task was to deploy application in tomcat server
    • The issue we faced here is configuring tomcat to run on port where no other app/service is running.
    • Initially, we used default 8080 port but it is already used by other service and so changing that and configuring using ansible is a little bit difficult.

• Canary Analysis:

  • For this task we provisoned 3 vm (blue, green and proxy). Blue and green will be used for deployment. While proxy will handle traffic ,monitoring and load.
  • The difficulty we faced in implementing this structure is to setup redis client to send (simulate) traffic to particular server.

Screencast

• Milestone-3

Milestone 2 Report :

Steps:

• Create a .vault-pass file inside the root folder of DEVOPS-21 repository.
  • Content of this file -> csc-devops-2020
• Commands to execute:
  • npm install
  • npm link
  • pipeline setup --gh-user <username> --gh-pass <password>
  • pipeline build iTrust -u <admin> -p <admin>
  • pipeline useful-tests -c 1000 --gh-user <username> --gh-pass <password>
  • Pipeline build checkbox.io -u <admin> -p <admin>

NOTE:
- Java and MySql takes more than usual time to install in VM

• Files containing the full output of the useful-tests command with 1000 (700 + 300) iterations can be found here.
  • Because of the amount of time it takes to execute 1000 iterations, we divided this task on 2 machines and uploaded the mutation results here.

Issues and experiences:

• Mutation Testing:

  • The main issue we faced here is about verification.
    • How to verify if code gets mutated?
  • Parse the console output in order to get information about failed tests.
  • Long wait time before getting the output of mutation coverage and verifying final results.

• Adding Github credentials using Jenkins credential manager:

  • For our NCSU (Enterprise) Github account, the password contains special characters like "@" and it causes an issue to parse the link to clone the iTrust repository.
    • So finally we decided to use a Github personal token for authentication.
  • Moreover, configuring the credential.xml file took time to finally set proper credentials inside it.

Screencast

• Milestone-2

Milestone 1 Report :

Steps:

• Create a .vault-pass file inside the root folder of DEVOPS-21 repository.
  • Content of this file -> csc-devops-2020
• Commands to execute:
  • npm install
  • npm link
  • pipeline setup
  • Pipeline build checkbox.io

NOTE:
- Installing plugins will take 2-3 retries as it will wait for jenkins to be up.
- After jenkins gets restart, it will wait (5-6 retries) until jenkins web-interface is ready.

Issues and experiences:

• Environment variables

  • We created environment variables in /etc/environment file. But when we triggered the build job, it showed “listening on port undefined” instead of 3002. Jenkins was not able to use the environment variable (/etc/environment) so we added an “admin” user of jenkins as sudoers which will give jenkins the permission to read environment variables.

• Workflow-aggregator (prior used pipeline-plugin but was not working)

  • Initially we used build-pipeline-plugin with freestyle projects which was difficult to convert into a pipeline style project. Hence, we settled on using workflow-aggregator with DSL to make a pipeline. To generate the script for building the pipeline, we tried different combinations of commands.

• Wscleanup:

  • In Jenkins everytime we trigger build, it creates a workspace inside /var/lib/jenkins and does all steps like cloning a repo, etc inside that workspace. Due to this, if we trigger build again, it gives an error “the checkbox.io repository already exists” during the git clone step and so to resolve it we need to clean/remove workspace at the end of pipeline execution so that the next time we trigger build it will run in the new workspace. For this we used ws-cleanup plugin and used it in post stage.

• Build status using jenkins-log-stream

  • Using the log() function of jenkins-npm package does not provide us console-output and so to get full console view we used jenkins-log-stream which polls jenkins server every 1000 ms and shows full console-view.

• Crumb unauthorized

  • During triggering build, it gives 403 forbidden errors. So for this we need to use crumb which will get valid for the current web session and so we can avoid forbidden error in that way.

Screencast

• Milestone-1

Opunit checks

Some of the opunit checks performed by the TA are failing but we ran these checks in 3 different machines and they seem to be passing: