cuke_modeler 0.2.0 → 0.3.0

data/features/modeling/gherkin4/doc_string_output.feature

@@ -0,0 +1,72 @@
+@gherkin4
+Feature: Outputting doc string elements
+
+  The output of an element model is a representation of the element as it would
+  appear in gherkin.
+
+
+  Scenario: Output of an empty doc string
+    Given a doc string element based on the following gherkin:
+    """
+    \"\"\"
+    \"\"\"
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    \"\"\"
+    \"\"\"
+    """
+
+  Scenario: Output of a doc string without a content type
+    Given a doc string element based on the following gherkin:
+    """
+    \"\"\"
+    Some text
+      
+      some more text
+    
+    \"\"\"
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    \"\"\"
+    Some text
+      
+      some more text
+    
+    \"\"\"
+    """
+
+  Scenario: Output of a doc string with a content type
+    Given a doc string element based on the following gherkin:
+    """
+    \"\"\" the type
+    Some text
+      
+      some more text
+    
+    \"\"\"
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    \"\"\" the type
+    Some text
+      
+      some more text
+    
+    \"\"\"
+    """
+
+  Scenario: Output of a doc string with a triple quotes in its contents
+
+  Since triple quotes mark the beginning and end of a doc string, any triple
+  quotes inside of the doc string (which would have had to have been escaped
+  to get inside in the first place) will be escaped when outputted so as to
+  retain the quality of being able to use the output directly as gherkin.
+
+    Given a doc string element based on the string """" the type\n* a step\n  \"\"\"\n  that also has a doc string\n  \"\"\"\n""""
+    When it is outputted
+    Then the text provided is """" the type\n* a step\n  \"\"\"\n  that also has a doc string\n  \"\"\"\n""""

data/features/modeling/gherkin4/example_modeling.feature

@@ -0,0 +1,100 @@
+@gherkin4
+Feature: Example elements can be modeled.
+
+
+  Acceptance criteria
+
+  1. All conceptual pieces of an example block can be modeled:
+  - the example's name
+  - the example's description
+  - the example's parameters
+  - the example's rows
+  - the example's tags
+  - the example's applied tags
+  - the example's source line
+  - the example's raw element
+
+  2. Example blocks can be outputted in a convenient form
+
+
+  Background: Test file setup.
+    Given the following feature file:
+    """
+    @a_feature_level_tag
+    Feature:
+
+      @outline_tag
+      Scenario Outline:
+        * a step
+
+      Examples: text describing the significance of the examples
+
+        Some example description.
+
+      Some more.
+          Even more.
+        |param1| param2 | extra param |
+        |x     | y      |      ?      |
+        |1     | 2      |      3      |
+      @example_tag @another_one
+      Examples: some examples with different significance and a tag
+        | param1 |
+        | a      |
+    """
+    And parameter delimiters of "*" and "*"
+    When the file is read
+
+
+  Scenario: The raw example element is modeled.
+    Then the test example block correctly stores its underlying implementation
+
+  Scenario: The example's source line is modeled.
+    Then the test example block "1" is found to have the following properties:
+      | source_line | 8 |
+    And the test example block "2" is found to have the following properties:
+      | source_line | 18 |
+
+  Scenario: The examples' name is modeled.
+    Then the test example block "1" is found to have the following properties:
+      | name | text describing the significance of the examples |
+    And the test example block "2" is found to have the following properties:
+      | name | some examples with different significance and a tag |
+
+  Scenario: The examples' description is modeled.
+    Then the test example block "1" has the following description:
+      """
+          Some example description.
+  
+        Some more.
+            Even more.
+      """
+    And the test example block "2" has no description
+
+  Scenario: The examples' tags are modeled.
+    Then the test example block "1" has no tags
+    And the test example block "2" is found to have the following tags:
+      | @example_tag |
+      | @another_one |
+
+  Scenario: The examples' applied tags are modeled.
+    Then the test example block "2" is found to have the following applied tags:
+      | @a_feature_level_tag |
+      | @outline_tag         |
+
+  Scenario: The examples' parameters are modeled.
+    Then the test example block "1" parameters are as follows:
+      | param1      |
+      | param2      |
+      | extra param |
+    And the test example block "2" parameters are as follows:
+      | param1 |
+
+  Scenario: The examples' rows are modeled.
+    Then the test example block "1" rows are as follows:
+      | x,y,? |
+      | 1,2,3 |
+    And the test example block "2" rows are as follows:
+      | a |
+
+  Scenario: Convenient output of an example block
+    Then the example block has convenient output

data/features/modeling/gherkin4/example_output.feature

