Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/fufu70/php-jenkins-breakfast-box


https://github.com/fufu70/php-jenkins-breakfast-box

breakfast jenkins php vagrant

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README 

        
# PHP-Jenkins-Breakfast-Box



I'm sitting in my pajamas an hour before work starts. All I want is a Jenkins server for my PHP project to analyze the kerfluffle out of is fart box. Screw wasting time figuring out [Chef](https://github.com/pietervogelaar/chef-cookbook-jenkins-server) or [Anisble](https://github.com/HanXHX/ansible-jenkins-php). I just want to figure out what the [C.R.A.P.](http://www.crap4j.org/faq.html) is going on with my PHP: HP project. All I want is to input some commands, install my PHP: HP: HP jenkins box while eating some delicious PHPancakes.



![alt text][php-pancakes]



## Table Of Contents:



* [The Requirements](#the-requirements)

* [The Process](#the-process)

* [Troubleshooting](#troubleshooting)

* [The Tools](#the-tools)

* [General Information](#general-information)

* [Thanks to](#thanks-to)



## The Requirements



You thought that was a Download And Analyze (DAA) project, **but** you are mistaken! To run the PHP: HP: HP: HP-Jenkins-Breakfast-Box we need to install dependencies:



* [VirtualBox](https://www.virtualbox.org/wiki/Downloads)

  * Make sure to download the latest version, even if you already installed VirtualBox before.

  * As of writing this my version (AOWTMV) is 5.1.14

* [Vagrant](https://www.vagrantup.com/downloads.html)

  * AOWTMV is 1.8.6

* [A Computer](http://i.giphy.com/xTiTnJ3BooiDs8dL7W.gif)



## The Process



To run the breakfast box go to your terminal, clone the repository, and run **vagrant up**:



```shell

$ git clone https://github.com/fufu70/jenkins-php-box

$ vagrant up

```



After the PHP: HP: HP: HP: HP-Jenkins-Breakfast-Box "up"s it will gives instructions on what to do:



> You Installed the PHP-Jenkins-Breakfast-Box ... YAY! Run 'vagrant ssh', and 'sudo bash ~/install-jenkins/install.sh'



Dont tell me what to do Vagrant! Im a [well adgusted programmer](http://i.giphy.com/VD9NtdBN9CwqQ.gif)! I know, i'll:



```shell

$ vagrant ssh

$ sudo bash ~/install-jenkins/install.sh

```



Yea! [I don't need no program telling me what to do ...](http://i.giphy.com/3o6ZtmMXFewRk4WKFG.gif)



> Ok! Go to your browser at [http://192.168.205.20:8080](http://192.168.205.20:8080) to setup your PHP-Jenkins-Breakfast-Box



What's this! More [instructions!](http://i.giphy.com/X7jENDat6V5Je.gif)



After you make your own goddam decisions [you adult](http://i.giphy.com/l0Iyf9vXAJFO7qVZS.gif) you'll see a screen that requests you Unlock Jenkins

![alt text][unlock-jenkins]



Run:



```shell

$ sudo cat /var/lib/jenkins/secrets/initialAdminPassword

```



Copy and paste the password shown after the command is run.



You then come up to a screen that requests you to Customize Jenkins, choose the highlighted "Install suggested plugins" option

![alt text][customize-jenkins]



Afterwards it will install a list of generalized selection of plugins

![alt text][plugins-installing-jenkins]



Once the plugins are installed create the [first](http://i.giphy.com/FYy1pE8KHCmc0.gif) admin user. Don't forget the username and password, we'll need it later.

![alt text][admin-user-jenkins]



JENKINS IS INSTALLED!~!~!~ 

![alt text][installed-jenkins]



Now we go back to our [handy dandy terminal](http://i.giphy.com/6edVpzX8cg41O.gif) to run more [commands](http://i.giphy.com/JIX9t2j0ZTN9S.gif)



U should still be in the [vagrant](http://www.fotothing.com/photos/a74/a74444e446de3816566011350e7eb4ca.jpg) machines shell, if not run:



```shell

$ vagrant ssh

```



OK! So all we gotta do is run 3 more commands and we should be done with shell. These commands go to install some more [php specific plugins](https://github.com/fufu70/jenkins-php-box/blob/master/install-jenkins/plugins.sh), local [php tools](https://github.com/fufu70/jenkins-php-box/blob/master/install-jenkins/php-tools.sh) that the plugins interface with, and [create a job](https://github.com/fufu70/jenkins-php-box/blob/master/install-jenkins/integration.sh) to connect with these plugins.



The first command will be php tools.



```shell

$ sudo bash ~/install-jenkins/php-tools.sh

```



Then install the plugins for the php tools. You will need a username and password for jenkins as it connects to the PHP-Jenkins-Breakfast-Box through a **jenkins-cli.jar**.



```shell

$ sudo bash ~/install-jenkins/plugins.sh

```



Once the plugins have been installed we want to actually create a [job!](http://i.giphy.com/RBDXLadJCxs6A.gif) Don't forget that username and password.



```shell

$ sudo bash ~/install-jenkins/integration.sh

```



When running this command you'll be given an option to input a personal repository. If **N** is selected then the repository URL can be changed from the config section of the jenkins job at [http://192.168.205.20:8080/job/php-breakfast-box-job/configure](http://192.168.205.20:8080/job/php-breakfast-box-job/configure). The second option below is the **Source Code Management** config, here you can set a repository url and credentials:



![alt text][integrate-repo-jenkins]



Your done now, you should be anyways, When you go back to your running jenkins instance you should see your job just hanging out, php-breakfast-box-job. 



Ok, your work alarm has [rung](http://i.giphy.com/Tohtjw8GoSmpa.gif)! Get back to your [Hacking](http://i.giphy.com/MGaacoiAlAti0.gif) you filthy developer!



## Troubleshooting



### Content Security Policy Issues



Okay my fellow [scrubs](http://i.giphy.com/YjJZKbm2kNN7i.gif)! You finally got your [first job to run](http://i.giphy.com/omRfGp0CeRShi.gif), you head over to your Clover Code Coverage html reports (CCCHR) at [http://192.168.205.20:8080/job/php-breakfast-box-job/cloverphp/](http://192.168.205.20:8080/job/php-breakfast-box-job/cloverphp/). [Whats this!](http://i.giphy.com/ToMjGpnXBTw7vnokxhu.gif)



![alt text][blocked-font-clover]



What are all these console errors!



![alt text][blocked-script-console-errors]



This is a direct issue with the [Content Security Policy](https://wiki.jenkins-ci.org/display/JENKINS/Configuring+Content+Security+Policy) issue. Were going to run a script inside of Jenkins internal console. Go to [http://192.168.205.20:8080/script](http://192.168.205.20:8080/script) and run:



```groovy

System.setProperty("hudson.model.DirectoryBrowserSupport.CSP", "")

```



Inside of the script console.



![alt text][script-console-execution]



After running the script go back to the CCCHR page at [http://192.168.205.20:8080/job/php-breakfast-box-job/cloverphp/](http://192.168.205.20:8080/job/php-breakfast-box-job/cloverphp/), hard refresh the page to clear your current [cache](http://i.giphy.com/VkYOrBIQv520M.gif), and view the splendor of no Content Security!



![alt text][unblocked-font-clover]



### Markup Formating in the Job Description



Cruising to your job you see a odd [bug](http://i.giphy.com/xTiTnGuHmcaQeWSryE.gif) out of the corner of your [eye!](http://i.giphy.com/e9R0ytwguezTO.gif) 



![alt text][html-formatting-issue]



[Thats not suppose to be like that but it is be like that ...](http://i.giphy.com/akTeqZhGsdHLq.gif)



The problems of global configuration policies! Simply go to [http://192.168.205.20:8080/configureSecurity/](http://192.168.205.20:8080/configureSecurity/) to set the Markup Formatter value to be **safe html**



![alt text][markup-formatter-jenkins]



After you click save you can now view those pretty little pdepend graphs.



![alt text](https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/html-formatting-solved.png "HTML formatting issue resolved.")



Keep on [analyzing](http://i.giphy.com/udhngZK2IFTc4.gif) that code!



## The Tools



The PHP Jenkins Breakfast Box comes with several different tools for code analysis, 7 to be exact. 



### [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)



Rummages through your code to let you know of code that does not follow your linting rules.



### [PHP Unit](https://phpunit.de/)



Do you like [CRAP?](https://phpunit.de/manual/current/en/code-coverage-analysis.html) Do you like [Code Coverage?](https://en.wikipedia.org/wiki/Code_coverage) Do you enjoy the [relaxing sounds](https://media.giphy.com/media/vSO1hQUdzBu0w/giphy.gif) of your test cases failing? Look no further, PHPUnit has it all. This little code analysis tool will point out method that have a cyclomatic complexity higher than 30 (higher than 100 is troublesome), show you your total code coverage for a class (the clover coverage section). and let you know how many test cases have passed or failed.



### [PHPLOC](https://github.com/sebastianbergmann/phploc)



Do you like generalized information??? Well? [Do you?](https://media.giphy.com/media/Yq9Q0G4Wi1Ne/giphy.gif) Well PHPLOC will do just that, let you know the total amount of  in your codebase,  meaning:



* Lines of Code (LOC)

* Comment Lines of Code (CLOC)

* Non-Comment Lines of Code (NCLOC)

* Logical Lines of Code (LLOC)

* Average Complexity per LLOC

* Average Complexity per Class

* Namespaces

* Interfaces

* Traits

* Classes

* Methods

* Functions

* Constants

* ...



Coupled with the phploc plugin in Jenkins you can see your codebase grow with each commit and connect it with growing or shrinking Cyclomatic Complexity.



### [PDepend](https://pdepend.org/documentation/software-metrics/index.html)



When you first look at it you ask yourself ... [WTF](https://media.giphy.com/media/zXtbIHJtizoac/giphy.gif) am i looking at! You have some [weird graph](https://pdepend.org/documentation/handbook/reports/abstraction-instability-chart.html) that has instability on the vertical side, and abstraction on the other in conjunction with a [pyramid](https://pdepend.org/documentation/handbook/reports/overview-pyramid.html) that tells you the Inheritance, Coupling, and Size / Complexity of your codebase.



### [PHPMD](https://phpmd.org/)



Operates similarly to the [PMD](https://pmd.github.io/) project for Java. To copy directly from PHPMD's website, it simply looks for:



> * Possible bugs

> * Suboptimal code

> * Overcomplicated expressions

> * Unused parameters, methods, properties



### [PHPCPD](https://github.com/sebastianbergmann/phpcpd)



The PHP Copy Paste Detector. Operates similarly to [PMD's CPD](https://pmd.github.io/pmd-5.5.4/usage/cpd-usage.html).



### [PHPDox](http://phpdox.de/)



PHPDox, written by [Arne Blankerts](https://thephp.cc/company/consultants/arne-blankerts), is used to create PHP documentation on the fly from currently documented code.



## General Information



A basic jenkins environment for PHP codebases strictly for ubuntu-14.04. Its not fully automatic but is an aid in starting up the project simply using shell scripts as a guide.



The default repository for the job is the [yii-deadbody-php](https://github.com/fufu70/deadbody-php) project. It is a good aid in testing the PHP-Jenkins-Breakfast-Box.



## TLDC (To Long Didn't Code)



To quickly setup an instance checkout the Vagrantfile for the result of the process: [PHP-Jenkins-Vagrant-File](https://github.com/fufu70/PHP-Jenkins-Vagrant-File)



## Thanks to:



Sebastian Bergmann for creating the [Template for Jenkins Jobs for PHP Projects](http://jenkins-php.org/index.html)



Papa Johns for making it all [happen](http://static5.businessinsider.com/image/568ac02cc08a806f008b69d7-2400/rtr2u9g0.jpg)



[php-pancakes]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/pancakes.jpg "PHP Pancakes"

[unlock-jenkins]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/unlock-jenkins.png "Unlock Jenkins"

[customize-jenkins]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/customize-jenkins.png "Customize Jenkins"

[plugins-installing-jenkins]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/plugins-installing-jenkins.png "Plugins Installing"

[admin-user-jenkins]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/admin-user-jenkins.png "Admin User Creation"

[installed-jenkins]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/installed-jenkins.png "Jenkins is installed"

[integrate-repo-jenkins]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/integrate-repo-jenkins.png "Integrate repository inside of Jenkins job"



[blocked-font-clover]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/blocked-font-clover.png "Blocked Font at Clover HTML page"

[blocked-script-console-errors]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/blocked-script-console-errors.png "Blocked Script Console Errors"

[script-console-execution]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/script-console-execution.png "Fix blocked script execution."

[unblocked-font-clover]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/unblocked-font-clover.png "Fixed blocked font."



[html-formatting-issue]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/html-formatting-issue.png "HTML formatting issue."

[markup-formatter-jenkins]: https://raw.githubusercontent.com/fufu70/jenkins-php-box/master/common/markup-formatter-jenkins.png "Setting up the Markup Formatter for html inside of job descriptions"