Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/unclebob/fitnesse

FitNesse -- The Acceptance Test Wiki
https://github.com/unclebob/fitnesse

Last synced: 3 days ago
JSON representation

FitNesse -- The Acceptance Test Wiki

Host: GitHub
URL: https://github.com/unclebob/fitnesse
Owner: unclebob
License: other
Created: 2008-12-06T19:38:59.000Z (about 16 years ago)
Default Branch: master
Last Pushed: 2024-10-23T19:08:10.000Z (2 months ago)
Last Synced: 2024-10-24T02:18:48.957Z (2 months ago)
Language: Java
Homepage: fitnesse.org
Size: 70.9 MB
Stars: 2,034
Watchers: 150
Forks: 713
Open Issues: 97
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Security: SECURITY.md

Awesome Lists containing this project

README

# [FitNesse](https://fitnesse.org/) [![maven central](https://maven-badges.herokuapp.com/maven-central/org.fitnesse/fitnesse/badge.svg?style=flat)](https://maven-badges.herokuapp.com/maven-central/org.fitnesse/fitnesse) [![SonarQube Tech Debt](https://img.shields.io/sonar/http/nemo.sonarqube.org/org.fitnesse:fitnesse/tech_debt.svg)](http://nemo.sonarqube.org/dashboard/index?id=org.fitnesse%3Afitnesse)

Welcome to FitNesse, the fully integrated stand-alone acceptance testing framework and wiki.

To get started, check out the [FitNesse website](https://fitnesse.org/)!

## Quick start

* [A One-Minute Description of FitNesse](https://fitnesse.org/FitNesse/UserGuide/OneMinuteDescription.html)
* [Download FitNesse](https://fitnesse.org/FitNesseDownload.html) and [Plugins](https://fitnesse.org/PlugIns.html)
* [The FitNesse User Guide](https://fitnesse.org/FitNesse/UserGuide.html)

## Bug tracker

Have a bug or a feature request? [Please open a new issue](https://github.com/unclebob/fitnesse/issues).

## Edge builds

The latest stable build of FitNesse can be [downloaded here](https://github.com/unclebob/fitnesse/actions) by clicking the latest workflow and clicking the `libs` artifact.

**Note**: the `libs` artifact contains 2 jars. `fitnesse.jar` is for use in Maven or Ivy. Users who just want to run FitNesse by itself should use `fitnesse-standalone.jar` instead of `fitnesse.jar`.

## Developers

Issues and pull requests are administered at [GitHub](https://github.com/unclebob/fitnesse/issues).

### Building

A proper internet connection is sufficient to build FitNesse. The build process will bootstrap itself by downloading [Gradle](http://gradle.org) and from there will download the dependencies required to build and test FitNesse.

To build and run all tests, run the command

```
$ ./gradlew
```

which builds the `all` target.

NB. On windows call `gradlew.bat` instead of `./gradlew`.

### Running

To start the FitNesse wiki locally, for example to browse the local version of the User Guide

```
$ ./gradlew run
```

### Testing

To run the unit tests:

```
$ ./gradlew test
```

To run the acceptance tests:

```
$ ./gradlew acceptanceTest
```

### Working with Eclipse and IntelliJ

There are a few things to keep in mind when working from an IDE:

1. The Gradle build does some extra things apart from compiling the code.
* It sets the FitNesse version in a META-INF/FitNesseVersion.txt
* It copies the dependencies to the lib folder so they can be used by the acceptance tests.

Perform a
```
$ ./gradlew copyRuntimeLibs
```
to execute the copy action. In your IDE it is possible to define "post-compilation" steps. If
you set the "post-compile" target from the build file, you won't have any trouble with
cleaning, building and executing tests from your IDE.

#### Import FitNesse in Eclipse

1. Clone the FitNesse Git repository from https://github.com/unclebob/fitnesse.
2. Import FitNesse via _File_ -> _Import..._ -> _Gradle Project_.
3. Select the just cloned project folder. Follow the wizard.
4. Ensure the project properties have a Java 8 compiler or newer set.

#### Import FitNesse in IntelliJ IDEA (16)

1. Clone the FitNesse Git repository from https://github.com/unclebob/fitnesse.
2. From the welcome screen (the one you get when all projects are closed), click _Import Project_.
3. Select the file `build.gradle` in the fitnesse folder.
4. Follow the wizard. Deselect the option `Create separate module per source set`. You can use the
`Use gradle wrapper task configuration`. Use Java 8 or newer. It should find source and test folders and
show you two modules: `fitnesse` and `:buildSrc`; import both.
5. Open the Gradle Build tool, select the task `copyRuntimeLibs` and (right-click) mark it as _Execute After Make_.

### The release process

FitNesse releases are created using https://github.com/fitnesse/fitnesse-release