@@ -0,0 +1,193 @@
+@gherkin4
+Feature: Outputting example elements
+
+  The output of an element model is a representation of the element as it would
+  appear in gherkin.
+
+
+  Scenario: Output of an example that does not have a name
+    Given an example element based on the following gherkin:
+    """
+    Examples:
+    |param|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Examples:
+      | param |
+    """
+
+  Scenario: Output of an example that does have a name
+    Given an example element based on the following gherkin:
+    """
+    Examples: with a name
+    |param|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Examples: with a name
+      | param |
+    """
+
+  Scenario: Output of an example that does not have tags
+    Given an example element based on the following gherkin:
+    """
+    Examples:
+    |param|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Examples:
+      | param |
+    """
+
+  Scenario: Output of an example that does have tags
+    Given an example element based on the following gherkin:
+    """
+    @tag1@tag2
+    @tag3
+    Examples:
+    |param|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    @tag1 @tag2 @tag3
+    Examples:
+      | param |
+    """
+
+  Scenario: Output of an example that has a description, no first line buffer
+    Given an example element based on the following gherkin:
+    """
+    Examples:
+    Some description.
+    Some more description.
+    |param|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Examples:
+      
+      Some description.
+      Some more description.
+
+      | param |
+    """
+
+  Scenario: Output of an example that has a description, first line is blank
+    Given an example element based on the following gherkin:
+    """
+    Examples:
+
+    Some description.
+    Some more description.
+    |param|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Examples:
+      
+      Some description.
+      Some more description.
+
+      | param |
+    """
+
+  Scenario: Output of an example that has a description, first line is only whitespace
+    Given an example element based on the following gherkin:
+    """
+    Examples:
+       
+    Some description.
+    Some more description.
+    |param|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Examples:
+      
+      Some description.
+      Some more description.
+
+      | param |
+    """
+
+  Scenario: Output of an example that has one rows
+    Given an example element based on the following gherkin:
+    """
+    Examples:
+    |param1|param2|
+    |value1|value2|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Examples:
+      | param1 | param2 |
+      | value1 | value2 |
+    """
+
+  Scenario: Output of an example that has multiple rows
+    Given an example element based on the following gherkin:
+    """
+    Examples:
+    |param1|param2|
+    |value1|value2|
+    |value3|value4|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Examples:
+      | param1 | param2 |
+      | value1 | value2 |
+      | value3 | value4 |
+    """
+
+  Scenario: Output of an example that contains all possible parts
+    Given an example element based on the following gherkin:
+    """
+    @tag1@tag2
+    @tag3
+    Examples: with a name
+    Some description.
+    Some more description.
+    |param1|param2|
+    |value1|value2|
+    |value3|value4|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    @tag1 @tag2 @tag3
+    Examples: with a name
+      
+      Some description.
+      Some more description.
+
+      | param1 | param2 |
+      | value1 | value2 |
+      | value3 | value4 |
+    """
+
+  Scenario: Whitespace buffers are based on the longest value or parameter in a column
+    Given an example element based on the following gherkin:
+    """
+    Examples:
+    |parameter_name|x|
+    |y|value_name|
+    """
+    When it is outputted
+    Then the following text is provided:
+    """
+    Examples:
+      | parameter_name | x          |
+      | y              | value_name |
+    """

data/features/modeling/gherkin4/feature_file_modeling.feature

@@ -0,0 +1,54 @@
+@gherkin4
+Feature: Feature files can be modeled.
+
+
+  Acceptance criteria
+
+  1. All conceptual pieces of a .feature file can be modeled:
+  - the file's name
+  - the file's full path
+  - the file's features (one or zero per file)
+
+  2. Feature files can be outputted in a convenient form
+
+
+  Background: Test file setup.
+    Given the following feature file "test_file_1.feature":
+    """
+    Feature: The first test feature
+      Just a dummy feature.
+    """
+    And the following feature file "test_file_2.feature":
+    """
+    Feature: The second test feature
+      Just a dummy feature.
+    """
+    And the following feature file "why_would_you_make_an_empty_file.feature":
+    """
+    """
+    When the file "test_file_1.feature" is read
+    And the file "test_file_2.feature" is read
+    And the file "why_would_you_make_an_empty_file.feature" is read
+
+
+  Scenario: The file's feature is modeled.
+    Then file "1" is found to have the following properties:
+      | name          | test_file_1.feature         |
+      | path          | path_to/test_file_1.feature |
+      | feature_count | 1                           |
+    And file "1" features are as follows:
+      | The first test feature |
+    Then file "2" is found to have the following properties:
+      | name          | test_file_2.feature         |
+      | path          | path_to/test_file_2.feature |
+      | feature_count | 1                           |
+    And file "2" features are as follows:
+      | The second test feature |
+    Then file "3" is found to have the following properties:
+      | name          | why_would_you_make_an_empty_file.feature         |
+      | path          | path_to/why_would_you_make_an_empty_file.feature |
+      | feature_count | 0                                                |
+    And file "3" has no features
+
+  Scenario: Convenient output of a feature file
+    Then the feature file has convenient output

