#!/usr/bin/env python3 ############################################################################### # # Copyright 2017 - 2024, Gothenburg Bit Factory. # # 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, timedelta # Ensure python finds the local simpletap module sys.path.append(os.path.dirname(os.path.abspath(__file__))) from basetest import Timew, TestCase class TestSummary(TestCase): def setUp(self): """Executed before each test in the class""" self.t = Timew() def test_empty(self): """Summary should print warning if no data in range""" code, out, err = self.t("summary") self.assertIn("No filtered data found in the range", out) def test_filled(self): """Summary should be printed if data is available""" now = datetime.now() yesterday = now - timedelta(days=1) tomorrow = now + timedelta(days=1) self.t("track for 1h") code, out, err = self.t("summary :ids {:%Y-%m-%d} - {:%Y-%m-%d}".format(yesterday, tomorrow)) self.assertRegex(out, r""" Wk ?Date Day ID Tags Annotation ?Start ?End Time Total [ -]+ W\d{1,2} \d{4}-\d{2}-\d{2} .{3} @1 ?\d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2}( W\d{1,2} \d{4}-\d{2}-\d{2} .{3} @1 ?\d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2})? [ ]+1:00:0[01] """) def test_with_closed_interval_and_all_hint(self): """Summary should print closed interval with :all hint""" now = datetime.now() yesterday = now - timedelta(days=1) tomorrow = now + timedelta(days=1) self.t("track for 1h") code, out, err = self.t("summary :ids :all".format(yesterday, tomorrow)) self.assertRegex(out, r""" Wk ?Date Day ID Tags Annotation ?Start ?End Time Total [ -]+ W\d{1,2} \d{4}-\d{2}-\d{2} .{3} @1 ?\d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2}( W\d{1,2} \d{4}-\d{2}-\d{2} .{3} @1 ?\d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2})? [ ]+1:00:0[01] """) def test_with_open_interval(self): """Summary should print open interval""" now = datetime.now() yesterday = now - timedelta(days=1) tomorrow = now + timedelta(days=1) self.t("start 1h ago") code, out, err = self.t("summary :ids {:%Y-%m-%d} - {:%Y-%m-%d}".format(yesterday, tomorrow)) self.assertRegex(out, r""" Wk ?Date Day ID Tags Annotation ?Start End Time Total [ -]+ W\d{1,2} \d{4}-\d{2}-\d{2} .{3} @1 ?\d{1,2}:\d{2}:\d{2}[ ]+- \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2}( W\d{1,2} \d{4}-\d{2}-\d{2} .{3} @1 ?\d{1,2}:\d{2}:\d{2}[ ]+- \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2})? [ ]+1:00:0[01] """) def test_with_open_interval_and_all_hint(self): """Summary should print open interval with :all hint""" now = datetime.now() yesterday = now - timedelta(days=1) tomorrow = now + timedelta(days=1) self.t("start 1h ago") code, out, err = self.t("summary :ids :all".format(yesterday, tomorrow)) self.assertRegex(out, r""" Wk ?Date Day ID Tags Annotation ?Start End Time Total [ -]+ W\d{1,2} \d{4}-\d{2}-\d{2} .{3} @1 ?\d{1,2}:\d{2}:\d{2}[ ]+- \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2}( W\d{1,2} \d{4}-\d{2}-\d{2} .{3} @1 ?\d{1,2}:\d{2}:\d{2}[ ]+- \d{1,2}:\d{2}:\d{2} \d{1,2}:\d{2}:\d{2})? [ ]+1:00:0[01] """) def test_with_range_filter(self): """Summary should print data filtered by date range""" self.t("track Tag1 2017-03-09T08:43:08 - 2017-03-09T09:38:15") self.t("track Tag2 2017-03-09T11:38:39 - 2017-03-09T11:45:35") self.t("track Tag2 Tag3 2017-03-09T11:46:21 - 2017-03-09T12:00:17") self.t("track Tag2 Tag4 2017-03-09T12:01:49 - 2017-03-09T12:28:46") code, out, err = self.t("summary 2017-03-09T11:00 - 2017-03-09T12:00 :ids") self.assertIn(""" Wk Date Day ID Tags Annotation Start End Time Total --- ---------- --- -- ---------- ---------- -------- -------- ------- ------- W10 2017-03-09 Thu @3 Tag2 11:38:39 11:45:35 0:06:56 @2 Tag2, Tag3 11:46:21 12:00:17 0:13:56 0:20:52 0:20:52 """, out) def test_with_date_filter(self): """Summary should print data filtered by date""" self.t("track 2017-03-09T10:00:00 - 2017-03-09T11:00:00") self.t("track 2017-03-10T10:00:00 - 2017-03-10T11:00:00") self.t("track 2017-03-11T10:00:00 - 2017-03-11T11:00:00") code, out, err = self.t("summary 2017-03-10 :ids") self.assertIn(""" Wk Date Day ID Tags Annotation Start End Time Total --- ---------- --- -- ---- ---------- -------- -------- ------- ------- W10 2017-03-10 Fri @2 10:00:00 11:00:00 1:00:00 1:00:00 1:00:00 """, out) def test_with_tag_filter(self): """Summary should print data filtered by tag""" self.t("track Tag1 2017-03-09T08:43:08 - 2017-03-09T09:38:15") self.t("track Tag2 2017-03-09T11:38:39 - 2017-03-09T11:45:35") self.t("track Tag2 Tag3 2017-03-09T11:46:21 - 2017-03-09T12:00:17") self.t("track Tag2 Tag4 2017-03-09T12:01:49 - 2017-03-09T12:28:46") code, out, err = self.t("summary 2017-03-09 Tag1 :ids") self.assertIn(""" Wk Date Day ID Tags Annotation Start End Time Total --- ---------- --- -- ---- ---------- ------- ------- ------- ------- W10 2017-03-09 Thu @4 Tag1 8:43:08 9:38:15 0:55:07 0:55:07 0:55:07 """, out) def test_with_id_filter(self): """Summary should print data filtered by id""" self.t("track Tag1 2017-03-09T08:43:08 - 2017-03-09T09:38:15") self.t("track Tag2 2017-03-09T11:38:39 - 2017-03-09T11:45:35") self.t("track Tag2 Tag3 2017-03-09T11:46:21 - 2017-03-09T12:00:17") self.t("track Tag2 Tag4 2017-03-09T12:01:49 - 2017-03-09T12:28:46") code, out, err = self.t("summary @2 @4 :ids") self.assertIn(""" Wk Date Day ID Tags Annotation Start End Time Total --- ---------- --- -- ---------- ---------- -------- -------- ------- ------- W10 2017-03-09 Thu @4 Tag1 8:43:08 9:38:15 0:55:07 @2 Tag2, Tag3 11:46:21 12:00:17 0:13:56 1:09:03 1:09:03 """, out) def test_non_contiguous_with_tag_filter(self): """Summary should print data filtered by tag when tags are non-contiguous""" self.t("track Tag1 2017-03-09T08:43:08 - 2017-03-09T09:38:15") self.t("track Tag2 2017-03-09T11:38:39 - 2017-03-09T11:45:35") self.t("track Tag1 Tag3 2017-03-09T11:46:21 - 2017-03-09T12:00:17") self.t("track Tag2 Tag4 2017-03-09T12:01:49 - 2017-03-09T12:28:46") code, out, err = self.t("summary 2017-03-09 Tag1 :ids") self.assertIn(""" Wk Date Day ID Tags Annotation Start End Time Total --- ---------- --- -- ---------- ---------- -------- -------- ------- ------- W10 2017-03-09 Thu @4 Tag1 8:43:08 9:38:15 0:55:07 @2 Tag1, Tag3 11:46:21 12:00:17 0:13:56 1:09:03 1:09:03 """, out) def test_with_all_hint(self): """Summary should work with :all hint""" now = datetime.now() yesterday = now - timedelta(days=1) tomorrow = now + timedelta(days=1) self.t("track {0:%Y-%m-%d}T10:00:00 - {0:%Y-%m-%d}T11:00:00 FOO".format(yesterday)) self.t("track {0:%Y-%m-%d}T10:00:00 - {0:%Y-%m-%d}T11:00:00 BAR".format(now)) self.t("track {0:%Y-%m-%d}T10:00:00 - {0:%Y-%m-%d}T11:00:00 BAZ".format(tomorrow)) code, out, err = self.t("summary :ids :all") week_yesterday = yesterday.isocalendar()[1] week_now = now.isocalendar()[1] week_tomorrow = tomorrow.isocalendar()[1] week_col_padding = 2 if (week_yesterday > 9 or week_now > 9 or week_tomorrow > 9) else 1 self.assertIn(""" Wk{7: <{width}}Date Day ID Tags Annotation Start End Time Total -{6:-<{width}} ---------- --- -- ---- ---------- -------- -------- ------- ------- W{3: <{width}} {0:%Y-%m-%d} {0:%a} @3 FOO 10:00:00 11:00:00 1:00:00 1:00:00 W{4: <{width}} {1:%Y-%m-%d} {1:%a} @2 BAR 10:00:00 11:00:00 1:00:00 1:00:00 W{5: <{width}} {2:%Y-%m-%d} {2:%a} @1 BAZ 10:00:00 11:00:00 1:00:00 1:00:00 {7: <{width}} 3:00:00 """.format(yesterday, now, tomorrow, week_yesterday, week_now, week_tomorrow, "-", " ", width=week_col_padding), out) def test_with_all_hint_and_first_interval_later_in_day(self): """Summary should handle :all hint with first interval that starts later in day than the latest interval""" now = datetime.now() yesterday = now - timedelta(days=1) self.t("track {0:%Y-%m-%dT%H:%M:%S} - {1:%Y-%m-%dT%H:%M:%S} FOO".format(yesterday + timedelta(seconds=2), yesterday + timedelta(seconds=3))) self.t("track {0:%Y-%m-%dT%H:%M:%S} - {1:%Y-%m-%dT%H:%M:%S} BAR".format(now - timedelta(seconds=1), now)) code, out, err = self.t("summary :ids :all") self.assertIn("@2", out) self.assertIn("@1", out) self.assertRegex(out, r'\s{30}0:00:02') def test_with_named_date_yesterday(self): """Summary should work with 'yesterday'""" now = datetime.now() yesterday = now - timedelta(days=1) tomorrow = now + timedelta(days=1) self.t("track {0:%Y-%m-%d}T10:00:00 - {0:%Y-%m-%d}T11:00:00 FOO".format(yesterday)) self.t("track {0:%Y-%m-%d}T10:00:00 - {0:%Y-%m-%d}T11:00:00 BAR".format(now)) self.t("track {0:%Y-%m-%d}T10:00:00 - {0:%Y-%m-%d}T11:00:00 BAZ".format(tomorrow)) code, out, err = self.t("summary :ids yesterday") week_yesterday = yesterday.isocalendar()[1] two_digit_week = (week_yesterday > 9) self.assertIn(""" Wk{2} Date Day ID Tags Annotation Start End Time Total --{3} ---------- --- -- ---- ---------- -------- -------- ------- ------- W{1} {0:%Y-%m-%d} {0:%a} @3 FOO 10:00:00 11:00:00 1:00:00 1:00:00 {2} 1:00:00 """.format(yesterday, week_yesterday, " " if two_digit_week is True else "", "-" if two_digit_week is True else ""), out) def test_with_named_date_today(self): """Summary should work with 'today'""" now = datetime.now() yesterday = now - timedelta(days=1) tomorrow = now + timedelta(days=1) self.t("track {0:%Y-%m-%d}T10:00:00 - {0:%Y-%m-%d}T11:00:00 FOO".format(yesterday)) self.t("track {0:%Y-%m-%d}T10:00:00 - {0:%Y-%m-%d}T11:00:00 BAR".format(now)) self.t("track {0:%Y-%m-%d}T10:00:00 - {0:%Y-%m-%d}T11:00:00 BAZ".format(tomorrow)) code, out, err = self.t("summary :ids today") week_now = now.isocalendar()[1] two_digit_week = (week_now > 9) self.assertIn(""" Wk{2} Date Day ID Tags Annotation Start End Time Total --{3} ---------- --- -- ---- ---------- -------- -------- ------- ------- W{1} {0:%Y-%m-%d} {0:%a} @2 BAR 10:00:00 11:00:00 1:00:00 1:00:00 {2} 1:00:00 """.format(now, week_now, " " if two_digit_week is True else "", "-" if two_digit_week is True else ""), out) def test_with_day_gap(self): """Summary should skip days with no data""" self.t("track 2017-03-09T10:00:00 - 2017-03-09T11:00:00") self.t("track 2017-03-11T10:00:00 - 2017-03-11T11:00:00") code, out, err = self.t("summary 2017-03-09 - 2017-03-12 :ids") self.assertIn(""" Wk Date Day ID Tags Annotation Start End Time Total --- ---------- --- -- ---- ---------- -------- -------- ------- ------- W10 2017-03-09 Thu @2 10:00:00 11:00:00 1:00:00 1:00:00 W10 2017-03-11 Sat @1 10:00:00 11:00:00 1:00:00 1:00:00 2:00:00 """, out) def test_with_week_change(self): """Summary should display week change""" self.t("track 2017-03-11T10:00:00 - 2017-03-11T11:00:00") self.t("track 2017-03-13T10:00:00 - 2017-03-13T11:00:00") code, out, err = self.t("summary 2017-03-11 - 2017-03-14 :ids") self.assertIn(""" Wk Date Day ID Tags Annotation Start End Time Total --- ---------- --- -- ---- ---------- -------- -------- ------- ------- W10 2017-03-11 Sat @2 10:00:00 11:00:00 1:00:00 1:00:00 W11 2017-03-13 Mon @1 10:00:00 11:00:00 1:00:00 1:00:00 2:00:00 """, out) def test_with_several_tracks_per_day(self): """Summary should display daily total""" self.t("track FOO 2017-03-09T10:00:00 - 2017-03-09T11:00:00") self.t("track BAR 2017-03-09T12:00:00 - 2017-03-09T13:00:00") self.t("track BAZ 2017-03-09T14:00:00 - 2017-03-09T15:00:00") self.t("track FOO 2017-03-11T10:00:00 - 2017-03-11T11:00:00") self.t("track BAR 2017-03-11T12:00:00 - 2017-03-11T13:00:00") self.t("track BAZ 2017-03-11T14:00:00 - 2017-03-11T15:00:00") code, out, err = self.t("summary 2017-03-09 - 2017-03-12 :ids") self.assertIn(""" Wk Date Day ID Tags Annotation Start End Time Total --- ---------- --- -- ---- ---------- -------- -------- ------- ------- W10 2017-03-09 Thu @6 FOO 10:00:00 11:00:00 1:00:00 @5 BAR 12:00:00 13:00:00 1:00:00 @4 BAZ 14:00:00 15:00:00 1:00:00 3:00:00 W10 2017-03-11 Sat @3 FOO 10:00:00 11:00:00 1:00:00 @2 BAR 12:00:00 13:00:00 1:00:00 @1 BAZ 14:00:00 15:00:00 1:00:00 3:00:00 6:00:00 """, out) def test_with_empty_interval_at_start_of_day(self): """Summary should display empty intervals at midnight""" self.t("track sod - sod") code, out, err = self.t("summary :year") self.assertRegex(out, r""" Wk ?Date Day ID Tags Annotation Start End Time Total [ -]+ W\d{1,2} \d{4}-\d{2}-\d{2} .{3} @1 0:00:00 0:00:00 0:00:00 0:00:00 [ ]+0:00:00 """) def test_multibyte_char_annotation_wrapped(self): """Summary correctly wraps long annotation containing multibyte characters""" # Using a blue heart emoji as an example of a multibyte (4 bytes in this case) character. long_enough_annotation = "'" + ("a" + "💙" * 5 + " ") * 5 + "'" self.t("track FOO sod - sond") self.t("anno @1 " + long_enough_annotation) code, out, err = self.t("summary :anno") self.assertRegex(out, r"(a💙{5} )\s{0,11}0:00:00") if __name__ == "__main__": from simpletap import TAPTestRunner unittest.main(testRunner=TAPTestRunner())