CFE-3988: Fixed insert_lines ignoring include_end_delimiter when locating the region

cf-agent/files_editline.c

@@ -765,6 +765,13 @@ static PromiseResult VerifyLineInsertions(EvalContext *ctx, const Promise *pp, E
         return result;
     }
 
+    /* The region is half open, [begin_ptr, end_ptr), so including the end
+     * delimiter means moving the bound past it -- after the NULL check above. */
+    if (a.region.include_end != 0 && end_ptr != NULL)
+    {
+        end_ptr = end_ptr->next;
+    }
+
     if (allow_multi_lines)
     {
         // promise to insert duplicates on first pass only

tests/acceptance/31_tickets/CFE-3988/1/test.cf

@@ -25,10 +25,6 @@ bundle agent test
       string => "edit_line should insert after the last matched line when selecting a region where the end delimiter is included",
       meta => { "CFE-3988" };
 
-    "test_soft_fail"
-      string => "any",
-      meta => { "CFE-3988" };
-
   vars:
     "seed_file" string => "$(this.promise_dirname)/before_test.xml.txt";
     "test_file" string => "$(G.testfile)";

tests/acceptance/31_tickets/CFE-3988/2/before_test.xml.txt

@@ -0,0 +1,49 @@
+<?xml version="1.0"?>
+      <web-app xmlns="http://java.sun.com/xml/ns/javaee"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
+      http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
+      version="3.0"
+      metadata-complete="true">
+      <!-- General -->
+      <display-name>Atlassian JIRA Web Application</display-name>
+      <description>The Atlassian JIRA web application - see http://www.atlassian.com/software/jira for more information
+      </description>
+
+      <absolute-ordering />
+
+      <!-- Filters -->
+
+      <!-- Special filters that must come at the beginning of the chain because they prevent
+      all other filters from running.  This is to prevent those later filters from doing
+      lookups in Pico, which could alter the order in which it instantiates components
+      and thereby trigger a deadlock. -->
+
+      <filter>
+      <filter-name>JiraImportProgressFilter</filter-name>
+      <filter-class>com.atlassian.jira.web.filters.JiraImportProgressFilter</filter-class>
+      </filter>
+
+      <!-- ========================================================
+           THIS MUST BE THE FIRST FILTER IN THE NORMAL FILTER CHAIN
+           ======================================================== -->
+
+      <filter>
+      <filter-name>JiraFirstFilter</filter-name>
+      <filter-class>com.atlassian.jira.web.filters.JiraFirstFilter</filter-class>
+      </filter>
+
+      <!-- =====================================================
+           THIS MUST BE THE LAST FILTER IN THE DEFINED CHAIN
+           ===================================================== -->
+
+      <filter>
+      <filter-name>JiraLastFilter</filter-name>
+      <filter-class>com.atlassian.jira.web.filters.JiraLastFilter</filter-class>
+      </filter>
+
+      <!-- =====================================================
+           FILTER MAPPINGS FOLLOW :
+           ===================================================== -->
+
+</web-app>

tests/acceptance/31_tickets/CFE-3988/2/test.cf

@@ -0,0 +1,78 @@
+body file control
+{
+  inputs => { "../../../default.sub.cf" };
+}
+
+bundle agent __main__
+# If this is the policy entry (cf-agent --file) then this bundle will be run by default.
+{
+  methods:
+    "bundlesequence" usebundle => default("$(this.promise_filename)");
+}
+
+bundle agent init
+{
+  files:
+    # Seed the file we will exercise the test on
+    "$(G.testfile)"
+      copy_from => local_dcp("$(this.promise_dirname)/before_test.xml.txt");
+}
+
+bundle agent test
+{
+  meta:
+    "description"
+      string => "edit_line should insert before the end delimiter when the end delimiter is not included in the region",
+      meta => { "CFE-3988" };
+
+  vars:
+    "seed_file" string => "$(this.promise_dirname)/before_test.xml.txt";
+    "test_file" string => "$(G.testfile)";
+
+  files:
+    "$(test_file)" edit_line => CFE_3988_excluded_end;
+}
+
+bundle agent check
+# @brief Companion to case 1. With include_end_delimiter left at its default of
+# false the end delimiter is not part of the region, so the last matching line
+# is the one before it and the insertion must land above the delimiter.
+{
+  methods:
+    # We expect to find lines that look something like this:
+    #      THIS MUST BE THE LAST FILTER IN THE DEFINED CHAIN
+    #INSERT ME
+    #      ===================================================== -->
+    "Pass/FAIL"
+      usebundle => dcs_check_regcmp(
+        ".*\s+THIS MUST BE THE LAST FILTER IN THE DEFINED CHAIN\RINSERT\sME\R\s+=+\s+-->.*",
+        readfile("$(test.test_file)"),
+        $(this.promise_filename),
+        "no"
+      );
+}
+
+bundle edit_line CFE_3988_excluded_end
+{
+  insert_lines:
+    "INSERT ME"
+      select_region => my_comment_last_filter_excluded_end,
+      location => my_location_after_comment_last_filter;
+}
+
+body location my_location_after_comment_last_filter
+# @brief Editing occurs after the last line in the selected region
+{
+  before_after => "after";
+  first_last => "last";
+  select_line_matching => ".*";
+}
+
+body select_region my_comment_last_filter_excluded_end
+{
+  select_start => "\s+THIS MUST BE THE LAST FILTER IN THE DEFINED CHAIN";
+  select_end => "\s+=+\s+-->";
+  include_start_delimiter => "true";
+  include_end_delimiter => "false";
+  select_end_match_eof => "false";
+}