defmastership 1.0.6 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd7a521f197f1ab374863af89ab7a24c50bc27d5dfef6161bc47e8fff27825f
-  data.tar.gz: a92ef2ee968e39a48e20fbf2a7d6f3040393c727a422e4f39c935978a29e187f
+  metadata.gz: a3085b336c6d1b3854964192456e63b586bb0841ca62be7a4e33b7a3f7e2b5e9
+  data.tar.gz: 190eb91c0e040f064044a9b720eeb737cf3a0064eb88c718f1f2f387d0edf47f
 SHA512:
-  metadata.gz: ee7d58f8392a43fe5b45e234f9c4965037e2864a37a669c191d33b58016cf7094a99fe29443c3fc60678bab3e591b19188579771d14aa762fba8d4b34b01bd89
-  data.tar.gz: 526ae0002d2f5d66f2ad555d09bc8cf9786b567098e6bc071a8b119b2cbfe6b664e84eaf3fc68e453ca16f41552a4004f23bab6323ed62cba526322f27e88b15
+  metadata.gz: f8c55be957d580ad9ab71f15f58be76a43fc3e2b169d7b8397383a1a6a128c93aac5c33eab85cdf3da584d005eb92699730f2ae3560947ad25f13e478f5bff1d
+  data.tar.gz: 8d7b95ad1db59a90e96f0caacc8040307366ae7be67baab172fe57f64c9101a065fef8718d8c2f123d03c808b1669aa406c05712872c05424b6de22150db6acf

data/bin/defmastership

@@ -2,7 +2,6 @@
 # Copyright (c) 2020 Jerome Arbez-Gindre
 # frozen_string_literal: true
 
-require('asciidoctor')
 require('csv')
 require('defmastership')
 require('gli')
@@ -52,18 +51,24 @@ module DefMastership
     arg_name 'asciidoctor_files'
     command :export, :exp, :e do |c|
       c.flag(%i[separator sep s], default_value: ',', desc: 'CSV separator')
+      c.switch(%i[no-fail], desc: 'Exit succes even in case of wrong explicit checksum')
+
       c.action do |_global_options, options, args|
-        doc = Asciidoctor.load_file(args[0], safe: :unsafe, parse: false)
-        # FIXME: also escape ifdef, ifndef, ifeval and endif directives
-        # FIXME: do this more carefully by reading line by line; if input
-        # differs by output by leading backslash, restore original line
-        lines = doc.reader.read_lines
         my_doc = DefMastership::Document.new
-        my_doc.parse(lines)
+        my_doc.parse_file_with_preprocessor(args[0])
 
         output_file = args[0].sub(/\.adoc$/, '.csv')
 
         DefMastership::CSVFormatter.new(my_doc, options['separator']).export_to(output_file)
+
+        if my_doc.wrong_explicit_checksum?
+          my_doc.definitions.each do |definition|
+            next if definition.wrong_explicit_checksum.nil?
+
+            warn("warning: #{definition.reference} has a wrong explicit checksum (should be #{definition.sha256})")
+          end
+          exit 1 unless options[:"no-fail"]
+        end
       end
     end
 

data/features/changeref.feature

