1#!/bin/bash
2
3# This program will generate test documenation from the robot test cases.
4
5# Description of argument(s):
6# test_dir_path            Test directory where robot test cases are available.
7# test_case_doc_file_path  The test case document file path to be stored.
8
9
10###############################################################################
11function get_parms {
12
13  # Get program parms.
14
15  test_dir_path="${1}" ; shift
16  test_case_doc_file_path="${1}" ; shift
17
18  return 0
19
20}
21###############################################################################
22
23
24###############################################################################
25function validate_parms {
26
27  # Validate program parameters.
28
29  num_parms="${1}" ; shift
30
31  (( ${num_parms} == 0 )) && return 0
32
33  if [ -z "${test_dir_path}" ] ; then
34    echo "**ERROR** You must provide test directory as the first positional" \
35         "parameter." >&2
36    return 1
37  fi
38
39  if [ -z "${test_case_doc_file_path}" ] ; then
40    echo "**ERROR** You must provide file path as the second positional" \
41         "parameter." >&2
42    return 1
43  fi
44
45  return 0
46
47}
48###############################################################################
49
50
51###############################################################################
52function generate_all_test_document {
53
54  # Generate all test case documents
55
56  local ret_code=0
57  python -m robot.testdoc tests testsdirectoryTCdocs.html || ret_code=1
58  python -m robot.testdoc extended extendeddirectoryTCdocs.html || ret_code=1
59  python -m robot.testdoc gui guidirectoryTCdocs.html || ret_code=1
60  python -m robot.testdoc systest systestdirectoryTCdocs.html || ret_code=1
61
62  return ${ret_code}
63}
64###############################################################################
65
66
67###############################################################################
68function main_function {
69
70  get_parms "$@" || return 1
71
72  validate_parms $# || return 1
73
74  if (( ${num_parms} == 0 )) ; then
75    generate_all_test_document || return 1
76    return 0
77  fi
78
79  echo ${test_dir_path} ${test_case_doc_file_path}
80  python -m robot.testdoc ${test_dir_path} ${test_case_doc_file_path}\
81    || return 1
82
83  return 0
84
85}
86###############################################################################
87
88
89###############################################################################
90# Main
91
92  main_function "${@}"
93  rc="${?}"
94  exit "${rc}"
95
96###############################################################################
97