From d7f47f262799b285080cb08830560891c532a5a1 Mon Sep 17 00:00:00 2001
From: nirajsingh <niraj.singh@nttdata.com>
Date: Tue, 12 Jun 2018 09:54:17 +0530
Subject: [PATCH] Allow segment description to be multiline

This patch allows user to pass a multiline description for
a failover segment.

Closes-Bug: #1776385
Change-Id: I25afb76aec10a507312b8d99b0c882ca9f6bcd81
---
 masakari/api/validation/parameter_types.py        |  2 +-
 .../tests/unit/api/openstack/ha/test_segments.py  | 15 +++++++++++++++
 .../notes/bug-1776385-0bcf0a0b3fad359e.yaml       |  5 +++++
 3 files changed, 21 insertions(+), 1 deletion(-)
 create mode 100644 releasenotes/notes/bug-1776385-0bcf0a0b3fad359e.yaml

diff --git a/masakari/api/validation/parameter_types.py b/masakari/api/validation/parameter_types.py
index b455f3dc..73ee8a39 100644
--- a/masakari/api/validation/parameter_types.py
+++ b/masakari/api/validation/parameter_types.py
@@ -116,7 +116,7 @@ def _build_regex_range(ws=True, invert=False, exclude=None):
     return regex
 
 
-valid_description_regex_base = '^[%s]*$'
+valid_description_regex_base = '^[\n%s]*$'
 
 valid_name_regex_base = '^(?![%s])[%s]*(?<![%s])$'
 
diff --git a/masakari/tests/unit/api/openstack/ha/test_segments.py b/masakari/tests/unit/api/openstack/ha/test_segments.py
index 9a251226..767ee9d6 100644
--- a/masakari/tests/unit/api/openstack/ha/test_segments.py
+++ b/masakari/tests/unit/api/openstack/ha/test_segments.py
@@ -130,6 +130,21 @@ class FailoverSegmentTestCase(test.TestCase):
         result = result['segment']
         self._assert_segment_data(FAILOVER_SEGMENT, _make_segment_obj(result))
 
+    @mock.patch.object(ha_api.FailoverSegmentAPI, 'create_segment')
+    def test_create_with_multiline_description(self, mock_create):
+        body = {
+            "segment": {
+                "name": "segment1",
+                "service_type": "COMPUTE",
+                "recovery_method": "auto",
+                "description": "failover_segment\nfor\ncompute"
+            }
+        }
+        mock_create.return_value = FAILOVER_SEGMENT
+        result = self.controller.create(self.req, body=body)
+        result = result['segment']
+        self._assert_segment_data(FAILOVER_SEGMENT, _make_segment_obj(result))
+
     @mock.patch.object(ha_api.FailoverSegmentAPI, 'create_segment')
     def test_create_with_duplicate_segment_name(self, mock_create):
         body = {
diff --git a/releasenotes/notes/bug-1776385-0bcf0a0b3fad359e.yaml b/releasenotes/notes/bug-1776385-0bcf0a0b3fad359e.yaml
new file mode 100644
index 00000000..3a28c454
--- /dev/null
+++ b/releasenotes/notes/bug-1776385-0bcf0a0b3fad359e.yaml
@@ -0,0 +1,5 @@
+---
+fixes:
+  - |
+    Allows segment description to contain new line characters.
+    `LP#1776385 <https://launchpad.net/bugs/1776385>`__