@@ -36,6 +36,39 @@ Feature: The changeref command
     [define, requirement, TOTO-0123]
     """
 
+  Scenario: Change a definition with explicit checksum and version
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 123
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(a~12345678)]
+    """
+    When I successfully run `defmastership modify --modifications toto thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "modifications.yml" should contain:
+    """
+    ---
+    :toto:
+      :type: change_ref
+      :config:
+        :from_regexp: TOTO-TEMP-[X\d]{4}
+        :to_template: TOTO-%<next_ref>04d
+        :next_ref: 124
+    """
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0123(a~12345678)]
+    """
+
   Scenario: Change two definitions
     Given a file named "modifications.yml" with:
     """

data/features/definition_checksum.feature

@@ -0,0 +1,298 @@
+Feature: definition checksum 
+  As a Responsible of definitions for a given document
+  In order to detect modifications of defintiions
+  I want defmastership to export and update checksum in definitions
+
+  Scenario: Extract one definition with WRONG explicit checksum to CSV 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(~babe1234)]
+    def one
+    """
+    When I run `defmastership export thedoc.adoc`
+    Then it should fail with:
+    """
+    warning: TOTO-0001 has a wrong explicit checksum (should be ~d27cb5c3)
+    """
+    And the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Wrong explicit checksum
+    requirement,TOTO-0001,def one,~d27cb5c3,~babe1234
+    """
+    And the stdout should not contain anything
+
+  Scenario: Extract two definitions with one WRONG explicit checksum to CSV 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(~d27cb5c3)]
+    def one
+
+    [define, requirement, TOTO-0002(~babe1234)]
+    def two
+    """
+    When I run `defmastership export thedoc.adoc`
+    Then it should fail with:
+    """
+    warning: TOTO-0002 has a wrong explicit checksum (should be ~b80e1be5)
+    """
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Wrong explicit checksum
+    requirement,TOTO-0001,def one,~d27cb5c3,\"\"
+    requirement,TOTO-0002,def two,~b80e1be5,~babe1234
+    """
+    And the stdout should not contain anything
+
+  Scenario: Export not failing even if WRONG explicit checksum 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(~d27cb5c3)]
+    def one
+
+    [define, requirement, TOTO-0002(~babe1234)]
+    def two
+    """
+    When I successfully run `defmastership export --no-fail thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Wrong explicit checksum
+    requirement,TOTO-0001,def one,~d27cb5c3,\"\"
+    requirement,TOTO-0002,def two,~b80e1be5,~babe1234
+    """
+    And the stdout should not contain anything
+    And the stderr should contain:
+    """
+    warning: TOTO-0002 has a wrong explicit checksum (should be ~b80e1be5)
+    """
+
+  Scenario: Extract one definition with explicit checksum to CSV 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(~b86dcbde)]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.",~b86dcbde
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Change one modifier
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(~244eed18)]
+    --
+    the requirement value.
+    --
+    """
+
+  Scenario: Change one modifier with already set checksum
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(~abcd1234)]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(~244eed18)]
+    --
+    the requirement value.
+    --
+    """
+
+  Scenario: Checksum is calculated on included file for export
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    include::included.txt[]
+    --
+    """
+    And a file named "included.txt" with:
+    """
+    Exemple of multiline requirement.
+    Second line.
+    """
+    When I successfully run `defmastership export thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.",~b86dcbde
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Checksum is calculated on included file in ref modification
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    include::included.txt[]
+    --
+    """
+    And a file named "included.txt" with:
+    """
+    Exemple of multiline requirement.
+    Second line.
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(~b86dcbde)]
+    --
+    include::included.txt[]
+    --
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Checksum take into account variables in CSV export
+    Given a file named "thedoc.adoc" with:
+    """
+    :variable: multiline
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of {variable} requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.",~b86dcbde
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Checksum take into account variables in ref modification
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    :variable: multiline
+    [define, requirement, TOTO-0001]
+    --
+    Exemple of {variable} requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(~b86dcbde)]
+    --
+    Exemple of {variable} requirement.
+    Second line.
+    --
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Checksum keep explicit version in ref modification
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto~abcd1234)]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto~244eed18)]
+    --
+    the requirement value.
+    --
+    """
+
+  Scenario: Checksum keep explicit version in ref setting
+    Given a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_checksum:
+      :type: update_def_checksum
+      :config:
+        :def_type: requirement
+    """
+    And a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto)]
+    --
+    the requirement value.
+    --
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_checksum thedoc.adoc`
+    Then the stdout should not contain anything
+    And the stderr should not contain anything
+    And the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-TEMP-XXX1(toto~244eed18)]
+    --
+    the requirement value.
+    --
+    """

data/features/definition_version.feature

@@ -0,0 +1,204 @@
+Feature: definitions version 
+  As a Responsible of definitions for a given document 
+  In order to detect handle versions definitions
+  I want defmastership to export explicit versions in definitions
+
+  Scenario: Extract one definition with explicit version to CSV 
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(pouet)]
+    --
+    Exemple of multiline requirement.
+    Second line.
+    --
+    """
+    When I successfully run `defmastership export thedoc.adoc`
+    Then the file "thedoc.csv" should contain:
+    """
+    Type,Reference,Value,Checksum,Version
+    requirement,TOTO-0001,"Exemple of multiline requirement.
+    Second line.",~b86dcbde,pouet
+    """
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+
+  Scenario: Set initial explicit version when definition has changed 
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a)]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: Do not set initial explicit version when definition has NOT changed 
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    initial text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+
+  Scenario: Set initial explicit version when definition has changed and ref is not an initial version
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(3)]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: 1
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(4)]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: No initial explicit version when definition is new
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0002]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: 1
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    modified text.
+    --
+    """
+
+  Scenario: update explicit version whith explicit checksum
+    Given a file named "ref_doc.adoc" with:
+    """
+    [define, requirement, TOTO-0001]
+    --
+    initial text.
+    --
+    """
+    Given a file named "thedoc.adoc" with:
+    """
+    [define, requirement, TOTO-0001(whatever~abcd1234)]
+    --
+    modified text.
+    --
+    """
+    And a file named "modifications.yml" with:
+    """
+    ---
+    :update_requirement_version:
+      :type: update_def_version
+      :config:
+        :def_type: requirement
+        :first_version: a
+        :ref_document: ./ref_doc.adoc
+    """
+    When I successfully run `defmastership modify --modifications update_requirement_version thedoc.adoc`
+    And the stdout should not contain anything
+    And the stderr should not contain anything
+    Then the file "thedoc.adoc" should contain:
+    """
+    [define, requirement, TOTO-0001(a~abcd1234)]
+    --
+    modified text.
+    --
+    """
+