Thursday, July 23. 2009
While working on PHP_Depend's parser I realized one major reason Why I love PHP, it's the flexibility of language. Even if you think you now know all ways to solve a problem, there is always one more way to solve it.
class f { function bar() { echo __METHOD__, '()', PHP_EOL; } function __toString() { return 'v'; } } class v { function __toString() { return 'c'; } } class m { function __toString() { return 'bar'; } } $c = 'f'; $${'v'} = new ${(string) new ${$v = 'v'}()}(); $$$$$$v->{(string) new m()}();
But to be serious, don't be worried, if you don't get it.
Tuesday, July 7. 2009
Software metrics are currently on everyone's lips and a frequently discussed topic. There are many conference talks, blog posts and other presentations that talk about software metrics. But to me it seems as if this subject is a closed book for many developers, so I decided to write this little post about a special category of software metrics, the complexity metrics.
Complexity metrics are a theoretical approach to measure the subjective complexity of a software fragment, where the words software fragment stand for a paraphrase for functions, methods, classes and nearly every logical unit that can be found in a software system. The most prevalent procedure to calculate complexity values is static code analysis, where an application parses the raw source code of a project, counts different statements and expressions and packs up the determined results in simple classification numbers. And with this information you already know the main concepts behind most software metrics, classification numbers and counting. As you can see there is no magic behind the scene, the only thing required is a good background knowledge to interpret those values.
The Cyclomatic Complexity Number or short CCN is the
oldest complexity metrics. The first time this software
metric was mentioned was 1976 by Thomas J. McCabe. This
metric counts the available decision paths in a software
fragment to determine its complexity. Each decision path
starts with one of the conditional statements from the
following list, so that it is fairly easy to detect them in
existing source code.
- ?
- case
- elseif
- for
- foreach
- if
- while
A look at this list of statements may result in the questions:
Is this list wrong, it doesn't list else and default?
But it is correct. The assumption is that both statements
will contain the defaut execution path of a program which
also exists when there are no special cases to capture.
Each decision path gets the value 1 and the sum of all these
values represents the Cyclomatic Complexity of the analyzed
software fragment. Note that each function and method also
counts with a value of 1 With this knowlegde we can now
calculate the complexity of the following example code:
<?php class CyclomaticComplexityNumber { public function exampe( $x, $y ) // (1) { if ( $x > 23 || $y < 42 ) // (1) { for ( $i = $x; $i >= $x && $i <= $y; ++$i ) // (1) { } } else { switch ( $x + $y ) { case 1: // (1) break; case 2: // (1) break; default: break; } } } file_exists('/tmp/log') or touch('/tmp/log'); }
Based on the previous definition the Cyclomatic Complexity
Number of the example code example is 5. But you may have
noticed that this approach does not capture all decision paths
that exist. We haven't catched those paths that came from the
by the boolean expression || line 6 and && line 8, and
the logical or expression in line 25. A variation of the
Cyclomatic Complexity Number that also captures those paths
is the so called CCN2. The CCN2 is the most widely used
variation of this software metrics. Tools like PHPUnit, PMD
and Checkstyle report it as Cyclomatic Complexity of an
analyzed software fragment.
Now we get a complexity value of 8 when we apply the CCN2
to the previous example, what is a growt of the software's
complexity of 60%.
Due to the fact that Cyclomatic Complexity Number was
originally invented for procedural programming languages,
this definition for the Cyclomatic Complexity Number still
misses one element to measure the complexity of an object
oriented software system. With the concept of exceptions a
software gets additional decision paths for each catch
statement used in the source code. While try contains
the code for the regular execution code without special
cases, similar to else and default statements.
- ?
- &&
- ||
- or
- and
- xor
- case
- catch
- elseif
- for
- foreach
- if
- while
Now that we know what the Cyclomatic Complexity Number is,
what can we do with the measured information? We can find
the complexity hotspots in a system, for example the top
ten artifacts with the highest complexity, but this is only
important during an initial analyses phase to get the big
picture of an application. For a continuous inspection this
information is not so important. A continuous analyses
requires thresholds that help to categories calculated
values. During the time four values have emerged as good
thresholds for the Cyclomatic Complexity Number of a
software system.
- A software fragment with a CCN value between 1-4 has
low complexity.
- A complexity value between 5-7 is moderate and still
easy to understand.
- Everything between 6-10 has a high complexity, while
everything greater 10 is very complex and hard to
understand.
You may ask, why should I care about the complexity of a
software system, where is the value of benefit in this
metric?
Mostly the complex parts of an application contain business
critical logic. But this complexity has negative impacts on
the readability and understandability of source code. Those
parts will normally become a maintainence and bug fixing
nightmare, because no one knows all the constraints, side
effects and what's exactly going on in that part of the
software. This situation results in the well known saying
"Never touch a running system" which in turn mostly ends
in copy&paste programming. The situation can even become
more critical when the original author leaves the
development team or the company.
Finally a small example how to apply the new knowledge
about the Cyclomatic Complexity Number, thresholds and the
negative impacts of complex software to an existing
development process. The following source listing shows
a complex method taken from PHP_Depend's source. This method
has a Cyclomatic Complexity Number of 16 and I must admit
that the original author needed some time to understand what
was going on in this method.
<?php // ... private function _countCalls(AbstractCallable $callable) { $callT = array( TokenizerI::T_STRING, TokenizerI::T_VARIABLE ); $chainT = array( TokenizerI::T_DOUBLE_COLON, TokenizerI::T_OBJECT_OPERATOR, ); $called = array(); $tokens = $callable->getTokens(); $count = count($tokens); for ($i = 0; $i < $count; ++$i) { // break on function body open if ($tokens[$i]->type === TokenizerI::T_CURLY_BRACE_OPEN) { break; } } for (; $i < $count; ++$i) { // Skip non parenthesis tokens if ($tokens[$i]->type !== TokenizerI::T_PARENTHESIS_OPEN) { continue; } // Skip first token if (!isset($tokens[$i - 1]) || !in_array($tokens[$i - 1]->type, $callT)) { continue; } // Count if no other token exists if (!isset($tokens[$i - 2]) && !isset($called[$tokens[$i - 1]->image])) { $called[$tokens[$i - 1]->image] = true; ++$this->_calls; continue; } else if (in_array($tokens[$i - 2]->type, $chainT)) { $identifier = $tokens[$i - 2]->image . $tokens[$i - 1]->image; for ($j = $i - 3; $j >= 0; --$j) { if (!in_array($tokens[$j]->type, $callT) && !in_array($tokens[$j]->type, $chainT) ) { break; } $identifier = $tokens[$j]->image . $identifier; } if (!isset($called[$identifier])) { $called[$identifier] = true; ++$this->_calls; } } else if ($tokens[$i - 2]->type !== TokenizerI::T_NEW && !isset($called[$tokens[$i - 1]->image]) ) { $called[$tokens[$i - 1]->image] = true; ++$this->_calls; } } }
The first thing to do is to make sure that the test suite
is good enough to ensure that the required refactorings
will not change the public behavior of the component or
class. When this is donw and we are sure our that api
breaks will be detected by the test suitewe can start to
extract logic into separate methods.
The following example shows the result of the refactoring:
<?php // ... private function _countCalls(AbstractCallable $callable) { $called = array(); $tokens = $callable->getTokens(); $count = count($tokens); for ($i = $this->_findOpenCurlyBrace($tokens); $i < $count; ++$i) { if ($this->_isCallableOpenParenthesis($tokens, $i) === false) { continue; } if ($this->_isMethodInvocation($tokens, $i) === true) { $image = $this->_getInvocationChainImage($tokens, $i); } else if ($this->_isFunctionInvocation($tokens, $i) === true) { $image = $tokens[$i - 1]->image; } else { $image = null; } if ($image !== null) { $called[$image] = $image; } } $this->_calls += count($called); }
The subjective feeling of readability heavily depends on the
complexity of control structures, as we can see by a
comparison of the original and the refactored version of the
method example. The new version with its Cyclomatic Complexity
Number of 5 is much easier to read and understand.
This text is the first of two blog posts. The second article
will give a short introduction into the NPath Complexity
You liked this article and you are interested in this and
other quality assurence related topics? - Then you should
now order your copy of the Book Quality Assurance in PHP
Projects. The book talks about nearly all aspect of
quality assurence, with practical tips and expert knowledge
contributed by certain PHP professionals.
Monday, May 18. 2009
Today I released PHP_Depend 0.9.5, which contains many bug fixes and improvements. The main features of this release are PHP 5.3 namespace support and a more robust parser that ignores most kinds of syntax errors,
-
Closed #2 Support PHP 5.3 namespace syntax, implemented since svn revision #789.
-
Closed #61 Catch parser errors and continue processing, implemented in svn revision #880.
-
Closed #63 Make ResultPrinter a configurable option, implemented in svn revision #668.
-
Fixed #64 The single cache directory causes permission denied on *NIX systems, fixed in svn revision #667.
-
Fixed #65 Endless loop for class and interface declarations without body, fixed in svn revision #672.
-
Closed #66 Dependency wiring should be done at the end of the parsing process, implemented in svn revision #855.
-
Fixed #69 Parser does not handle PHP 5.3 class names in function and method bodies, fixed in svn revision #688.
-
Fixed #70 Parser throws an unexpected token exception for closure, fixed in svn revision #726.
-
Fixed #71 Parser throws an unexpected token exception for signed default values, fixed in svn revision #740.
-
Fixed #73 Inconsistent state when an interface and a class with the same name exists, fixed in svn revision #776.
-
Fixed #76 Tokenizer keyword detection is broken, fixed in svn revision #871.
You can get the latest PHP_Depend version from its PEAR channel: pear.pdepend.org
mapi@arwen ~ $ pear channel-discover pear.pdepend.org
mapi@arwen ~ $ pear install pdepend/PHP_Depend-beta
Saturday, February 21. 2009
Today I released PHP_Depend 0.9.4, which contains many bug fixes and improvements.
-
Fixed #92: Handling of types within instanceof-operator fixed.
-
Closed #90: Support for single file parsing/analyzing implemented.
-
Closed #88: Tokens provide information about the start and end column.
-
Closed #87: Support for type definitions within comments implemented.
-
Closed #40: Cli debug flag added. PHP_Depend will print additional debug information to STDERR when this cli switch is set.
-
The ProjectAwareI and NodeAwareI interfaces extend the AnalyzerI interface, which makes analyzer mocking easier.
-
Switch from PHP_Depend specific constants for public, protected, private methods & properties to modifiers compatible with PHP's reflection-extension.
-
Support for static modifier for properties&methods and final for methods added.
-
Support for class final modifier added.
-
Support for chained types like "false|Iterator" or "array(false|Iterator)" in doc comments added.
You can get the latest PHP_Depend version from its PEAR channel: pear.pdepend.org
mapi@arwen ~ $ pear channel-discover pear.pdepend.org
mapi@arwen ~ $ pear install pdepend/PHP_Depend
Monday, January 19. 2009
Just now I released PHP_Depend 0.9.3, the primary goal for this release was focused on less memory consumption. A run of PHP_Depend 0.9.2 against eZ Publish took up to 1GB and PHP_Depend 0.9.3 analyzes the same source with a memory limit of 160Mb.
-
Fixed #89: The source file is never set for methods, properties and constants.
-
Closed #82: Tokenizer cache added, reduces runtime up to 25%.
-
Closed #83: Storage layer for node tokens added, reduces memory consumption. .
-
Closed #85: TextUI displays the execution time and the memory usage(linux only).
-
Code restructured, input filters and iterator moved to package "Input".
-
Test suite restructured to reflect the actual project structure.
From now on you will get the latest PHP_Depend version through the new pear channel pear.pdepend.org, for a few weeks I will keep the old pear channel. Enter the following pear commands to upgrade PHP_Depend's channel.
mapi@arwen ~ $ pear channel-discover pear.pdepend.org
mapi@arwen ~ $ pear uninstall xplib/PHP_Depend
mapi@arwen ~ $ pear install pdepend/PHP_Depend
Or checkout version 0.9.3 from the PHP_Depend subversion repository.
mapi@arwen ~ $ svn co http://svn.pdepend.org/tags/0.9.3
Saturday, January 3. 2009
Nowadays there are some really strange online habits, like this I was tagged post. Even if I ignore most of those customs this time I will go on with Kore's blog post and tell seven things about me.
- Before I was a computer scientist I finished a training as precision mechanic.
- My first programming language was a CNC dialect.
- I like cycling mountains up and down with my racing bike.
- I started PHP programming in 1999.
- The first framework I have used was the legendary PHPLIB.
- In December 2008 I started with photography.
- I have to less time to realize all projects I think about.
And now I will split the baton I got from Kore in seven pieces and pass it on:
These are the rules apparently:
- Link your original tagger(s), and list these rules on your blog.
- Share seven facts about yourself in the post - some random, some weird.
- Tag seven people at the end of your post by leaving their names and the links to their blogs.
- Let them know they've been tagged by leaving a comment on their blogs and/or Twitter.
Wednesday, December 31. 2008
Just now I released PHP_Depend 0.9.1, the major feature in this new version is an implementation of the NPath Complexity metric, beside that feature the main focus for this release was on performance improvements of the current implementation.
-
Closed #21: Support for the NPath Complexity metric.
-
Fixed #78: Parser fails for comment in function signature.
-
Closed #79: Token objects instead of arrays.
An additional test concept was introduced with the 0.9.* branch of PHP_Depend. Nightly builds test PHP_Depend against a series of open source projects to detect deadlocks like endless loop or similar issues. This procedure is also used to test each release candidate of PHP_Depend. The tested project are:
You can get the latest PHP_Depend version through its PEAR channel pear.xplib.de or as a subversion checkout of the 0.9.1 tag.
Please do not checkout "trunk", it is totally unstable at the moment and I will not provide any support for it.
mapi@arwen ~ $ svn co http://svn.pdepend.org/tags/0.9.1
Monday, December 15. 2008
Today I released version 0.9.0 of PHP_Depend. Beside bugfixes this release contains new features like a PHPUnit compatible xml-log.
-
Closed #43: An image file name "jdepend" now results in "jdepend.svg" instead of ".svg".
-
Closed #42: Print a warning when the analyzed directory does not contain source files.
-
Closed #35: Support for custom svg font-family and font-size added.
-
Closed #32: Support for function and method parameters added.
-
Fixed #30: Approximated Lines Of Code improved.
-
Closed #20: Support for class constants implemented.
-
Closed #19: PHPUnit compatible logger added.
-
Fixed #17: Detect class names in catch statements.
-
Fixed #16: Detect class names in instanceof expressions.
-
Fixed #46: Default package is broken.
You can get the latest PHP_Depend version through its PEAR channel
mapi@arwen ~ $ pear channel-discover pear.xplib.de
mapi@arwen ~ $ pear install xplib/php_depend
or as a subversion checkout of the 0.9.0 branch or tag.
Please do not checkout "trunk", it is totally unstable at the moment and I will not provide any support for it.
mapi@arwen ~ $ svn co http://svn.pdepend.org/branches/0.9.0
mapi@arwen ~ $ svn co http://svn.pdepend.org/tags/0.9.0
Feel free to report issues, bugs or just leave a comment here.
Friday, December 12. 2008
Are you also tired of all those monotonous and boring source code you read or write every day? No new challenges, always the same constructs and expression, must that really be so?
Fortunately do you use a programming language that comes with a wide range of opportunities to solve identical tasks in various ways. And here is a simple tip how you can bring variety in your source code with a single expression. Just use the whole range of valid new-expressions and donate your colleagues, customers and other persons with that varied and exciting christmas source code. A simple new MyClass () recognizes and understands finally everyone on the first glance 
<?php new self; new static; new clazz; new self::$class; new static::$class; new self::${'class'}; new static::${'class'}; new self::$$class; new static::$$class new self::$${'class'}; new static::$${'class'}; new $class; new $$class; new ${'class'}; new $${'class'}; new $obj->class; new $obj->${'name'}; new $obj->$${'name'}; new $obj->{'class'}; new $obj->$$class; new php_ast_Parser; new php\ast\Clazz; new \php\ast\Clazz; ?>
You should also vary the embedded expression which increases the number of possible solutions
In this sense, a lot of fun and a nice weekend...
Sunday, November 23. 2008
-
Fixed #621:
phpUnderControl dashboard is broken with CruiseControl 2.8 -
[4085]
-
Closed #609:
Use artifacts directory for artifacts -
[4118]
-
Closed #611:
opera: code coverage not visible -
[4119]
-
Closed #622:
phpUnderControl needs a custom error page -
[4116]
Saturday, September 20. 2008
There was a documentation error in the previously presented ant build file for the new merge-phpunit command of phpUnderControl. The @failonerror-attribute of the <exec />-tag in the merge target was set to false, which results in not failed CruiseControl builds  To fix this behaviour, you must modify the merge target in your build.xml, so that it looks similar to the following example.
<?xml version="1.0" encoding="UTF-8"?> <project name="phpuc-test" default="build" basedir="."> .... <target name="merge"> <exec executable="/usr/local/pear/PEAR/bin/phpuc" dir="${basedir}" failonerror="true"> <arg line="merge-phpunit -b php-5.3.0,php-5.2.6,php-5.2.5 -i ${basedir}/build/tmp/php-5.3.0.xml,${basedir}/build/tmp/php-5.2.6.xml,${basedir}/build/tmp/php-5.2.5.xml -o ${basedir}/build/logs/log.xml"/> </exec> </target> </project>
Beside this documentation error, there was a bug in version 0.4.3 related to the same topic, which is fixed now. So please make sure you have the latest version (at least 0.4.4) installed.
Sunday, September 7. 2008
I currently released a new version of phpUnderControl. Beside some minor fixes this release comes with a new feature to aggregate test results of multiple PHPUnit runs.
Use the new cli command merge-phpunit of phpUnderControl to merge multiple log files produced with PHPUnit, as shown in the following example build file for ant.
<?xml version="1.0" encoding="UTF-8"?> <project name="phpuc-test" default="build" basedir="."> <target name="build" depends="clean,p5.3.0,p5.2.5,p5.2.6,merge"/> <target name="clean"> <delete> <fileset dir="${basedir}/build/tmp"> <include name="*.xml"/> </fileset> </delete> </target> <target name="p5.2.5"> <exec executable="/usr/local/bin/php525" dir="${basedir}" failonerror="false"> <arg line="/usr/local/pear/bin/phpunit --configuration ${basedir}/phpunit.xml --log-xml ${basedir}/build/tmp/php-5.2.5.xml PhpUnderControl_Example_MathTest source/tests/MathTest.php"/> </exec> </target> <target name="p5.2.6"> <exec executable="/usr/local/bin/php526" dir="${basedir}" failonerror="false"> <arg line="/usr/local/pear/bin/phpunit --configuration ${basedir}/phpunit.xml --log-xml ${basedir}/build/tmp/php-5.2.6.xml PhpUnderControl_Example_MathTest source/tests/MathTest.php"/> </exec> </target> <target name="p5.3.0"> <exec executable="/usr/local/php/bin/php" dir="${basedir}" failonerror="false"> <arg line="/usr/local/pear/bin/phpunit --configuration ${basedir}/phpunit.xml --log-xml ${basedir}/build/tmp/php-5.3.0.xml PhpUnderControl_Example_MathTest source/tests/MathTest.php"/> </exec> </target> <target name="merge"> <exec executable="/home/manu/Desktop/Projects/workspace.xplib.de/phpUnderControl/trunk/bin/phpuc.php" dir="${basedir}" failonerror="false"> <arg line="merge-phpunit -b php-5.3.0,php-5.2.6,php-5.2.5 -i ${basedir}/build/tmp/php-5.3.0.xml,${basedir}/build/tmp/php-5.2.6.xml,${basedir}/build/tmp/php-5.2.5.xml -o ${basedir}/build/logs/log.xml"/> </exec> </target> </project>
The following picture shows the phpUnderControl result of such a merged log file:
Sunday, July 27. 2008
Today I released the stable 0.8.0 version of PHP_Depend.
- Fixed: Endless loop for inline html.
- Fixed: Handle class and interface names case insensitive.
- Fixed: PHP_Depend should print an error if no @package information is available.
- The Logger interface should not force a default ctor-signature.
- Remove Logger <-> XML Config dependency.
- Support for pattern based package filter.
- Tooltip for the Overview Pyramid.
- Add option --bad-documentation.
- Handle internal classes and interfaces.
- Use an SVG-Template for the jdepend chart.
- Introduce a CodeAware interface for loggers.
The previous list was taken from the PHP_Depend issue tracker. Feel free to report issues, bugs or just leave a comment here.
Wednesday, June 18. 2008
This new release of PHP_Depend took some time to be finished. This is because the initial idea of a simple adaption of JDepend evolved (supported thru this blog-post by Sebastian), and so PHP_Depend has become a complete software metric application. Many new features and enhancements have found their way into this version. One of the key features is the pluggable architecture for custom Loggers and Metric-Analyzers. This opens the possibility to hook own Logger- and Analyzer-implementations into the execution chain of PHP_Depend. Beside these architectural changes this PHP_Depend version is shipped with a large set of implemented software metrics.
ClassLevel (Class)
- dit: Depth of Inheritance Tree
- impl: Number of implemented interfaces
- cis: Class Interface Size
- csz: Class SiZe
- vars: Number of defined class properties
- varsi: Number of own and inherited class properties
- varsnp: Number of public class properties
- wmc: Weighted Method per Class(Sum of method Cyclomatic Complexity)
- wmci: Weighted Method per Class + inherited WMC
- wmcnp: Weighted Method per Class for all public class methods
CodeRank (Class, Package)
An adaption of google's PageRank algorithm for classes and packages.
- cr: Forward CodeRank (based on incoming edges)
- rcr: Reverse CodeRank (based on outgoing edges)
Coupling (Project)
- calls: Number of called methods and functions
- fanout: Number of referenced types
Cyclomatic Complexity (Project, Method, Function)
- ccn: Cyclomatic Complexity
- ccn2: Extended Cyclomatic Complexity
Dependency (Package)
For details see the following entry.
- ca: Afferent coupling
- ce: Efferent coupling
- a: Abstraction
- i: Instability
- d: Distance
Hierarchy (Project)
- clsa: Number of abstract classes.
- clsc: Number of concrete classes.
- roots: Number of root classes within the analyzed system.
- leafs: Number of leaf classes.
- maxDIT: Max Depth of Inheritance Tree value
Inheritance (Project)
- andc: Average Number of Derived Classes.
- ahh: Average Hierarchy Height
NodeCount (Project, Package, Class, Interface)
- nop: Number Of Packages
- noc: Number Of Classes
- noi: Number Of Interfaces
- nom: Number Of Methods
- nof: Number Of Functions
NodeLOC (Project, Package, Class, Interface, Method, Function)
- loc: Lines Of Code
- cloc: Comment Lines Of Code
- ncloc: Non Comment Lines Of Code
Due to the fact that PHP is a loosely typed programming language, PHP_Depend can only approximate some values. But the measured results can be improved with a good and complete source code documentation, because PHP_Depend takes advantage of different doc comment annotations (@throws, @var, @return). So I suggest the use of a tool like PHP_CodeSniffer, to achieve better results.
Beside all these metrics, PHP_Depend also provides a new chart type, the "Overview Pyramid". The Overview Pyramid can be a handy tool to analyze legacy code. If you have read the book Object-Oriented Metrics in Practice you should know howto interpret the Overview Pyramid, all others have to wait for a detailed description.
This new version can be installed with the PEAR-Installer. Just discover the pear.xplib.de channel and install the latest PHP_Depend release.
After PHP_Depend has been installed successfully, the new command line tool pdepend should exist.
mapi@arwen ~ $ pear channel-discover pear.xplib.de
mapi@arwen ~ $ pear install xplib/PHP_Depend-beta
mapi@arwen ~ $ pdepend --help
PHP_Depend 0.8.0beta1 by Manuel Pichler
Usage: pdepend [options] [logger] <dir[,dir[,...]]>
--jdepend-chart=<file> Generates a diagram of the analyzed packages.
--jdepend-xml=<file> Generates the package dependency log.
--overview-pyramid=<file> Generates a chart with an Overview Pyramid for the
analyzed project.
--summary-xml=<file> Generates a xml log with all metrics.
--coderank-mode=<*[,...]> Used CodeRank strategies. Comma separated list of
'inheritance'(default), 'property' and 'method'.
--suffix=<ext[,...]> List of valid PHP file extensions.
--ignore=<dir[,...]> List of exclude directories.
--exclude=<pkg[,...]> List of exclude packages.
--without-annotations Do not parse doc comment annotations.
--help Print this help text.
--version Print the current PHP_Depend version.
There is also a Subversion repository at http://svn.pdepend.org/, where the latest development version can be found.
Please test this beta release and file bug-reports and feature-requests in the PHP_Depend bug tracker.
Sunday, March 30. 2008
A few minutes ago I have released the latest phpUnderControl 0.4.0 version. In addition to many minor fixes and improvements this version comes with three utility commands, that should simplify some common tasks.
1) Project delete
The project delete command provides a simple way to delete a complete project with all its contents, including logs, artifacts and sources, from your CruiseControl installation.
[mapi@arwen~]$ phpuc delete --project-name connectfour /opt/cruisecontrol
2) Project clean
I do not really like this feature, because I really dislike the idea to delete old builds and artifacts, but I must admit that I have mounted a 100 GB partition as artifacts directory. Due to the fact that this feature was requested by many phpUnderControl users, it is implemented in phpUnderControl 0.4.0.
This command allows you to delete old logs and artifacts except a configurable number of the latests builds. The following command will remove all build results for the php-under-control except the last 20 builds.
[mapi@arwen~]$ phpuc clean --project-name php-under-control \
--keep-builds 20 /opt/cruisecontrol
3) Project create
The project create command provides a cli wizard to set up a new CruiseControl project. The following command will create a new project for the PHPUnit BankAccount sample, checkout the latest svn version, create the required directories and finally prepare the ant build.xml and the CruiseControl config.xml. If you don't like XML or you have multiple projects, that share a common source/project layout, this command could be useful for you.
[mapi@arwen~]$ phpuc project --version-control svn \
--version-control-url svn://svn.phpunit.de/.. \
--project-name BankAccount2 \
--source-dir . \
--test-case BankAccountTest \
--test-dir . \
--test-file BankAccountTest.php \
--schedule-interval 20 \
/opt/cruisecontrol
But I would always recommend to use the example build.xml and config.xml to set up a new project. Both files are completely documented and contain links to the original CruiseControl configuration reference.
I will do my best to complete the missing documentation for the CruiseControl config.xml file and the new cli commands. Any help is welcome.
|