data/features/modeling/gherkin4/feature_file_output.feature

@@ -0,0 +1,14 @@
+@gherkin4
+Feature: Outputting feature file elements
+
+  The output of an element model is a representation of the element as it would
+  appear in gherkin.
+
+
+  Scenario: Output of a feature file
+    Given a feature file element based on "some_feature_file.feature"
+    When it is outputted
+    Then the following text is provided:
+    """
+    path_to/some_feature_file.feature
+    """

data/features/modeling/gherkin4/feature_modeling.feature

@@ -0,0 +1,153 @@
+@gherkin4
+Feature: Features can be modeled.
+
+
+  Acceptance criteria
+
+  1. All conceptual pieces of a feature can be modeled:
+  -  the feature's name
+  -  the feature's description
+  -  the feature's tags
+  -  the feature's scenarios
+  -  the feature's outlines
+  -  the feature's background
+  -  the feature's total number of tests
+  -  the feature's total number of test cases
+  -  the feature's source line
+  - the feature's raw element
+
+  2. Features can be outputted in a convenient form
+
+
+  Background: Test file setup.
+    Given the following feature file "much_stuff.feature":
+    """
+    @a_feature_level_tag @and_another
+
+    Feature: The test feature name.
+          
+      Some feature description.
+
+    Some more.
+        And some more.
+
+      Background: Some general test setup stuff.
+        * some setup step
+
+      Scenario: The first scenario's name.
+      * a step
+
+      Scenario Outline: The scenario outline's name.
+        * a step
+      Examples:
+        | param |
+        | x     |
+        | y     |
+      Examples:
+        | param |
+        | z     |
+
+      Scenario: The second scenario's name.
+        * a step
+    """
+    And the following feature file "barely_any_stuff.feature":
+    """
+    Feature:
+
+      Background:
+
+      Scenario:
+
+      Scenario Outline:
+      Examples:
+    """
+    And the following feature file "as_empty_as_it_gets.feature":
+    """
+    Feature:
+    """
+    When the file "much_stuff.feature" is read
+    And the file "barely_any_stuff.feature" is read
+    And the file "as_empty_as_it_gets.feature" is read
+
+
+  Scenario: The raw feature element is modeled.
+    Then the feature correctly stores its underlying implementation
+
+  Scenario: The feature's properties are modeled.
+    Then feature "1" is found to have the following properties:
+      | name            | The test feature name. |
+      | test_count      | 3                      |
+      | test_case_count | 5                      |
+      | source_line     | 3                      |
+    And feature "2" is found to have the following properties:
+      | name            |   |
+      | test_count      | 2 |
+      | test_case_count | 1 |
+      | source_line     | 1 |
+
+    And feature "3" is found to have the following properties:
+      | name            |   |
+      | test_count      | 0 |
+      | test_case_count | 0 |
+      | source_line     | 1 |
+
+  Scenario: The feature's description is modeled.
+    Then feature "1" has the following description:
+      """
+        Some feature description.
+
+      Some more.
+          And some more.
+      """
+    And feature "2" has no description
+    And feature "3" has no description
+
+  Scenario: The feature's tags are modeled.
+    Then feature "1" is found to have the following tags:
+      | @a_feature_level_tag |
+      | @and_another         |
+    And feature "2" has no tags
+    And feature "3" has no tags
+
+  Scenario: The feature's scenarios are modeled.
+    Then feature "1" is found to have the following properties:
+      | scenario_count | 2 |
+    And feature "1" scenarios are as follows:
+      | The first scenario's name.  |
+      | The second scenario's name. |
+    And feature "2" is found to have the following properties:
+      | scenario_count | 1 |
+    And feature "2" scenarios are as follows:
+      |  |
+    And feature "3" is found to have the following properties:
+      | scenario_count | 0 |
+    And feature "3" has no scenarios
+
+  Scenario: The feature's outlines are modeled.
+    Then feature "1" is found to have the following properties:
+      | outline_count | 1 |
+    And feature "1" outlines are as follows:
+      | The scenario outline's name. |
+    And feature "2" is found to have the following properties:
+      | outline_count | 1 |
+    And feature "2" outlines are as follows:
+      |  |
+    And feature "3" is found to have the following properties:
+      | outline_count | 0 |
+    And feature "3" has no outlines
+
+  Scenario: The feature's background is modeled.
+    Then feature "1" is found to have the following properties:
+      | has_background? | true |
+    And feature "1" background is as follows:
+      | Some general test setup stuff. |
+    And feature "2" is found to have the following properties:
+      | has_background? | true |
+    And feature "2" background is as follows:
+      |  |
+    And feature "3" is found to have the following properties:
+      | has_background? | false |
+    And feature "3" has no background
+
+  Scenario: Convenient output of a feature
+    Then the feature has convenient output