timewarrior/test/delete.t
Scott Mcdermott 05724a9d21 Make python tests use timezone, py3.12 deprecated tz-less utcnow()
Python upstream is trying to eliminate tz-naive date functions that
imply anything to do with a timezone, even UTC.  They have deprecated
datetime.datetime.utcnow() in Python 3.12 and thus running tests emits
many warnings for us.

We switch to instantiate datetime objects taht are intended to reflect
UTC to have a timezone, or if we instantiate naive ones and then later
convert, we do the full conversion.

After the changes, the tests still work on Python 3.9, but now also on
Python 3.12 without warnings.

See PR description for #632 for more details.

Signed-off-by: Scott Mcdermott <scott@smemsh.net>
2024-09-13 15:45:11 +02:00

166 lines
6.5 KiB
Python
Executable file

#!/usr/bin/env python3
###############################################################################
#
# Copyright 2016 - 2022, 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
from datetime import datetime, timezone, timedelta
from dateutil import tz
# Ensure python finds the local simpletap module
sys.path.append(os.path.dirname(os.path.abspath(__file__)))
from basetest import Timew, TestCase
class TestDelete(TestCase):
def setUp(self):
"""Executed before each test in the class"""
self.t = Timew()
def test_delete_open(self):
"""Delete a single open interval"""
now_utc = datetime.now(timezone.utc)
five_hours_before_utc = now_utc - timedelta(hours=5)
four_hours_before_utc = now_utc - timedelta(hours=4)
three_hours_before_utc = now_utc - timedelta(hours=3)
self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z foo".format(five_hours_before_utc, four_hours_before_utc))
self.t("start {:%Y-%m-%dT%H:%M:%S}Z bar".format(three_hours_before_utc))
j = self.t.export()
self.assertEqual(len(j), 2)
self.assertClosedInterval(j[0], expectedTags=["foo"])
self.assertOpenInterval(j[1], expectedTags=["bar"])
code, out, err = self.t("delete @1")
self.assertEqual(out, 'Deleted @1\n')
j = self.t.export()
self.assertEqual(len(j), 1)
self.assertClosedInterval(j[0], expectedTags=["foo"])
def test_delete_closed(self):
"""Delete a single closed interval"""
now_utc = datetime.now(timezone.utc)
five_hours_before_utc = now_utc - timedelta(hours=5)
four_hours_before_utc = now_utc - timedelta(hours=4)
three_hours_before_utc = now_utc - timedelta(hours=3)
self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z foo".format(five_hours_before_utc, four_hours_before_utc))
self.t("start {:%Y-%m-%dT%H:%M:%S}Z bar".format(three_hours_before_utc))
j = self.t.export()
self.assertEqual(len(j), 2)
self.assertClosedInterval(j[0], expectedTags=["foo"])
self.assertOpenInterval(j[1], expectedTags=["bar"])
code, out, err = self.t("delete @2")
self.assertEqual(out, 'Deleted @2\n')
j = self.t.export()
self.assertEqual(len(j), 1)
self.assertOpenInterval(j[0], expectedTags=["bar"])
def test_delete_multiple(self):
"""Delete a mix of open/closed intervals"""
now_utc = datetime.now(timezone.utc)
five_hours_before_utc = now_utc - timedelta(hours=5)
four_hours_before_utc = now_utc - timedelta(hours=4)
three_hours_before_utc = now_utc - timedelta(hours=3)
self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z foo".format(five_hours_before_utc, four_hours_before_utc))
self.t("start {:%Y-%m-%dT%H:%M:%S}Z bar".format(three_hours_before_utc))
code, out, err = self.t("delete @1 @2")
self.assertIn('Deleted @1', out)
self.assertIn('Deleted @2', out)
j = self.t.export()
self.assertEqual(len(j), 0)
def test_delete_open_interval_spanning_exclusion(self):
"""Delete an open interval that spans over an exclusion"""
now = datetime.now()
three_hours_before = now - timedelta(hours=3)
four_hours_before = now - timedelta(hours=4)
now_utc = now.replace(tzinfo=tz.tzlocal()).astimezone(timezone.utc)
four_hours_before_utc = now_utc - timedelta(hours=4)
five_hours_before_utc = now_utc - timedelta(hours=5)
self.t.configure_exclusions([(four_hours_before.time(), three_hours_before.time())])
self.t("start {:%Y-%m-%dT%H:%M:%S}Z foo".format(five_hours_before_utc))
# Delete the open interval.
code, out, err = self.t("delete @1") # self.t("delete @1 :debug")
self.assertEqual(out, 'Deleted @1\n')
# The last interval should be closed, because the open interval was deleted.
j = self.t.export()
self.assertEqual(len(j), 1)
self.assertClosedInterval(j[0],
expectedStart='{:%Y%m%dT%H%M%S}Z'.format(five_hours_before_utc),
expectedEnd='{:%Y%m%dT%H%M%S}Z'.format(four_hours_before_utc),
expectedTags=['foo'],
description='remaining interval')
def test_delete_interval_which_encloses_month_border(self):
"""Delete an interval which encloses a month border"""
now = datetime.now()
this_month = datetime(now.year, now.month, 1)
last_month = this_month - timedelta(days=1)
self.t("track {:%Y-%m-%dT12:00:00}Z - {:%Y-%m-%dT12:00:00}Z foo".format(last_month, this_month))
self.t("delete @1")
j = self.t.export()
self.assertEqual(len(j), 0)
def test_referencing_a_non_existent_interval_is_an_error(self):
"""Calling delete with a non-existent interval reference is an error"""
code, out, err = self.t.runError("delete @1")
self.assertIn("ID '@1' does not correspond to any tracking.", err)
self.t("start 1h ago bar")
code, out, err = self.t.runError("delete @2")
self.assertIn("ID '@2' does not correspond to any tracking.", err)
if __name__ == "__main__":
from simpletap import TAPTestRunner
unittest.main(testRunner=TAPTestRunner())