Merge pull request #55 from dvklopfenstein/dev

Added functions to collect various groups of project csvs; Added running `git add` during `trk init`

Author: dvklopfenstein

.timetracker/.gitignore

@@ -0,0 +1 @@
+start_*.txt

.timetracker/config

@@ -0,0 +1,6 @@
+# TimeTracker project configuration file
+
+project = "timetracker"
+
+[csv]
+filename = "./timetracker_timetracker_$USER$.csv"

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 # Summary
 * [**Unreleased**](#unreleased)
+* [**Release 2025-05-27 v0.5a9**](#release-2025-05-27-v05a9) Added functions to collect various groups of csv files
 * [**Release 2025-05-18 v0.5a7**](#release-2025-05-18-v05a7) Add starttime to `report`; Bug fix in `cancel`
 * [**Release 2025-05-16 v0.5a6**](#release-2025-05-16-v05a6) Add options to `projects` command; Fix `report` command
 * [**Release 2025-05-15 v0.5a5**](#release-2025-05-15-v05a5) Report command tested and updated; Get csv files for a single user tested and implemented
@@ -30,6 +31,16 @@
 
 ## Unreleased
 
+## Release 2025-05-27 v0.5a9
+* ADDED `trk hours` options `--global` to show hours for all projects for a single username
+* ADDED `trk hours` options `--global` `--all-users` for hours for all projects for all usernames
+* ADDED function get_csv_local_uname
+* ADDED function get_csvs_local_all
+* ADDED function get_csvs_global_uname
+* ADDED function get_csvs_global_all
+* ADDED running `git add .timetracker/config .timetracker/.gitignore` during initialization
+* FIXED exit gracefully if `start --at` datetime cannot be parsed
+
 ## Release 2025-05-18 v0.5a7
 * ADDED start time to `report` stdout
 * FIXED incorrect param order in `cancel`

pyproject.toml

@@ -7,10 +7,10 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "timetracker-csv"
 description = "Pandas-friendly time tracking from the CLI"
-version = "0.5a7"
+version = "0.5a9"
 license = "AGPL-3.0-or-later"
 authors = [
-    {name = 'DV Klopfenstein, PhD', email = 'dvklopfenstein@protonmail.com'},
+  {name = 'DV Klopfenstein, PhD', email = 'dvklopfenstein@protonmail.com'},
 ]
 readme = {file="README.md", content-type="text/markdown"}
 

tests/pkgtttest/expcsvs.py

@@ -0,0 +1,103 @@
+"""Query expected csvs"""
+
+from re import compile as re_compile
+from timetracker.csvget import NTCSV
+
+
+class ExpCsvs:
+    """Query expected csvs"""
+
+    FCSV = re_compile(r'home/(?P<username>\w+)/proj/(?P<project>\w+)')
+
+    def __init__(self, orig_ntcsvs, pull_copies):
+        self.exp_ntcsvs = orig_ntcsvs + self._init_ntcsvs(pull_copies, orig_ntcsvs)
+
+    def chk_get_csvs_global_all(self, usr2ntcsvs):
+        """Check the csvs resulting from `get_csvs_global_uname`"""
+        for usr_act, ntcsvs_act in usr2ntcsvs.items():
+            ntcsvs_exp = self._exp_get_csvs_global_all(usr_act)
+            fcsvs_exp = set(nt.fcsv for nt in ntcsvs_exp)
+            fcsvs_act = set(nt.fcsv for nt in ntcsvs_act)
+            assert fcsvs_act == fcsvs_exp, self._err(fcsvs_act, fcsvs_exp)
+            for ntcsv in ntcsvs_act:
+                assert usr_act in ntcsv.fcsv, f'FILE OUTSIDE OF ACCOUNT({usr_act}): {ntcsv.fcsv}'
+                #print(f'GLB ALL ACT {usr_act:7} {ntcsv}')
+
+    def chk_get_csvs_global_uname(self, usr2ntcsvs):
+        """Check the csvs resulting from `get_csvs_global_uname`"""
+        for usr_act, ntcsvs_act in usr2ntcsvs.items():
+            ntcsvs_exp = self._exp_get_csvs_global_uname(usr_act)
+            assert ntcsvs_act == ntcsvs_exp, self._err(ntcsvs_act, ntcsvs_exp)
+            for ntcsv in ntcsvs_act:
+                assert ntcsv.username == usr_act
+                #print(f'ACT {usr_act:7} {ntcsv}')
+
+    def chk_get_csvs_local_all(self, usrprj2ntcsvs):
+        """Check the csvs resulting from `get_csvs_global_uname`"""
+        for (usr_act, prj_act), ntcsvs_act in usrprj2ntcsvs.items():
+            ntcsvs_exp = self._exp_get_csvs_local_all(usr_act, prj_act)
+            fcsvs_exp = set(nt.fcsv for nt in ntcsvs_exp)
+            fcsvs_act = set(nt.fcsv for nt in ntcsvs_act)
+            assert fcsvs_act == fcsvs_exp, self._err(fcsvs_act, fcsvs_exp)
+            for ntcsv in ntcsvs_act:
+                assert usr_act in ntcsv.fcsv, f'FILE OUTSIDE OF ACCOUNT({usr_act}): {ntcsv.fcsv}'
+                #print(f'GLB ALL ACT {usr_act:7} {ntcsv}')
+
+    def chk_get_csvs_local_uname(self, usrprj2ntcsv):
+        """Check the csvs resulting from `get_csvs_global_uname`"""
+        for (usr_act, prj_act), ntcsv_act in usrprj2ntcsv.items():
+            ntcsv_exp = self._exp_get_csvs_local_uname(usr_act, prj_act)
+            assert ntcsv_act == ntcsv_exp, self._err([ntcsv_act], [ntcsv_exp])
+
+    # -------------------------------------------------------------------------------
+    def _exp_get_csvs_global_uname(self, uname):
+        nts = set()
+        for ntcsv in self._exp_get_csvs_global_all(uname):
+            if f'_{uname}.csv' in ntcsv.fcsv:
+                nts.add(ntcsv)
+        return nts
+
+    def _exp_get_csvs_global_all(self, login):
+        nts = set()
+        for ntcsv in self.exp_ntcsvs:
+            if ntcsv.fcsv is not None and f'home/{login}/proj' in ntcsv.fcsv:
+                nts.add(ntcsv)
+        return nts
+
+    def _exp_get_csvs_local_all(self, login, project):
+        nts = set()
+        for ntcsv in self.exp_ntcsvs:
+            if ntcsv.fcsv is not None and f'home/{login}/proj/{project}' in ntcsv.fcsv:
+                nts.add(ntcsv)
+        return nts
+
+    def _exp_get_csvs_local_uname(self, login, project):
+        for ntcsv in self._exp_get_csvs_local_all(login, project):
+            if ntcsv.fcsv is not None and f'_{login}.csv' in ntcsv.fcsv:
+                return ntcsv
+        return None
+
+    @staticmethod
+    def _err(act, exp):
+        errmsg = [f'ACT[{len(act)}] != EXP[{len(exp)}]',]
+        errmsg.append('ACT:')
+        for idx, elem in enumerate(sorted(act)):
+            errmsg.append(f'ACT {idx}) {elem}')
+        errmsg.append('EXP:')
+        for idx, elem in enumerate(sorted(exp)):
+            errmsg.append(f'EXP {idx}) {elem}')
+        return '\n'.join(errmsg)
+
+    # -------------------------------------------------------------------------------
+    def _init_ntcsvs(self, csv_pull_copies, orig_ntcsvs):
+        watchers = set((nt.username, nt.project) for nt in orig_ntcsvs)
+        ntcsvs = []
+        for fcsv in csv_pull_copies:
+            mtch = self.FCSV.search(fcsv)
+            assert mtch is not None, 'EXPECTED FILENAME: home/USER/proj/PROJECT'
+            username = mtch['username']
+            project = mtch['project']
+            assert (username, project) in watchers
+            ntd = NTCSV(fcsv=fcsv, username=username, project=project)
+            ntcsvs.append(ntd)
+        return ntcsvs

tests/pkgtttest/mkprojs.py

@@ -90,17 +90,8 @@ def _get_expdirs(tmphome, project, dirgit, trksubdir):
         dirgit=join(dirproj, '.git') if dirgit else None,
         dirtrk=join(dirproj, trksubdir),
         dirdoc=join(dirproj, 'doc'))
-    ####prt_expdirs(ntexpdirs, "tests/pkgtttest/mkprojs:mk_projdirs")
     return ntexpdirs
 
-##def mk_projdirs_wcfgs(tmp_home, project, trksubdir='.timetracker'):
-##    """Make sub-directories & cfgs in a temporary directory for use in tests"""
-##    ##dirproj = mk_projdirs(tmp_home, project)
-##    ntexpdirs = mk_projdirs(tmp_home, project)
-##    fname_cfgproj = join(ntexpdirs.dirproj, trksubdir, 'config')
-##    cfg = run_init(fname_cfgproj, '.', project, dirhome=tmp_home)
-##    return ntexpdirs.dirproj, cfg.cfg_loc, cfg.cfg_glb
-
 def findhome(home):
     """Do a find on the given homedir and print using debug logging"""
     debug(findhome_str(home))
@@ -126,6 +117,11 @@ def get_files(basedir):
             files_all.append(join(root, file))
     return files_all
 
+def prt_files(basedir, prefix=''):
+    """Print files in basedir and below"""
+    for fname in get_files(basedir):
+        print(f'{prefix}{fname}')
+
 def get_type2files(basedir):
     """Recursively walk dirs to get files & group by type (config, csv)"""
     type2files = defaultdict(set)

tests/pkgtttest/runprojs.py

@@ -2,14 +2,15 @@
 """Create and manage a set of user timetracker projects"""
 
 from os.path import join
+from os.path import dirname
+from os.path import relpath
 from logging import basicConfig
 from logging import DEBUG
 from collections import namedtuple
 from timetracker.ntcsv import get_ntcsv
 from timetracker.utils import yellow
 from timetracker.cfg.cfg import Cfg
 from timetracker.cfg.doc_local import get_docproj
-#from timetracker.cfg.cfg_global import CfgGlobal
 from timetracker.cfg.cfg_global import get_cfgglobal
 from timetracker.cfg.docutils import get_value
 from timetracker.cmd.init import run_init
@@ -21,7 +22,10 @@
 from tests.pkgtttest.consts import SEP3
 from tests.pkgtttest.runfncs import proj_setup
 from tests.pkgtttest.userprojs import UserProjects
-from tests.pkgtttest.mkprojs import prt_type2files
+from tests.pkgtttest.upstream import Upstream
+from tests.pkgtttest.mkprojs import get_type2files
+from tests.pkgtttest.mkprojs import get_files
+from tests.pkgtttest.mkprojs import prt_files
 from tests.pkgtttest.dts import get_iter_weekday
 from tests.pkgtttest.dts import td2hours
 from tests.pkgtttest.dts import I1266 as DT2525
@@ -30,23 +34,49 @@
 class RunProjs:
     """Manage all users and their projects"""
 
-    ##def __init__(self, tmproot, userprojs, fcfg_global=None):
-    def __init__(self, tmproot, userprojs, fcfg_explicit=None, fcfg_doc=None):
+    def __init__(self, tmproot, userprojs):
         self.tmproot = tmproot
         self.dirhome = join(tmproot, 'home')
         self.ups = UserProjects(userprojs)
-        ##self.cfg_global = CfgGlobal(fcfg_global)
-        self.cfg_global = get_cfgglobal(fcfg_explicit, self.dirhome, fcfg_doc)
-        self.cfg = Cfg("phoneyproj.cfg", self.cfg_global)
-        self.prj2mgrprj = {e:MngUsrProj(self.dirhome, self.cfg_global, *e) for e in userprojs}
+        self.prj2mgrprj = {(usr,prj):MngUsrProj(self.dirhome, usr, prj) for usr, prj in userprojs}
+        self.upstream = Upstream(join(self.tmproot, 'upstream'))
+        self.orig_ntcsvs = self.ups.get_expcsvs(self.tmproot)
+
+    def all_push(self):
+        """simulate a git-like push"""
+        for (_, prj), obj in self.prj2mgrprj.items():
+            dirproj = dirname(dirname(obj.cfg.cfg_loc.filename))
+            files = get_files(dirproj)
+            for absfname in files:
+                relfname = relpath(absfname, dirproj)
+                self.upstream.push(prj, absfname, relfname)
+
+    def all_pull(self):
+        """simulate a git-like pull"""
+        pull_copies_all = []
+        for (_, prj), obj in self.prj2mgrprj.items():
+            dirproj = dirname(dirname(obj.cfg.cfg_loc.filename))
+            pull_copies_cur = self.upstream.pull(prj, dirproj)
+            pull_copies_all.extend(pull_copies_cur)
+        return pull_copies_all
+
+    def prt_userfiles(self, msg='FILES FOR ALL USERNAMES', prefix='USERFILE: '):
+        """Print files for each username"""
+        if prefix:
+            prefix = f'{msg}: '
+        print(f'\n{msg}:')
+        for uname in self.ups.usernames:
+            print(f'FILES FOR USERNAME: {uname}:')
+            userhome = join(self.dirhome, uname)
+            prt_files(userhome, prefix)
 
     def get_user2glbcfg(self):
         """For each username, get their one global config file"""
         user2glbcfg = {}
         for (usr, _), obj in self.prj2mgrprj.items():
             docproj = get_docproj(obj.fcfgproj)
             fcfg_doc = get_value(docproj, 'global_config', 'filename')
-            cfg_glb = get_cfgglobal(dirhome=self.dirhome, fcfg_doc=fcfg_doc)
+            cfg_glb = get_cfgglobal(dirhome=obj.home, fcfg_doc=fcfg_doc)
             assert cfg_glb is not None
             if usr not in user2glbcfg:
                 user2glbcfg[usr] = cfg_glb
@@ -58,11 +88,9 @@ def run_setup(self):
         """Initialize and fill timeslots for multiple users and projects"""
         print(yellow(f"{SEP1}`run_init` on each project"))
         basicConfig(level=DEBUG)
-        prt_type2files(self.tmproot)
 
         print(yellow('`run_start` and `run_stop` to fill each researcher & project'))
         self._run_start_stop_all()
-        prt_type2files(self.tmproot)
 
         print(yellow('Check projects listed in CfgGlobal'))
 
@@ -72,12 +100,12 @@ def _run_start_stop_all(self):
             mgrprj = self.prj2mgrprj[usrprj]
             mgrprj.add_timeslots(times)
 
-    def chk_projects(self, exp_projects):
+    def chk_proj_configs(self, exp_fcfgprojs):
         """Check the projects"""
-        act_projs = self.cfg_global.get_projects()
-        home = self.dirhome
-        exp_projs = [[prj, join(home, rcfg)] for prj, rcfg in exp_projects]
-        assert act_projs == exp_projs, self._errmsg(act_projs, exp_projs)
+        type2files = get_type2files(self.tmproot)
+        exp_fcfgprojs = set(join(self.dirhome, f) for f in exp_fcfgprojs)
+        act_fcfgprojs = set(type2files['config'])
+        assert set(act_fcfgprojs) == set(exp_fcfgprojs), self._errmsg(act_fcfgprojs, exp_fcfgprojs)
 
     def run_hoursprojs(self):
         """print hours, iterating through all users & their projects"""
@@ -87,7 +115,7 @@ def run_hoursprojs(self):
 
             print(f'{SEP3}run_setup: run_hours project({usrprj[0]}) username({usrprj[1]})')
             # run_hours nt: RdCsvs: results errors ntcsvs
-            run1 = run_hours(self.cfg, usr, dirhome=mgrprj.home)
+            run1 = run_hours(mgrprj.cfg, usr, dirhome=mgrprj.home)
             assert td2hours(run1.results) == self._get_total_hours(usr), (
                 f'ACT({td2hours(run1.results)}) != EXP({self._get_total_hours(usr)}) '
                 f'project({usrprj[0]}) username({usrprj[1]})')
@@ -102,13 +130,13 @@ def _get_total_hours(self, usr):
         return sum(e for (u, _), (_, e) in self.ups.userprojs.items() if u == usr)
 
     @staticmethod
-    def _errmsg(act_projs, exp_projs):
+    def _errmsg(act_fcfgprojs, exp_fcfgprojs):
         txt = ['\nEXP:',]
-        for prj, fcfg in exp_projs:
-            txt.append(f'  {prj:14} {fcfg}')
+        for fcfg in sorted(exp_fcfgprojs):
+            txt.append(f'  {fcfg}')
         txt.append('\nACT:',)
-        for prj, fcfg in act_projs:
-            txt.append(f'  {prj:14} {fcfg}')
+        for fcfg in sorted(act_fcfgprojs):
+            txt.append(f'  {fcfg}')
         return '\n'.join(txt)
 
 
@@ -117,18 +145,20 @@ class MngUsrProj:
     """Manage one user and the project"""
 
     # pylint: disable=unknown-option-value,too-many-arguments,too-many-positional-arguments
-    def __init__(self, tmproot, cfg_global, user, projname, dircsv=None):
-        self.cfg_global = cfg_global
+    def __init__(self, tmproot, user, projname, dircsv=None):
         self.home = join(tmproot, user)
         self.user = user
         self.projname = projname
+        self.cfg_global = get_cfgglobal(None, self.home, fcfg_doc=None)
         ##print(f'\nMngUsrProj({self.home:29}, {user:7}, {projname})')
-        self.fcfgproj, _, self.exp = proj_setup(self.home, projname, dircur='dirproj')
-        self.cfg = run_init(self.fcfgproj,
+        self.fcfgproj, finder, self.exp = proj_setup(self.home, projname, dircur='dirproj')
+        self.cfg = Cfg(self.fcfgproj)
+        run_init(self.cfg,
+            finder.dirgit,
             dircsv=dircsv,
             project=self.projname,
             dirhome=self.home,
-            cfg_global=cfg_global,
+            cfg_global=self.cfg_global,
             quiet=True)
 
     def get_args_hours(self):