Update metadata and build information files
This commit is contained in:
parent
fdd0da8d93
commit
30f18106cb
@ -12,8 +12,8 @@ php:
|
|||||||
|
|
||||||
script:
|
script:
|
||||||
- mkdir -p build/logs
|
- mkdir -p build/logs
|
||||||
- phpunit --coverage-clover=coverage.clover
|
- phpunit -c build
|
||||||
|
|
||||||
after_script:
|
after_script:
|
||||||
- wget https://scrutinizer-ci.com/ocular.phar
|
- wget https://scrutinizer-ci.com/ocular.phar
|
||||||
- php ocular.phar code-coverage:upload --format=php-clover coverage.clover
|
- php ocular.phar code-coverage:upload --format=php-clover build/logs/coverage.clover
|
||||||
244
build.xml
Normal file
244
build.xml
Normal file
@ -0,0 +1,244 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<project name="animeclient" default="full-build">
|
||||||
|
<!-- By default, we assume all tools to be on the $PATH -->
|
||||||
|
<property name="pdepend" value="pdepend"/>
|
||||||
|
<property name="phpcpd" value="phpcpd"/>
|
||||||
|
<property name="phpcs" value="phpcs"/>
|
||||||
|
<property name="phpdox" value="phpdox"/>
|
||||||
|
<property name="phploc" value="phploc"/>
|
||||||
|
<property name="phpmd" value="phpmd"/>
|
||||||
|
<property name="phpunit" value="phpunit"/>
|
||||||
|
|
||||||
|
<!-- Use this when the tools are located as PHARs in ${basedir}/build/tools
|
||||||
|
<property name="pdepend" value="${basedir}/build/tools/pdepend.phar"/>
|
||||||
|
<property name="phpcpd" value="${basedir}/build/tools/phpcpd.phar"/>
|
||||||
|
<property name="phpcs" value="${basedir}/build/tools/phpcs.phar"/>
|
||||||
|
<property name="phpdox" value="${basedir}/build/tools/phpdox.phar"/>
|
||||||
|
<property name="phploc" value="${basedir}/build/tools/phploc.phar"/>
|
||||||
|
<property name="phpmd" value="${basedir}/build/tools/phpmd.phar"/>
|
||||||
|
<property name="phpunit" value="${basedir}/build/tools/phpunit.phar"/> -->
|
||||||
|
|
||||||
|
<!-- Use this when the tools are managed by Composer in ${basedir}/vendor/bin
|
||||||
|
<property name="pdepend" value="${basedir}/vendor/bin/pdepend"/>
|
||||||
|
<property name="phpcpd" value="${basedir}/vendor/bin/phpcpd"/>
|
||||||
|
<property name="phpcs" value="${basedir}/vendor/bin/phpcs"/>
|
||||||
|
<property name="phpdox" value="${basedir}/vendor/bin/phpdox"/>
|
||||||
|
<property name="phploc" value="${basedir}/vendor/bin/phploc"/>
|
||||||
|
<property name="phpmd" value="${basedir}/vendor/bin/phpmd"/>
|
||||||
|
<property name="phpunit" value="${basedir}/vendor/bin/phpunit"/> -->
|
||||||
|
|
||||||
|
<target name="full-build"
|
||||||
|
depends="prepare,static-analysis,phpunit,phpdox,-check-failure"
|
||||||
|
description="Performs static analysis, runs the tests, and generates project documentation"/>
|
||||||
|
|
||||||
|
<target name="full-build-parallel"
|
||||||
|
depends="prepare,static-analysis-parallel,phpunit,phpdox,-check-failure"
|
||||||
|
description="Performs static analysis (executing the tools in parallel), runs the tests, and generates project documentation"/>
|
||||||
|
|
||||||
|
<target name="quick-build"
|
||||||
|
depends="prepare,lint,phpunit-no-coverage"
|
||||||
|
description="Performs a lint check and runs the tests (without generating code coverage reports)"/>
|
||||||
|
|
||||||
|
<target name="static-analysis"
|
||||||
|
depends="lint,phploc-ci,pdepend,phpcs-ci,phpcpd-ci"
|
||||||
|
description="Performs static analysis" />
|
||||||
|
|
||||||
|
<!-- Adjust the threadCount attribute's value to the number of CPUs -->
|
||||||
|
<target name="static-analysis-parallel"
|
||||||
|
description="Performs static analysis (executing the tools in parallel)">
|
||||||
|
<parallel threadCount="2">
|
||||||
|
<sequential>
|
||||||
|
<antcall target="pdepend"/>
|
||||||
|
</sequential>
|
||||||
|
<antcall target="lint"/>
|
||||||
|
<antcall target="phpcpd-ci"/>
|
||||||
|
<antcall target="phpcs-ci"/>
|
||||||
|
<antcall target="phploc-ci"/>
|
||||||
|
</parallel>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="clean"
|
||||||
|
unless="clean.done"
|
||||||
|
description="Cleanup build artifacts">
|
||||||
|
<delete dir="${basedir}/build/api"/>
|
||||||
|
<delete dir="${basedir}/build/coverage"/>
|
||||||
|
<delete dir="${basedir}/build/logs"/>
|
||||||
|
<delete dir="${basedir}/build/pdepend"/>
|
||||||
|
<delete dir="${basedir}/build/phpdox"/>
|
||||||
|
<property name="clean.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="prepare"
|
||||||
|
unless="prepare.done"
|
||||||
|
depends="clean"
|
||||||
|
description="Prepare for build">
|
||||||
|
<mkdir dir="${basedir}/build/api"/>
|
||||||
|
<mkdir dir="${basedir}/build/coverage"/>
|
||||||
|
<mkdir dir="${basedir}/build/logs"/>
|
||||||
|
<mkdir dir="${basedir}/build/pdepend"/>
|
||||||
|
<mkdir dir="${basedir}/build/phpdox"/>
|
||||||
|
<property name="prepare.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="lint"
|
||||||
|
unless="lint.done"
|
||||||
|
description="Perform syntax check of sourcecode files">
|
||||||
|
<apply executable="php" taskname="lint">
|
||||||
|
<arg value="-l" />
|
||||||
|
|
||||||
|
<fileset dir="${basedir}/src">
|
||||||
|
<include name="**/*.php" />
|
||||||
|
<modified />
|
||||||
|
</fileset>
|
||||||
|
|
||||||
|
<fileset dir="${basedir}/tests">
|
||||||
|
<include name="**/*.php" />
|
||||||
|
<modified />
|
||||||
|
</fileset>
|
||||||
|
</apply>
|
||||||
|
|
||||||
|
<property name="lint.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="phploc"
|
||||||
|
unless="phploc.done"
|
||||||
|
description="Measure project size using PHPLOC and print human readable output. Intended for usage on the command line.">
|
||||||
|
<exec executable="${phploc}" taskname="phploc">
|
||||||
|
<arg value="--count-tests" />
|
||||||
|
<arg path="${basedir}/src" />
|
||||||
|
<arg path="${basedir}/tests" />
|
||||||
|
</exec>
|
||||||
|
|
||||||
|
<property name="phploc.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="phploc-ci"
|
||||||
|
unless="phploc.done"
|
||||||
|
depends="prepare"
|
||||||
|
description="Measure project size using PHPLOC and log result in CSV and XML format. Intended for usage within a continuous integration environment.">
|
||||||
|
<exec executable="${phploc}" taskname="phploc">
|
||||||
|
<arg value="--count-tests" />
|
||||||
|
<arg value="--log-csv" />
|
||||||
|
<arg path="${basedir}/build/logs/phploc.csv" />
|
||||||
|
<arg value="--log-xml" />
|
||||||
|
<arg path="${basedir}/build/logs/phploc.xml" />
|
||||||
|
<arg path="${basedir}/src" />
|
||||||
|
<arg path="${basedir}/tests" />
|
||||||
|
</exec>
|
||||||
|
|
||||||
|
<property name="phploc.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="pdepend"
|
||||||
|
unless="pdepend.done"
|
||||||
|
depends="prepare"
|
||||||
|
description="Calculate software metrics using PHP_Depend and log result in XML format. Intended for usage within a continuous integration environment.">
|
||||||
|
<exec executable="${pdepend}" taskname="pdepend">
|
||||||
|
<arg value="--jdepend-xml=${basedir}/build/logs/jdepend.xml" />
|
||||||
|
<arg value="--jdepend-chart=${basedir}/build/pdepend/dependencies.svg" />
|
||||||
|
<arg value="--overview-pyramid=${basedir}/build/pdepend/overview-pyramid.svg" />
|
||||||
|
<arg path="${basedir}/src" />
|
||||||
|
</exec>
|
||||||
|
|
||||||
|
<property name="pdepend.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="phpcs"
|
||||||
|
unless="phpcs.done"
|
||||||
|
description="Find coding standard violations using PHP_CodeSniffer and print human readable output. Intended for usage on the command line before committing.">
|
||||||
|
<exec executable="${phpcs}" taskname="phpcs">
|
||||||
|
<arg value="--standard=PSR2" />
|
||||||
|
<arg value="--extensions=php" />
|
||||||
|
<arg value="--ignore=autoload.php" />
|
||||||
|
<arg path="${basedir}/src" />
|
||||||
|
<arg path="${basedir}/tests" />
|
||||||
|
</exec>
|
||||||
|
|
||||||
|
<property name="phpcs.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="phpcs-ci"
|
||||||
|
unless="phpcs.done"
|
||||||
|
depends="prepare"
|
||||||
|
description="Find coding standard violations using PHP_CodeSniffer and log result in XML format. Intended for usage within a continuous integration environment.">
|
||||||
|
<exec executable="${phpcs}" output="/dev/null" taskname="phpcs">
|
||||||
|
<arg value="--report=checkstyle" />
|
||||||
|
<arg value="--report-file=${basedir}/build/logs/checkstyle.xml" />
|
||||||
|
<arg value="--standard=PSR2" />
|
||||||
|
<arg value="--extensions=php" />
|
||||||
|
<arg value="--ignore=autoload.php" />
|
||||||
|
<arg path="${basedir}/src" />
|
||||||
|
<arg path="${basedir}/tests" />
|
||||||
|
</exec>
|
||||||
|
|
||||||
|
<property name="phpcs.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="phpcpd"
|
||||||
|
unless="phpcpd.done"
|
||||||
|
description="Find duplicate code using PHPCPD and print human readable output. Intended for usage on the command line before committing.">
|
||||||
|
<exec executable="${phpcpd}" taskname="phpcpd">
|
||||||
|
<arg path="${basedir}/src" />
|
||||||
|
</exec>
|
||||||
|
|
||||||
|
<property name="phpcpd.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="phpcpd-ci"
|
||||||
|
unless="phpcpd.done"
|
||||||
|
depends="prepare"
|
||||||
|
description="Find duplicate code using PHPCPD and log result in XML format. Intended for usage within a continuous integration environment.">
|
||||||
|
<exec executable="${phpcpd}" taskname="phpcpd">
|
||||||
|
<arg value="--log-pmd" />
|
||||||
|
<arg path="${basedir}/build/logs/pmd-cpd.xml" />
|
||||||
|
<arg path="${basedir}/src" />
|
||||||
|
</exec>
|
||||||
|
|
||||||
|
<property name="phpcpd.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="phpunit"
|
||||||
|
unless="phpunit.done"
|
||||||
|
depends="prepare"
|
||||||
|
description="Run unit tests with PHPUnit">
|
||||||
|
<exec executable="${phpunit}" resultproperty="result.phpunit" taskname="phpunit">
|
||||||
|
<arg value="--configuration"/>
|
||||||
|
<arg path="${basedir}/build/phpunit.xml"/>
|
||||||
|
</exec>
|
||||||
|
|
||||||
|
<property name="phpunit.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="phpunit-no-coverage"
|
||||||
|
unless="phpunit.done"
|
||||||
|
depends="prepare"
|
||||||
|
description="Run unit tests with PHPUnit (without generating code coverage reports)">
|
||||||
|
<exec executable="${phpunit}" failonerror="true" taskname="phpunit">
|
||||||
|
<arg value="--configuration"/>
|
||||||
|
<arg path="${basedir}/build/phpunit.xml"/>
|
||||||
|
<arg value="--no-coverage"/>
|
||||||
|
</exec>
|
||||||
|
|
||||||
|
<property name="phpunit.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="phpdox"
|
||||||
|
unless="phpdox.done"
|
||||||
|
depends="phploc-ci,phpcs-ci,phpunit"
|
||||||
|
description="Generate project documentation using phpDox">
|
||||||
|
<exec executable="${phpdox}" dir="${basedir}/build" taskname="phpdox"/>
|
||||||
|
|
||||||
|
<property name="phpdox.done" value="true"/>
|
||||||
|
</target>
|
||||||
|
|
||||||
|
<target name="-check-failure">
|
||||||
|
<fail message="PHPUnit did not finish successfully">
|
||||||
|
<condition>
|
||||||
|
<not>
|
||||||
|
<equals arg1="${result.phpunit}" arg2="0"/>
|
||||||
|
</not>
|
||||||
|
</condition>
|
||||||
|
</fail>
|
||||||
|
</target>
|
||||||
|
</project>
|
||||||
|
|
||||||
131
build/phpdox.xml
Normal file
131
build/phpdox.xml
Normal file
@ -0,0 +1,131 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8" ?>
|
||||||
|
<!-- This is a skeleton phpDox config file - Check http://phpDox.de for latest version and more info -->
|
||||||
|
<phpdox xmlns="http://xml.phpdox.net/config" silent="false">
|
||||||
|
<!-- @silent: true | false to enable or disable visual output of progress -->
|
||||||
|
|
||||||
|
<!-- Additional bootstrap files to load for additional parsers, enrichers and/or engines -->
|
||||||
|
<!-- Place as many require nodes as you feel like in this container -->
|
||||||
|
<!-- syntax: <require file="/path/to/file.php" /> -->
|
||||||
|
<bootstrap />
|
||||||
|
|
||||||
|
<!-- A phpDox project to process, you can have multiple projects in one config file -->
|
||||||
|
<project name="Hummingbird Anime Client" source="../src" workdir="phpdox/xml">
|
||||||
|
<!-- @name - The name of the project -->
|
||||||
|
<!-- @source - The source directory of the application to process -->
|
||||||
|
<!-- @workdir - The directory to store the xml data files in -->
|
||||||
|
|
||||||
|
<!-- A phpDox config file can define additional variables (properties) per project -->
|
||||||
|
<!-- <property name="some.name" value="the.value" /> -->
|
||||||
|
|
||||||
|
<!-- Values can make use of previously defined properties -->
|
||||||
|
<!-- The following are defined by default:
|
||||||
|
|
||||||
|
${basedir} Directory the loaded config file is in
|
||||||
|
|
||||||
|
${phpDox.home} Directory of the phpDox installation
|
||||||
|
${phpDox.file} The current config file
|
||||||
|
${phpDox.version} phpDox' version number
|
||||||
|
|
||||||
|
${phpDox.project.name} The value of project/@name if set, otherwise 'unnamed'
|
||||||
|
${phpDox.project.source} The value of project/@source if set, otherwise '${basedir}/src'
|
||||||
|
${phpDox.project.workdir} The value of project/@workdir if set, otherwise '${basedir}/build/phpdox/xml'
|
||||||
|
|
||||||
|
${phpDox.php.version} The PHP Version of the interpreter in use
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- Additional configuration for the collecting process (parsing of php code, generation of xml data) -->
|
||||||
|
<collector publiconly="false" backend="parser" encoding="auto">
|
||||||
|
<!-- @publiconly - Flag to disable/enable processing of non public methods and members -->
|
||||||
|
<!-- @backend - The collector backend to use, currently only shipping with 'parser' -->
|
||||||
|
<!-- @encoding - Charset encoding of source files (overwrite default 'auto' if detection fails) -->
|
||||||
|
|
||||||
|
<!-- <include / exclude filter for filelist generator, mask must follow fnmatch() requirements -->
|
||||||
|
<include mask="*.php" />
|
||||||
|
<exclude mask="" />
|
||||||
|
|
||||||
|
<!-- How to handle inheritance -->
|
||||||
|
<inheritance resolve="true">
|
||||||
|
<!-- @resolve - Flag to enable/disable resolving of inheritance -->
|
||||||
|
|
||||||
|
<!-- You can define multiple (external) dependencies to be included -->
|
||||||
|
<!-- <dependency path="" -->
|
||||||
|
<!-- @path - path to a directory containing an index.xml for a dependency project -->
|
||||||
|
</inheritance>
|
||||||
|
|
||||||
|
</collector>
|
||||||
|
|
||||||
|
<!-- Configuration of generation process -->
|
||||||
|
<generator output="../docs">
|
||||||
|
<!-- @output - (Base-)Directory to store output data in -->
|
||||||
|
|
||||||
|
<!-- A generation process consists of one or more build tasks and of (optional) enrich sources -->
|
||||||
|
|
||||||
|
<enrich base="logs">
|
||||||
|
<!-- @base - (Base-)Directory of datafiles used for enrich process -->
|
||||||
|
|
||||||
|
<!--<source type="...">-->
|
||||||
|
<!-- @type - the handler for the enrichment -->
|
||||||
|
<!-- known types by default are: build, checkstyle, git, phpcs, phploc, phpunit, pmd -->
|
||||||
|
|
||||||
|
<!-- every enrichment source can have additional configuration nodes, most probably need a logfile -->
|
||||||
|
<!-- <file name="path/to/log.xml" /> -->
|
||||||
|
<!--</source> -->
|
||||||
|
|
||||||
|
<!-- add phploc output -->
|
||||||
|
<source type="phploc">
|
||||||
|
<file name="phploc.xml" />
|
||||||
|
</source>
|
||||||
|
|
||||||
|
<!-- git vcs information -->
|
||||||
|
<source type="git">
|
||||||
|
<git binary="/usr/bin/git" />
|
||||||
|
<history enabled="true" limit="15" cache="${phpDox.project.workdir}/gitlog.xml" />
|
||||||
|
</source>
|
||||||
|
|
||||||
|
<!-- PHP Code Sniffer findings -->
|
||||||
|
<!--
|
||||||
|
<source type="phpcs">
|
||||||
|
<file name="logs/phpcs.xml" />
|
||||||
|
</source>
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- PHPMessDetector -->
|
||||||
|
<!--
|
||||||
|
<source type="pmd">
|
||||||
|
<file name="pmd.xml" />
|
||||||
|
</source>
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!-- PHPUnit Coverage XML -->
|
||||||
|
<source type="phpunit">
|
||||||
|
<!-- <coverage path="clover.xml" />-->
|
||||||
|
<!-- @path - the directory where the xml code coverage report can be found -->
|
||||||
|
<!--<filter directory="${phpDox.project.source}" />-->
|
||||||
|
<!-- @directory - path of the phpunit config whitelist filter directory -->
|
||||||
|
</source>
|
||||||
|
<!--
|
||||||
|
<source type="phpunit">
|
||||||
|
<filter directory="${phpDox.project.source}" />
|
||||||
|
</source>
|
||||||
|
-->
|
||||||
|
|
||||||
|
</enrich>
|
||||||
|
|
||||||
|
<!-- <build engine="..." enabled="true" output="..." /> -->
|
||||||
|
<!-- @engine - The name of the engine this build task uses, use ./phpDox - -engines to get a list of available engines -->
|
||||||
|
<!-- @enabled - Flag to enable/disable this engine, default: enabled=true -->
|
||||||
|
<!-- @output - (optional) Output directory; if relative (no / as first char) it is interpreted as relative to generator/@output -->
|
||||||
|
|
||||||
|
<!-- An engine and thus build node can have additional configuration child nodes, please check the documentation for the engine to find out more -->
|
||||||
|
|
||||||
|
<!-- default engine "html" -->
|
||||||
|
<build engine="html" enabled="true">
|
||||||
|
<template dir="${phpDox.home}/templates/html" />
|
||||||
|
<file extension="html" />
|
||||||
|
</build>
|
||||||
|
|
||||||
|
</generator>
|
||||||
|
</project>
|
||||||
|
|
||||||
|
</phpdox>
|
||||||
37
build/phpunit.xml
Normal file
37
build/phpunit.xml
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<phpunit
|
||||||
|
colors="true"
|
||||||
|
stopOnFailure="false"
|
||||||
|
bootstrap="../tests/bootstrap.php"
|
||||||
|
beStrictAboutTestsThatDoNotTestAnything="true"
|
||||||
|
checkForUnintentionallyCoveredCode="true"
|
||||||
|
>
|
||||||
|
<filter>
|
||||||
|
<whitelist>
|
||||||
|
<directory suffix=".php">../src/Aviat/Ion</directory>
|
||||||
|
<directory suffix=".php">../src/Aviat/AnimeClient</directory>
|
||||||
|
</whitelist>
|
||||||
|
</filter>
|
||||||
|
<testsuites>
|
||||||
|
<testsuite name="Ion">
|
||||||
|
<directory>../tests/Ion</directory>
|
||||||
|
</testsuite>
|
||||||
|
<testsuite name="AnimeClient">
|
||||||
|
<directory>../tests/AnimeClient</directory>
|
||||||
|
</testsuite>
|
||||||
|
</testsuites>
|
||||||
|
<logging>
|
||||||
|
<log type="coverage-html" target="coverage"/>
|
||||||
|
<log type="coverage-clover" target="logs/clover.xml"/>
|
||||||
|
<log type="coverage-crap4j" target="logs/crap4j.xml"/>
|
||||||
|
<log type="coverage-xml" target="logs/coverage" />
|
||||||
|
<log type="junit" target="logs/junit.xml" logIncompleteSkipped="false"/>
|
||||||
|
</logging>
|
||||||
|
<php>
|
||||||
|
<server name="HTTP_USER_AGENT" value="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:38.0) Gecko/20100101 Firefox/38.0" />
|
||||||
|
<server name="HTTP_HOST" value="localhost" />
|
||||||
|
<server name="SERVER_NAME" value="localhost" />
|
||||||
|
<server name="REQUEST_URI" value="/" />
|
||||||
|
<server name="REQUEST_METHOD" value="GET" />
|
||||||
|
</php>
|
||||||
|
</phpunit>
|
||||||
23
phpci.yml
23
phpci.yml
@ -1,23 +0,0 @@
|
|||||||
build_settings:
|
|
||||||
verbose: true
|
|
||||||
ignore:
|
|
||||||
- "tests"
|
|
||||||
- "vendor"
|
|
||||||
|
|
||||||
setup:
|
|
||||||
env:
|
|
||||||
PHPCI: true
|
|
||||||
|
|
||||||
test:
|
|
||||||
php_unit:
|
|
||||||
config: 'phpunit.xml'
|
|
||||||
php_docblock_checker:
|
|
||||||
allowed_warnings: 0
|
|
||||||
skip_classes: true
|
|
||||||
php_loc:
|
|
||||||
php_mess_detector:
|
|
||||||
allow_failures: true
|
|
||||||
rules:
|
|
||||||
- "unusedcode"
|
|
||||||
- "naming"
|
|
||||||
complete:
|
|
||||||
Loading…
Reference in New Issue
Block a user