From 113f8e99991b70709eb58168a6c4572a01e907b6 Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Tue, 20 Dec 2016 17:00:20 +0100
Subject: [ct] Add ct_testspec:get_tests/1

This API function is used by rebar3 instead of implementing test spec
parsing again.
---
 lib/common_test/doc/src/Makefile        |  3 +-
 lib/common_test/doc/src/ct_testspec.xml | 84 +++++++++++++++++++++++++++++++++
 lib/common_test/doc/src/ref_man.xml     |  1 +
 3 files changed, 87 insertions(+), 1 deletion(-)
 create mode 100644 lib/common_test/doc/src/ct_testspec.xml

(limited to 'lib/common_test/doc/src')

diff --git a/lib/common_test/doc/src/Makefile b/lib/common_test/doc/src/Makefile
index e495f587a3..152ece5d25 100644
--- a/lib/common_test/doc/src/Makefile
+++ b/lib/common_test/doc/src/Makefile
@@ -53,7 +53,8 @@ XML_REF3_FILES = ct.xml \
 	ct_slave.xml \
 	ct_property_test.xml \
 	ct_netconfc.xml \
-	ct_hooks.xml
+	ct_hooks.xml \
+        ct_testspec.xml
 XML_REF6_FILES = common_test_app.xml
 
 XML_PART_FILES = part.xml 
diff --git a/lib/common_test/doc/src/ct_testspec.xml b/lib/common_test/doc/src/ct_testspec.xml
new file mode 100644
index 0000000000..36893f66cf
--- /dev/null
+++ b/lib/common_test/doc/src/ct_testspec.xml
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+  <header>
+    <copyright>
+      <year>2016</year>
+      <holder>Ericsson AB. All Rights Reserved.</holder>
+    </copyright>
+    <legalnotice>
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+      See the License for the specific language governing permissions and
+      limitations under the License.
+
+    </legalnotice>
+
+    <title>ct_testspec</title>
+    <prepared></prepared>
+    <responsible></responsible>
+    <docno></docno>
+    <approved></approved>
+    <checked></checked>
+    <date></date>
+    <rev>A</rev>
+    <file>ct_testspec.xml</file>
+  </header>
+  <module>ct_testspec</module>
+  <modulesummary>Parsing of test specifications for Common Test.
+  </modulesummary>
+
+<description>
+
+    <p>Parsing of test specifications for <c>Common Test</c>.</p>
+
+    <p>This module exports help functions for parsing of test specifications.</p>
+
+</description>
+
+  <funcs>
+    <func>
+    <name>get_tests(SpecsIn) -&gt; {ok, [{Specs,Tests}]} | {error, Reason}</name>
+    <fsummary>Parse the given test specification files and return the tests to run and skip.</fsummary>
+      <type>
+        <v>SpecsIn = [string()] | [[string()]]</v>
+        <v>Specs = [string()]</v>
+        <v>Test = [{Node,Run,Skip}]</v>
+        <v>Node = atom()</v>
+        <v>Run = {Dir,Suites,Cases}</v>
+        <v>Skip = {Dir,Suites,Comment} | {Dir,Suites,Cases,Comment}</v>
+        <v>Dir = string()</v>
+        <v>Suites = atom | [atom()] | all</v>
+        <v>Cases = atom | [atom()] | all</v>
+        <v>Comment = string()</v>
+        <v>Reason = term()</v>
+      </type>
+      <desc><marker id="add_nodes-1"/>
+        <p>Parse the given test specification files and return the
+        tests to run and skip.</p>
+
+        <p>If <c>SpecsIn=[Spec1,Spec2,...]</c>, separate tests will be
+        created per specification. If
+        <c>SpecsIn=[[Spec1,Spec2,...]]</c>, all specifications will be
+        merge into one test.</p>
+
+        <p>For each test, a <c>{Specs,Tests}</c> element is returned,
+        where <c>Specs</c> is a list of all included test
+        specifications, and <c>Tests</c> specifies actual tests to
+        run/skip per node.</p>
+      </desc>
+    </func>
+
+  </funcs>
+
+</erlref>
+
+
diff --git a/lib/common_test/doc/src/ref_man.xml b/lib/common_test/doc/src/ref_man.xml
index d1567e2d3c..1ac20db5c2 100644
--- a/lib/common_test/doc/src/ref_man.xml
+++ b/lib/common_test/doc/src/ref_man.xml
@@ -47,6 +47,7 @@
   <xi:include href="ct_slave.xml"/>
   <xi:include href="ct_hooks.xml"/>
   <xi:include href="ct_property_test.xml"/>
+  <xi:include href="ct_testspec.xml"/>
 </application>
 
 
-- 
cgit v1.2.3