1 files changed, 130 insertions, 0 deletions
diff --git a/tests/distaf/tests_d/examples/test_docstring.py b/tests/distaf/tests_d/examples/test_docstring.py
new file mode 100644
index 00000000000..1a73998eb66
--- /dev/null
+++ b/tests/distaf/tests_d/examples/test_docstring.py
@@ -0,0 +1,130 @@
+#  This file is part of DiSTAF
+#  Copyright (C) 2015-2016  Red Hat, Inc. <http://www.redhat.com>
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; either version 2 of the License, or
+#  any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License along
+#  with this program; if not, write to the Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+
+from distaf.util import tc, testcase
+from distaf.gluster_base_class import GlusterBaseClass
+
+
+# An example with both doc and config in docstring
+@testcase("doc_and_config_test")
+class DocAndConfig(GlusterBaseClass):
+    """ Testing docstring configuration options
+    This is an example of a basic distaf test with mixed comment and config
+    Any necessary description doc string text goes here and can include any
+        plain text normally found in a docstring.
+    Distaf specific config yaml can be included using the yaml standard
+        document triple-dash separator below.
+    ---
+    runs_on_volumes: [ distributed ]
+    runs_on_protocol: [ glusterfs ]
+    reuse_setup: False
+    tags:
+      - tag1
+      - tag2
+      - tag3
+    """
+    def run(self):
+        tc.logger.info("Running with doc and config in docstring")
+        config = self.config_data
+        tc.logger.debug("Tag 2 is %s" % config["tags"][1])
+        tag2 = config["tags"][1]
+        if tag2 == "tag2":
+            return True
+
+        return False
+
+    def setup(self):
+        return True
+
+    def cleanup(self):
+        return True
+
+    def teardown(self):
+        return True
+
+
+# An example with only config in docstring
+@testcase("config_only_test")
+class ConfigOnly(GlusterBaseClass):
+    """
+    runs_on_volumes: [ distributed ]
+    runs_on_protocol: [ glusterfs, cifs ]
+    reuse_setup: False
+    tags:
+      - tag1
+      - tag2
+      - tag3
+    """
+    def run(self):
+        tc.logger.info("Running with only config in docstring")
+        config = self.config_data
+        tc.logger.debug("Tag 2 is %s" % config["tags"][1])
+        tag2 = config["tags"][1]
+        if tag2 == "tag2":
+            return True
+
+        return False
+
+    def setup(self):
+        return True
+
+    def cleanup(self):
+        return True
+
+    def teardown(self):
+        return True
+
+
+# An example with only doc in docstring
+@testcase("doc_only_test")
+class DocOnly(GlusterBaseClass):
+    """ Testing docstring configuration options
+    This is an example of a basic distaf test with mixed comment and config
+    Any necessary description doc string text goes here and can include any
+        plain text normally found in a docstring.
+    """
+    def run(self):
+        tc.logger.info("Running with only doc in docstring")
+        return True
+
+    def setup(self):
+        return True
+
+    def cleanup(self):
+        return True
+
+    def teardown(self):
+        return True
+
+
+# An example without a docstring
+@testcase("no_docstring_test")
+class NoDocstring(GlusterBaseClass):
+    def run(self):
+        tc.logger.info("Running with no docstring")
+
+        return True
+
+    def setup(self):
+        return True
+
+    def cleanup(self):
+        return True
+
+    def teardown(self):
+        return True