Permalink
Newer
Older
100755 85 lines (49 sloc) 2.64 KB
1
# JBehave
2
3
JBehave is a BDD framework for Java and Groovy, mirrored [at Github](https://github.com/jbehave/jbehave-core), definitive repo [at Codehaus](http://xircles.codehaus.org/projects/jbehave).
4
5
<img src="http://jbehave.org/reference/preview/images/jbehave-logo.png" alt="JBehave logo" align="right" />
6
7
## Using
8
9
Canonical information for JBehave:
11
1. [News](http://jbehave.org).
12
2. [Documentation](http://jbehave.org/documentation/).
13
3. [User mail-list](http://xircles.codehaus.org/lists/user@jbehave.codehaus.org)
14
4. Jars in [Maven Repositories](http://mvnrepository.com/search.html?query=jbehave)
15
Mar 23, 2011
16
## Contributing and Developing
Mar 23, 2011
18
Please report issues, feature requests on the Codehaus [issue
19
tracker](http://jira.codehaus.org/browse/JBEHAVE) or discuss them on the
20
[dev mail-list](http://xircles.codehaus.org/lists/dev@jbehave.codehaus.org).
22
Keep an eye on the [Bamboo Continuous Integration](http://bamboo.ci.codehaus.org/browse/JBEHAVE) server for JBehave builds.
Mar 23, 2011
23
24
### Depended-on Technologies
Mar 23, 2011
25
26
JDK required: 5.0 (or above)
27
[Maven](http://maven.apache.org) required (2.2.1 or above, 3.0 or above for reporting).
Mar 23, 2011
28
29
### Encoding
Mar 23, 2011
30
31
Configure IDE to use UTF-8 for all files
32
Configure Maven by adding "-Dfile.encoding=UTF-8" to $MAVEN_OPTS
33
34
### IDE Integration
Mar 23, 2011
35
36
Maven is supported in Intellij IDEA out-of-the-box
37
Maven is supported in Eclipse via [m2eclipse plugin](http://m2eclipse.sonatype.org/)
38
Mar 23, 2011
39
### Building
40
41
The first time you run the Maven build (Maven 2.2.1 or above required), do:
42
43
mvn install -s settings.xml
44
45
After that, it is necessary to only do the following:
46
47
mvn install
48
49
### Maven Build Profiles
Mar 23, 2011
50
51
- default: builds all releasable modules
52
- examples: builds all headless examples
53
- gui: builds examples that require a GUI (i.e. non-headless) mode (separated as they do not run on [Bamboo CI](http://bamboo.ci.codehaus.org/browse/JBEHAVE) )
Mar 23, 2011
54
- nt: no-test, builds skipping unit-test behaviors
55
56
#### Maven Build Profiles used during release cycle
57
58
- reporting: builds reports
59
- distribution: builds distribution (documentation)
60
Mar 23, 2011
61
Note: profiles are additive and the default profile is always active.
62
63
### Example Profile Usages
Mar 23, 2011
64
65
#### Build Core and all Examples
Mar 23, 2011
66
67
mvn install -Pexamples
Mar 23, 2011
68
69
#### Build with Reporting and Distribution
Mar 23, 2011
70
Mar 23, 2011
71
mvn install -Preporting,distribution
Mar 23, 2011
72
73
#### Building a Release with Maven
Mar 23, 2011
74
Mar 23, 2011
75
mvn release:prepare -Preporting,distribution
76
mvn release:perform -Preporting,distribution
Mar 23, 2011
77
78
## Related
79
Mar 23, 2011
80
See also the [jbehave-web](jbehave-web) sister project for web extensions to JBehave, and [jbehave-tutorial](jbehave-tutorial) for a decent example of JBehave testing of a web application.
81
82
## License
83
Jan 10, 2012
84
See LICENSE.txt in the source root (BSD).