first commit

cbliard · cbliard · commit abf6bd87605a · 2020-12-15T16:48:03.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,13 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependency directory
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# cucumber result output file
+messages.ndjson
diff --git a/.tool-versions b/.tool-versions
@@ -0,0 +1 @@
+nodejs 12.19.1
diff --git a/README.md b/README.md
@@ -0,0 +1,62 @@
+# Coffee Machine
+
+This is an example repository with some Gherkin feature files.
+
+Imagine we have built a coffee machine for our office, with automated tests using Cucumber.
+
+
+## Expose on CucumberStudio
+
+You can use [CucumberStudio](https://cucumber.io/tools/cucumberstudio/) "BDD with Cucumber project" to expose the features of this repository and their execution:
+
+1. Display the feature files from this repository in CucumberStudio
+    - Fork this repository in a place you own in your favorite git service
+    - In CucumberStudio, create a new "BDD with Cucumber" project
+    - Connect the repository you have forked
+    - You now have your features nicely exposed on CucumberStudio
+
+      Congrats! 🎉
+
+2. Push execution results to CucumberStudio
+    - Ensure you have nodejs and npm installed
+    - Run `npm install` to install the libraries (which includes [cucumber-js](https://github.com/cucumber/cucumber-js))
+    - Execute the feature files with Cucumber by running `node_modules/.bin/cucumber-js`. All test pass.
+
+    - Generate results in a format that CucumberStudio understands
+
+      When the features are executed the results must be stored in a file. This file must be in `message` format. Not `junit xml` or `json`.
+
+      The command line option `--format=message:messages.ndjson` will output execution results in the `message` format, and store them in the file `messages.ndjson`. This is the final command to run:
+
+          node_modules/.bin/cucumber-js --format=message:messages.ndjson
+
+      Note: you can also run `npm run test` which does the same, as defined in `package.json`.
+
+    - Push the results to CucumberStudio
+
+      In CucumberStudio, in the settings there is the command line to use to push results. This command line looks something like this:
+
+          curl -X POST \
+            https://studio.cucumber.io/cucumber_project/results \
+            -F messages=@<path to your result file> \
+            -H "project-access-token: <your-project-access-token>" \
+            -H "provider: github" \
+            -H "repo: <repository_name>" \
+            -H "branch: main" \
+            -H "revision: <commit_hash>"
+
+      This command is defined in `package.json` as a script. Run `npm run push-results` to run it. You will need to define some environment variables to properly fill in the necessary information:
+        - `PROJECT_ACCESS_TOKEN`: the unique access token relative to your project
+        - `REPOSITORY_NAME`: the repository name, like `cucumber/coffee-machine-javascript`
+        - `COMMIT_HASH`: the git commit hash referring the version actually tested
+
+      Command is:
+
+          export PROJECT_ACCESS_TOKEN=abcd1234
+          export REPOSITORY_NAME=yourGitHubName/coffee-machine-javascript
+          export COMMIT_HASH=$(git rev-parse HEAD)
+          npm run push-results
+
+    - You should see the results being displayed in CucumberStudio.
+
+      Congrats! 🎉
diff --git a/features/Bad_usage.feature b/features/Bad_usage.feature
@@ -0,0 +1,12 @@
+Feature: Bad usage
+    As a lazy coffee user
+    I can ignore the message displayed by the machine
+    So I can have coffee and let other people have to clean after me
+
+  Scenario: Full grounds does not block coffee
+    # You keep getting coffee even if the "Empty grounds" message is displayed. That said it's not a fantastic idea, you'll get ground everywhere when you'll decide to empty it.
+    Given the coffee machine is started
+    And I handle everything except the grounds
+    When I take "50" coffees
+    Then message "Empty grounds" should be displayed
+    And coffee should be served
diff --git a/features/Can_be_configured.feature b/features/Can_be_configured.feature
@@ -0,0 +1,21 @@
+Feature: Can be configured
+    As this is a high quality product
+    It is possible to configure it
+    In order to get the best possible coffees
+
+  Scenario: Display settings
+    Given the coffee machine is started
+    When I switch to settings mode
+    Then displayed message is:
+      """
+      Settings:
+       - 1: water hardness
+       - 2: grinder
+      """
+
+  Scenario: Default settings
+    Given the coffee machine is started
+    When I switch to settings mode
+    Then settings should be:
+      | water hardness | 2      |
+      | grinder        | medium |
diff --git a/features/Display_errors/Beans.feature b/features/Display_errors/Beans.feature
@@ -0,0 +1,24 @@
+Feature: Beans
+    As a coffee lover
+    I have to put fresh beans from time to time
+    So I can have coffee when I need it
+
+  Background:
+    Given the coffee machine is started
+    And I handle everything except the beans
+
+  Scenario: Message "Fill beans" is displayed after 38 coffees are taken
+    When I take "38" coffees
+    Then message "Fill beans" should be displayed
+
+  Scenario: It is possible to take 40 coffees before there is really no more beans
+    Given I take "40" coffees
+    Then coffee should be served
+    When I take a coffee
+    Then coffee should not be served
+    And message "Fill beans" should be displayed
+
+  Scenario: After adding beans, the message "Fill beans" disappears
+    Given I take "40" coffees
+    When I fill the beans tank
+    Then message "Ready" should be displayed
diff --git a/features/Display_errors/Grounds.feature b/features/Display_errors/Grounds.feature
@@ -0,0 +1,17 @@
+Feature: Grounds
+    As a coffee lover
+    I have to empty the grounds
+    So I don't end up with a total mess around the coffee machine
+
+  Background:
+    Given the coffee machine is started
+    And I handle everything except the grounds
+
+  Scenario: Message "Empty grounds" is displayed after 30 coffees are taken
+    When I take "30" coffees
+    Then message "Empty grounds" should be displayed
+
+  Scenario: When the grounds are emptied, message is removed
+    Given I take "30" coffees
+    When I empty the coffee grounds
+    Then message "Ready" should be displayed
diff --git a/features/Display_errors/Water.feature b/features/Display_errors/Water.feature
@@ -0,0 +1,23 @@
+Feature: Water
+    As a coffee lover
+    I have to handle the water tank
+    So I can have coffee when I need it
+
+  Background:
+    Given the coffee machine is started
+    And I handle everything except the water tank
+
+  Scenario: Message "Fill water tank" is displayed after 50 coffees are taken
+    When I take "50" coffees
+    Then message "Fill tank" should be displayed
+
+  Scenario: It is possible to take 10 coffees after the message "Fill water tank" is displayed
+    Given I take "60" coffees
+    Then coffee should be served
+    When I take a coffee
+    Then coffee should not be served
+
+  Scenario: When the water tank is filled, the message disappears
+    Given I take "55" coffees
+    When I fill the water tank
+    Then message "Ready" should be displayed
diff --git a/features/EatingCucumbersdddfv.feature b/features/EatingCucumbersdddfv.feature
@@ -0,0 +1 @@
+Feature: Eating cucumbersdddfv
diff --git a/features/Serve_coffee.feature b/features/Serve_coffee.feature
@@ -0,0 +1,10 @@
+Feature: Serve coffee
+    As a coffee lover
+    I can get coffee from the machine
+    So I can enjoy the rest of the day
+
+  Scenario: Simple use
+    # Well, sometimes, you just get a coffee.
+    Given the coffee machine is started
+    When I take a coffee
+    Then coffee should be served
diff --git a/features/Support_internationalisation.feature b/features/Support_internationalisation.feature
@@ -0,0 +1,19 @@
+Feature: Support internationalisation
+    As a polyglot coffee lover
+    I can select the language on the coffee machine
+    So I can practice my use of greetings in several languages
+
+  Scenario: No messages are displayed when machine is shut down
+    Given the coffee machine is started
+    When I shutdown the coffee machine
+    Then message "" should be displayed
+
+  Scenario Outline: Messages are based on language
+    # Well, sometimes, you just get a coffee.
+    When I start the coffee machine using language "<language>"
+    Then message "<ready_message>" should be displayed
+
+    Examples:
+      | language | ready_message | hiptest-uid |
+      | en | Ready |  |
+      | fr | Pret |  |
diff --git a/features/step_definitions.js b/features/step_definitions.js
@@ -0,0 +1,128 @@
+const { Before, Given, When, Then } = require('@cucumber/cucumber');
+const assert = require('assert');
+
+Before(function (scenario) {
+    this.coffeeMachine = require('../src/coffee_machine.js').CoffeeMachine();
+    this.handledTanks = []
+});
+
+When(/^I start the coffee machine using language "(.*)"$/, function (lang, callback) {
+    this.coffeeMachine.start(lang);
+    callback();
+});
+
+When(/^I shutdown the coffee machine$/, function (callback) {
+    this.coffeeMachine.stop();
+    callback();
+});
+
+Then(/^message "(.*)" should be displayed$/, function (message, callback) {
+    assert.equal(message || "", this.coffeeMachine.get('message'));
+    callback();
+});
+
+Then(/^coffee should be served$/, function (callback) {
+    assert.equal(true, this.coffeeMachine.get('coffeeServed'));
+    callback();
+});
+
+Then(/^coffee should not be served$/, function (callback) {
+    assert.equal(false, this.coffeeMachine.get('coffeeServed'));
+    callback();
+});
+
+When(/^I take a coffee$/, function (callback) {
+    this.coffeeMachine.takeCoffee();
+    callback();
+});
+
+When(/^I empty the coffee grounds$/, function (callback) {
+    this.coffeeMachine.emptyGrounds();
+    callback();
+});
+
+When(/^I fill the beans tank$/, function (callback) {
+    this.coffeeMachine.fillBeans();
+    callback();
+});
+
+When(/^I fill the water tank$/, function (callback) {
+    this.coffeeMachine.fillTank();
+    callback();
+});
+
+Given(/^I take "(.*)" coffees$/, function (coffee_number, callback) {
+    while ((coffee_number > 0)) {
+        this.coffeeMachine.takeCoffee();
+        coffee_number = coffee_number - 1;
+
+        if (this.handledTanks.indexOf('water') >= 0) {
+            this.coffeeMachine.fillTank();
+        }
+
+        if (this.handledTanks.indexOf('beans') >= 0) {
+            this.coffeeMachine.fillBeans();
+        }
+
+        if (this.handledTanks.indexOf('grounds') >= 0) {
+            this.coffeeMachine.emptyGrounds();
+        }
+    }
+    callback();
+});
+
+Given(/^the coffee machine is started$/, function (callback) {
+    this.coffeeMachine.start();
+    callback();
+});
+
+Given(/^I handle water tank$/, function (callback) {
+    this.handledTanks.push('water');
+    callback();
+});
+
+Given(/^I handle beans$/, function (callback) {
+    this.handledTanks.push('beans');
+    callback();
+});
+
+Given(/^I handle coffee grounds$/, function (callback) {
+    this.handledTanks.push('grounds');
+    callback();
+});
+
+Given(/^I handle everything except the water tank$/, function (callback) {
+    this.handledTanks.push('beans');
+    this.handledTanks.push('grounds');
+    callback();
+});
+
+Given(/^I handle everything except the beans$/, function (callback) {
+    this.handledTanks.push('water');
+    this.handledTanks.push('grounds');
+    callback();
+});
+
+Given(/^I handle everything except the grounds$/, function (callback) {
+    this.handledTanks.push('beans');
+    this.handledTanks.push('water');
+    callback();
+});
+
+Then(/^displayed message is:$/, function (__free_text, callback) {
+    assert.equal(__free_text || "", this.coffeeMachine.get('message'));
+    callback();
+});
+
+When(/^I switch to settings mode$/, function (callback) {
+    this.coffeeMachine.showSettings();
+    callback();
+});
+
+Then(/^settings should be:$/, function (__datatable, callback) {
+    const hashSettings = this.coffeeMachine.getSettings();
+    const settings = Object.keys(hashSettings).map(key => [key, hashSettings[key]]);
+
+    assert.deepEqual(__datatable.raw(), settings);
+    callback();
+});
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/script/push_results b/script/push_results
diff --git a/src/coffee_machine.js b/src/coffee_machine.js
