taskwarrior/test/nag.test.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
###############################################################################
#
# Copyright 2006 - 2021, Tomas Babej, 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 sys
import os
import unittest
# Ensure python finds the local simpletap module
sys.path.append(os.path.dirname(os.path.abspath(__file__)))

from basetest import Task, TestCase


class TestNagging(TestCase):

    def setUp(self):
        """Executed before each test in the class"""
        # Used to initialize objects that should be re-initialized or
        # re-created for each individual test
        self.t = Task()
        self.t.config("nag", "NAG")

    def test_nagging(self):
        """Verify that nagging works when tasks are done in the 'wrong' order"""
        self.t("add due:yesterday one")
        self.t("add due:tomorrow two")
        self.t("add priority:H three")
        self.t("add priority:M four")
        self.t("add priority:L five")
        self.t("add six")
        self.t("add seven +nonag")

        code, out, err = self.t("7 done")
        self.assertNotIn("NAG", err)

        code, out, err = self.t("6 done")
        self.assertIn("NAG", err)

        code, out, err = self.t("5 done")
        self.assertIn("NAG", err)

        code, out, err = self.t("4 done")
        self.assertIn("NAG", err)

        code, out, err = self.t("3 done")
        self.assertIn("NAG", err)

        code, out, err = self.t("2 done")
        self.assertIn("NAG", err)

        code, out, err = self.t("1 done")
        self.assertNotIn("NAG", err)

    def test_nagging_ready(self):
        """Verify that nagging occurs when there are READY tasks of higher urgency"""
        self.t("add one")                                # low urgency
        self.t("add two due:10days scheduled:yesterday") # medium urgency, ready

        code, out, err = self.t("1 done")
        self.assertIn("NAG", err)

    def test_nagging_not_ready(self):
        """Verify that nagging does not occur when there are unREADY tasks of higher urgency"""
        self.t("add one")                             # low urgency
        self.t("add two due:10days scheduled:10days") # medium urgency, not ready

        code, out, err = self.t("1 done")
        self.assertNotIn("NAG", err)

    def test_nagging_bulk(self):
        """Verify that only one nag message occurs when completing multiple tasks"""
        self.t("add one")
        self.t.faketime("+1d")
        self.t("add two")
        self.t("add two")

        code, out, err = self.t("2 done")

        self.assertEqual(err.count("NAG"), 1)

    def test_nagging_active(self):
        """Bug 2163: Verify that nagging does not occur when completing the most urgent active task"""
        self.t("add one")
        self.t.faketime("+1d")
        self.t("add two")
        self.t("2 start")

        code, out, err = self.t("2 done")

        # Taskwarrior should not nag about more urgent tasks
        self.assertNotIn("NAG", err)

    def test_nagging_start_only_task(self):
        """Verify that nagging does not occur when there are no other tasks while starting a task"""
        self.t("add one")

        code, out, err = self.t("1 start")

        self.assertNotIn("NAG", err)

    def test_nagging_start(self):
        """Verify that nagging occurs when there are READY tasks of higher urgency while starting a task"""
        self.t("add one")
        self.t.faketime("+10d")
        self.t("add two")

        code, out, err = self.t("2 start")

        self.assertIn("NAG", err)

    def test_nagging_nonag(self):
        """Verify that nagging does not occur when a task has the nonag tag"""
        self.t("add one +other")
        self.t.faketime("+10d")
        self.t("add two +nonag")

        code, out, err = self.t("2 done")

        self.assertNotIn("NAG", err)

    def test_nagging_nonag_bulk(self):
        """Verify that nagging occurs even if some tasks in a bulk operation have a nonag tag"""
        self.t("add one +other")
        self.t.faketime("+10d")
        self.t("add two +other")
        self.t.faketime("+10d")
        self.t("add three +nonag")

        code, out, err = self.t("2-3 done")

        self.assertIn("NAG", err)


if __name__ == "__main__":
    from simpletap import TAPTestRunner
    unittest.main(testRunner=TAPTestRunner())

# vim: ai sts=4 et sw=4 ft=python