mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-06-26 10:54:28 +02:00
b189ccb020
This replaces the generation of man pages on project setup by a on-demand generation via asciidoctor. An exception are the man pages for the commands `day`, `month`, and `week` which are simply redirects to the man page `timew-chart.1`. Those are now static files in the Timewarrior repository. A CMake find module to detect asciidoctor was added. If asciidoctor is found, the targets `doc`, `man1`, and `man7` are created. Those targets are also added to the default build target. If asciidoctor is not available, the target `doc` is available, but it only emits a message to install asciidoctor first. Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
88 lines
3.4 KiB
Python
Executable file
88 lines
3.4 KiB
Python
Executable file
#!/usr/bin/env python3
|
|
|
|
###############################################################################
|
|
#
|
|
# Copyright 2019 - 2021, Thomas Lauf, Paul Beckingham, Federico Hernandez.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included
|
|
# in all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
|
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
# SOFTWARE.
|
|
#
|
|
# https://www.opensource.org/licenses/mit-license.php
|
|
#
|
|
###############################################################################
|
|
|
|
import os
|
|
import sys
|
|
import unittest
|
|
|
|
# Ensure python finds the local simpletap module
|
|
sys.path.append(os.path.dirname(os.path.abspath(__file__)))
|
|
|
|
from basetest import Timew, TestCase
|
|
|
|
|
|
class TestHelp(TestCase):
|
|
def setUp(self):
|
|
"""Executed before each test in the class"""
|
|
self.t = Timew()
|
|
|
|
def test_help_without_command_should_print_usage(self):
|
|
"""timew help without command should print usage"""
|
|
code, out, err = self.t("help")
|
|
self.assertRegex(out, r"Usage: timew [--version]")
|
|
|
|
def test_help_long_option_should_print_usage(self):
|
|
"""timew --help should print usage"""
|
|
code, out1, err1 = self.t("help")
|
|
code, out2, err2 = self.t("--help")
|
|
self.assertEqual(out1, out2)
|
|
|
|
def test_help_short_option_should_print_usage(self):
|
|
"""timew -h should print usage"""
|
|
code, out1, err1 = self.t("help")
|
|
code, out2, err2 = self.t("-h")
|
|
self.assertEqual(out1, out2)
|
|
|
|
def test_help_with_command_should_show_man_page(self):
|
|
"""timew help with command should show man page"""
|
|
code, out, err = self.t("help start")
|
|
|
|
self.assertRegex(out, r"TIMEW-START\(1\)\s+User Manuals\s+TIMEW-START\(1\)")
|
|
|
|
def test_help_with_unknown_argument_should_show_error_message(self):
|
|
"""timew help with unknown argument should show error message"""
|
|
code, out, err = self.t.runError("help bogus")
|
|
self.assertRegex(err, r"No manual entry for timew-bogus")
|
|
|
|
def test_command_with_help_long_option_should_show_help_page(self):
|
|
"""timew command with --help should show help page"""
|
|
code, out1, err1 = self.t("help track")
|
|
code, out2, err2 = self.t("track --help")
|
|
self.assertEqual(out1, out2)
|
|
|
|
def test_command_with_help_short_option_should_show_help_page(self):
|
|
"""timew command with -h should show help page"""
|
|
code, out1, err1 = self.t("help track")
|
|
code, out2, err2 = self.t("track -h")
|
|
self.assertEqual(out1, out2)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
from simpletap import TAPTestRunner
|
|
|
|
unittest.main(testRunner=TAPTestRunner())
|