https://github.com/andyw8/cuki

Pulls acceptance criteria from a Confluence wiki into Cucumber feature files to keep them in sync
https://github.com/andyw8/cuki

Last synced: about 1 month ago
JSON representation

Pulls acceptance criteria from a Confluence wiki into Cucumber feature files to keep them in sync

• Host: GitHub
• URL: https://github.com/andyw8/cuki
• Owner: andyw8
• License: mit
• Created: 2011-10-12T15:03:53.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2011-10-25T22:19:40.000Z (over 13 years ago)
• Last Synced: 2024-04-27T08:23:11.814Z (about 1 year ago)
• Language: Ruby
• Homepage:
• Size: 180 KB
• Stars: 6
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
= Overview

Cuki provides an easy way to import acceptance criteria from a Confluence wiki into Cucumber feature files. It can be used as part of a CI process or just for ad-hoc imports.

== Installation

    gem install cuki

(or use Bundler)

== Setup

Cuki expects a configuration file in config/cuki.yml. See the sample provided.

A single Confluence page maps to one or more features. The page should contain the structure:

    h1. Acceptance Criteria

    h2. Feature Name

    Scenario: ...

    h2. Another Feature Name

    Scenario: ...

== Usage

    

Run it from the command line:

    cuki pull

    

You can also pull from a particular Confluence page:

    cuki pull features/products

== Tags

You can add tags to a feature based on the wiki page markup. See the sample configuration file.

== Options

- --skip--autoformat to avoid reformatting features (runs over the whole features directory)

== Configuration

If your Confluence installation requires a client certificate, you can supply the paths for these as environment variables:

    CER=/path/to/ca.pem.cer PEM=/path/to/something.pem cuki pull

== Known Issues and Limitations

- Will only work with Confluence setups which have no password, or use client certificates for authentication

- Expects a two level hierarchy, with folders used for epics/themes, containing one or more feature files

== Bugs and To Do

- Should exit before importing features if the current features aren't valid syntax

== Future Plans

- Add roundtrip editing, i.e. edit a file locally and push it to Confluence

- Some way to update the wiki to indicate which scenarios are passing, failing or not yet implemented

== Copyright

Copyright (c) 2011 Andy Waite. See LICENSE.txt for

further details.