ositah 23.8.dev1__tar.gz → 24.2.dev1__tar.gz

{ositah-23.8.dev1 → ositah-24.2.dev1}/.gitlab-ci.yml

@@ -1,14 +1,14 @@
-default:
-    tags:
-        # Ensure that the pipeline is executed in IJCLab intranet - TO BE CHANGED
-        - oval-checks
-
 stages:
     - build
 
 build:
     stage: build
     script:
+        - apk add --update python3
+        - python --version
+        - python -m venv .venv
+        - . .venv/bin/activate
+        - python -m ensurepip
         - pip install nox pyproject-parser consolekit
         - nox -s lint
         - pyproject-parser check

{ositah-23.8.dev1/ositah.egg-info → ositah-24.2.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ositah
-Version: 23.8.dev1
+Version: 24.2.dev1
 Summary: Outils de Suivi d'Activités basé sur Hito
 Author-email: Michel Jouvin <michel.jouvin@ijclab.in2p3.fr>
 License: BSD 3-Clause License
@@ -12,6 +12,20 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: blinker
+Requires-Dist: dash
+Requires-Dist: dash-bootstrap-components
+Requires-Dist: flask~=2.2
+Requires-Dist: flask-multipass
+Requires-Dist: flask-sqlalchemy~=3.0
+Requires-Dist: flask-wtf
+Requires-Dist: hito-tools>=23.2
+Requires-Dist: pandas==2.*
+Requires-Dist: pymysql
+Requires-Dist: python-ldap
+Requires-Dist: pyyaml
+Requires-Dist: simplejson
+Requires-Dist: sqlalchemy~=2.0
 
 # OSITAH : Outil de Suivi de Temps et d'Activités basé sur Hito
 

{ositah-23.8.dev1 → ositah-24.2.dev1}/ositah/apps/configuration/main.py

@@ -197,9 +197,11 @@ def declaration_periods_layout():
                         width={"size": 3, "offset": 0},
                     ),
                     dbc.Tooltip(
-                        "Le semestre courant existe déjà"
-                        if current_period_exists
-                        else "Ajoute le semestre courant",
+                        (
+                            "Le semestre courant existe déjà"
+                            if current_period_exists
+                            else "Ajoute le semestre courant"
+                        ),
                         target=DECLARATION_PERIODS_CREATE_DIV_ID,
                         placement="bottom",
                     ),

{ositah-23.8.dev1 → ositah-24.2.dev1}/ositah/apps/export.py

@@ -338,10 +338,14 @@ def nsip_export_table(team, team_selection_date, period_date: str, declarations_
             declaration_list.loc[
                 declaration_list["_merge"] == "both", "mgr_val_time_mismatch"
             ] = declaration_list[declaration_list["_merge"] == "both"].apply(
-                lambda r: False
-                if r["managerValidationDate"]
-                and re.match(r["managerValidationDate"], r["validation_time"].date().isoformat())
-                else True,
+                lambda r: (
+                    False
+                    if r["managerValidationDate"]
+                    and re.match(
+                        r["managerValidationDate"], r["validation_time"].date().isoformat()
+                    )
+                    else True
+                ),
                 axis=1,
             )
             # nsip_missing is True if the OSITAH declaration has no matching declaration in NSIP
@@ -358,9 +362,9 @@ def nsip_export_table(team, team_selection_date, period_date: str, declarations_
                 "time": "time_nsipd",
                 "time_unit": "volume",
             }.items():
-                declaration_list.loc[
-                    declaration_list["ositah_missing"], ositah_column
-                ] = declaration_list[nsip_column]
+                declaration_list.loc[declaration_list["ositah_missing"], ositah_column] = (
+                    declaration_list[nsip_column]
+                )
             # Fix nsip_project if it was set to the project name when the activity is a reference
             declaration_list.loc[
                 declaration_list["nsip_project"].isna()
@@ -416,9 +420,9 @@ def nsip_export_table(team, team_selection_date, period_date: str, declarations_
         # Rset nsip_project_id and nsip_reference_id to NaN if they are equal to 0 so that the
         # corresponding cell is empty
         declaration_list.loc[declaration_list["nsip_project_id"] == 0, "nsip_project_id"] = np.NaN
-        declaration_list.loc[
-            declaration_list["nsip_reference_id"] == 0, "nsip_reference_id"
-        ] = np.NaN
+        declaration_list.loc[declaration_list["nsip_reference_id"] == 0, "nsip_reference_id"] = (
+            np.NaN
+        )
 
         # Sort declarations by email_auth and add index value as column for easier further
         # processing
@@ -483,9 +487,11 @@ def nsip_export_table(team, team_selection_date, period_date: str, declarations_
                 [
                     html.Th(
                         [
-                            dbc.Checkbox(id=NSIP_EXPORT_SELECT_ALL_ID)
-                            if selected_declarations["selectable"].any()
-                            else html.Div(),
+                            (
+                                dbc.Checkbox(id=NSIP_EXPORT_SELECT_ALL_ID)
+                                if selected_declarations["selectable"].any()
+                                else html.Div()
+                            ),
                             dcc.Store(id=NSIP_EXPORT_ALL_SELECTED_ID, data=0),
                         ]
                     ),
@@ -560,23 +566,25 @@ def nsip_build_user_declarations(declarations, agent_email, data_columns):
         # (rowSpan is in fact the number of Tr following this one attached to it)
         html.Tr(
             [
-                html.Td(
-                    [
-                        dbc.Checkbox(
-                            id={"type": "nsip-export-user", "id": agent_email},
-                            class_name="nsip-agent-selector",
-                            value=False,
-                        ),
-                        dcc.Store(
-                            id={"type": "nsip-export-user-selected", "id": agent_email},
-                            data=0,
-                        ),
-                    ],
-                    className="align-middle ",
-                    rowSpan=len(user_declarations) + 1,
-                )
-                if user_declarations["selectable"].any()
-                else html.Td(rowSpan=len(user_declarations) + 1),
+                (
+                    html.Td(
+                        [
+                            dbc.Checkbox(
+                                id={"type": "nsip-export-user", "id": agent_email},
+                                class_name="nsip-agent-selector",
+                                value=False,
+                            ),
+                            dcc.Store(
+                                id={"type": "nsip-export-user-selected", "id": agent_email},
+                                data=0,
+                            ),
+                        ],
+                        className="align-middle ",
+                        rowSpan=len(user_declarations) + 1,
+                    )
+                    if user_declarations["selectable"].any()
+                    else html.Td(rowSpan=len(user_declarations) + 1)
+                ),
                 nsip_build_poject_declaration_cell(user_declarations, "email_auth", None),
                 dcc.Store(
                     id={"type": "nsip-selected-user", "id": agent_email},

{ositah-23.8.dev1 → ositah-24.2.dev1}/ositah/apps/validation/callbacks.py

@@ -196,8 +196,9 @@ def validation_button_callback(value, agent_id, team, team_selection_date, perio
                 session.add(validation_data)
                 # A flush() is required before calling project_declaration_snapshot() else the
                 # first insert is lost
-                # MJ 2023-07-12: hack to workaround a problem with flush() leading to an undefined foreign key
-                #session.flush()
+                # MJ 2023-07-12: hack to workaround a problem with flush() leading to an undefined
+                # foreign key
+                # session.flush()
                 session.commit()
                 project_declaration_snapshot(
                     agent_id,

{ositah-23.8.dev1 → ositah-24.2.dev1}/ositah/apps/validation/tables.py

@@ -27,8 +27,8 @@ from ositah.apps.validation.tools import (
     validation_started,
 )
 from ositah.utils.agents import get_agents
-from ositah.utils.exceptions import SessionDataMissing
-from ositah.utils.menus import TABLE_TYPE_TABLE, build_accordion
+from ositah.utils.exceptions import InvalidHitoProjectName, SessionDataMissing
+from ositah.utils.menus import TABLE_TYPE_TABLE, build_accordion, ositah_jumbotron
 from ositah.utils.projects import (
     CATEGORY_DEFAULT,
     DATA_SOURCE_HITO,
@@ -72,9 +72,17 @@ def build_validation_table(team, team_selection_date, declaration_set: int, peri
 
     validation_data = get_all_validation_status(period_date)
 
-    project_declarations = get_team_projects(
-        team, team_selection_date, period_date, DATA_SOURCE_HITO
-    )
+    try:
+        project_declarations = get_team_projects(
+            team, team_selection_date, period_date, DATA_SOURCE_HITO
+        )
+    except InvalidHitoProjectName as e:
+        return ositah_jumbotron(
+            "Error loading projects",
+            e.msg,
+            title_class="text-danger",
+        )
+
     if project_declarations is None:
         return html.Div(
             [
@@ -95,9 +103,17 @@ def build_validation_table(team, team_selection_date, declaration_set: int, peri
     data_columns = [CATEGORY_DEFAULT]
     data_columns.extend(global_params.project_categories.keys())
 
-    validated_project_declarations = get_team_projects(
-        team, team_selection_date, period_date, DATA_SOURCE_OSITAH, use_cache=False
-    )
+    try:
+        validated_project_declarations = get_team_projects(
+            team, team_selection_date, period_date, DATA_SOURCE_OSITAH, use_cache=False
+        )
+    except InvalidHitoProjectName as e:
+        return ositah_jumbotron(
+            "Error loading projects",
+            e.msg,
+            title_class="text-danger",
+        )
+
     if validated_project_declarations is None:
         declaration_list["validated"] = False
         declaration_list["hito_missing"] = False
@@ -127,12 +143,12 @@ def build_validation_table(team, team_selection_date, declaration_set: int, peri
             declaration_list.loc[declaration_list["hito_missing"]] = declaration_list.fillna(
                 value=columns_fillna
             )
-            declaration_list.loc[
-                declaration_list["hito_missing"], column_names["fullname"]
-            ] = declaration_list[f"{column_names['fullname']}_val"]
-            declaration_list.loc[
-                declaration_list["hito_missing"], column_names["team"]
-            ] = declaration_list[f"{column_names['team']}_val"]
+            declaration_list.loc[declaration_list["hito_missing"], column_names["fullname"]] = (
+                declaration_list[f"{column_names['fullname']}_val"]
+            )
+            declaration_list.loc[declaration_list["hito_missing"], column_names["team"]] = (
+                declaration_list[f"{column_names['team']}_val"]
+            )
             declaration_list.loc[declaration_list["hito_missing"], "suspect"] = True
             declaration_list.loc[declaration_list["hito_missing"], "validation_disabled"] = True
             declaration_list.sort_values(by=column_names["fullname"], inplace=True)
@@ -203,9 +219,11 @@ def build_validation_table(team, team_selection_date, declaration_set: int, peri
                                     selected_declarations.iloc[i - 1][column_names["fullname"]]
                                 ),
                                 agent_tooltip_txt(selected_declarations.iloc[i - 1], data_columns),
-                                "validated_hito_missing"
-                                if selected_declarations.iloc[i - 1]["hito_missing"]
-                                else "",
+                                (
+                                    "validated_hito_missing"
+                                    if selected_declarations.iloc[i - 1]["hito_missing"]
+                                    else ""
+                                ),
                             ),
                             className="accordion",
                             key=f"validation-table-cell-{i}-fullname",
@@ -314,7 +332,14 @@ def build_missing_agents_table(team, team_selection_date, period_date: str):
     column_names = global_params.columns
     declaration_options = global_params.declaration_options
 
-    declarations = get_team_projects(team, team_selection_date, period_date)
+    try:
+        declarations = get_team_projects(team, team_selection_date, period_date)
+    except InvalidHitoProjectName as e:
+        return ositah_jumbotron(
+            "Error loading projects",
+            e.msg,
+            title_class="text-danger",
+        )
 
     agents = get_agents(period_date)
 
@@ -425,7 +450,15 @@ def build_statistics_table(team, team_selection_date, period_date: str):
     except SessionDataMissing:
         return no_session_id_jumbotron()
 
-    declarations = get_team_projects(team, team_selection_date, period_date)
+    try:
+        declarations = get_team_projects(team, team_selection_date, period_date)
+    except InvalidHitoProjectName as e:
+        return ositah_jumbotron(
+            "Error loading projects",
+            e.msg,
+            title_class="text-danger",
+        )
+
     agents = get_agents(period_date)
     if team == TEAM_LIST_ALL_AGENTS:
         agent_list = agents

{ositah-23.8.dev1 → ositah-24.2.dev1}/ositah/main.py

@@ -33,6 +33,7 @@ from ositah.utils.menus import (
     TEAM_SELECTED_VALUE_ID,
     TEAM_SELECTION_DATE_ID,
     VALIDATION_PERIOD_SELECTED_ID,
+    ositah_jumbotron,
 )
 from ositah.utils.utils import (
     AUTHORIZED_ROLES,
@@ -104,23 +105,21 @@ def default_config_path() -> str:
     return config_file
 
 
-# URL not found jumbletron
+# URL not found jumbotron
 def url_not_found(path):
-    return dbc.Jumbotron(
-        [
-            html.H1("404: Not found", className="text-danger"),
-            html.Hr(),
-            html.P(f"URL {path} was not recognised..."),
-        ]
+    return ositah_jumbotron(
+        "404: Not found",
+        f"URL {path} was not recognised...",
+        title_class="text-danger",
     )
 
 
-# URL not found jumbletron
+# valid role missing jumbotron
 def valid_role_missing(msg):
-    return dbc.Jumbotron(
-        [
-            html.P(msg),
-        ]
+    return ositah_jumbotron(
+        "You don't havea valid Hito role to OSITAH",
+        msg,
+        title_class="text-warning",
     )
 
 

{ositah-23.8.dev1 → ositah-24.2.dev1}/ositah/utils/exceptions.py

@@ -1,52 +1,64 @@
-# OSITAH exceptions not specific to one of the sub-application
-
-from hito_tools.exceptions import EXIT_STATUS_GENERAL_ERROR
-
-
-class InvalidCallbackInput(Exception):
-    def __init__(self, input_name):
-        self.msg = f"internal error: invalid input ({input_name}) in callback"
-        self.status = EXIT_STATUS_GENERAL_ERROR
-
-    def __str__(self):
-        return repr(self.msg)
-
-
-class InvalidDataSource(Exception):
-    def __init__(self, source):
-        self.msg = f"attempt to use and invalid data source ({source})"
-        self.status = EXIT_STATUS_GENERAL_ERROR
-
-    def __str__(self):
-        return repr(self.msg)
-
-
-class SessionDataMissing(Exception):
-    def __init__(self, session_id=None):
-        if session_id:
-            session_txt = f" (session={session_id})"
-        else:
-            session_txt = ""
-        self.msg = f"Attempt to use non existing session data{session_txt}"
-        self.status = EXIT_STATUS_GENERAL_ERROR
-
-    def __str__(self):
-        return repr(self.msg)
-
-
-class ValidationPeriodAmbiguous(Exception):
-    def __init__(self, date):
-        self.msg = f"Configuration error: several periods matching {date}"
-        self.status = EXIT_STATUS_GENERAL_ERROR
-
-    def __str__(self):
-        return repr(self.msg)
-
-
-class ValidationPeriodMissing(Exception):
-    def __init__(self, date):
-        self.msg = f"No defined declaration period matching {date}"
-        self.status = EXIT_STATUS_GENERAL_ERROR
-
-    def __str__(self):
-        return repr(self.msg)
+# OSITAH exceptions not specific to one of the sub-application
+
+from hito_tools.exceptions import EXIT_STATUS_GENERAL_ERROR
+
+
+class InvalidCallbackInput(Exception):
+    def __init__(self, input_name):
+        self.msg = f"internal error: invalid input ({input_name}) in callback"
+        self.status = EXIT_STATUS_GENERAL_ERROR
+
+    def __str__(self):
+        return repr(self.msg)
+
+
+class InvalidDataSource(Exception):
+    def __init__(self, source):
+        self.msg = f"attempt to use and invalid data source ({source})"
+        self.status = EXIT_STATUS_GENERAL_ERROR
+
+    def __str__(self):
+        return repr(self.msg)
+
+
+class InvalidHitoProjectName(Exception):
+    def __init__(self, projects):
+        self.msg = (
+            f"The following Hito project names don't match the format 'masterproject / project' :"
+            f" {', '.join(projects)}"
+        )
+        self.status = EXIT_STATUS_GENERAL_ERROR
+
+    def __str__(self):
+        return repr(self.msg)
+
+
+class SessionDataMissing(Exception):
+    def __init__(self, session_id=None):
+        if session_id:
+            session_txt = f" (session={session_id})"
+        else:
+            session_txt = ""
+        self.msg = f"Attempt to use non existing session data{session_txt}"
+        self.status = EXIT_STATUS_GENERAL_ERROR
+
+    def __str__(self):
+        return repr(self.msg)
+
+
+class ValidationPeriodAmbiguous(Exception):
+    def __init__(self, date):
+        self.msg = f"Configuration error: several periods matching {date}"
+        self.status = EXIT_STATUS_GENERAL_ERROR
+
+    def __str__(self):
+        return repr(self.msg)
+
+
+class ValidationPeriodMissing(Exception):
+    def __init__(self, date):
+        self.msg = f"No defined declaration period matching {date}"
+        self.status = EXIT_STATUS_GENERAL_ERROR
+
+    def __str__(self):
+        return repr(self.msg)

{ositah-23.8.dev1 → ositah-24.2.dev1}/ositah/utils/menus.py

@@ -153,9 +153,11 @@ def create_progress_bar(
 
     return html.Div(
         [
-            html.Div(f"Chargement des données de l'équipe {team} en cours...")
-            if team
-            else html.Div(),
+            (
+                html.Div(f"Chargement des données de l'équipe {team} en cours...")
+                if team
+                else html.Div()
+            ),
             dcc.Interval(
                 id="progress-interval",
                 max_intervals=max_intervals,
@@ -306,3 +308,32 @@ app.clientside_callback(
     State({"type": TABLE_TYPE_TABLE, "id": MATCH}, "id"),
     prevent_initial_call=True,
 )
+
+
+# Emulate former Jumbotron
+def ositah_jumbotron(title: str, main_text: str, details: str = None, title_class: str = None):
+    """
+    Emulate Jumbotron component available in Bootstrap v4
+
+    :param title: Jumbotron title
+    :param main_text: main text
+    :param details: optional additional text
+    :return: html.div()
+    """
+
+    return html.Div(
+        dbc.Container(
+            [
+                html.H1(title, className=f"display-3 {title_class if ( title_class ) else ''}"),
+                html.P(
+                    main_text,
+                    className="lead",
+                ),
+                html.Hr(className="my-2"),
+                html.P(details),
+            ],
+            fluid=True,
+            className="py-3",
+        ),
+        className="p-3 bg-light rounded-3",
+    )

{ositah-23.8.dev1 → ositah-24.2.dev1}/ositah/utils/projects.py

@@ -10,7 +10,7 @@ from sqlalchemy.orm import joinedload
 
 from ositah.utils.agents import get_agents
 from ositah.utils.cache import clear_cached_data
-from ositah.utils.exceptions import InvalidDataSource
+from ositah.utils.exceptions import InvalidDataSource, InvalidHitoProjectName
 from ositah.utils.hito_db import get_db
 from ositah.utils.period import get_validation_period_data
 from ositah.utils.utils import (
@@ -306,9 +306,9 @@ def get_team_projects(
         # Drop statut column to avoid conflicts in future merge with the Agent table
         declarations.drop(columns=["statut"], inplace=True)
         # Ensure that email_auth is defined and if it is not, replace it by the email.
-        declarations.loc[
-            declarations[columns["email_auth"]].isna(), columns["email_auth"]
-        ] = declarations[columns["email"]]
+        declarations.loc[declarations[columns["email_auth"]].isna(), columns["email_auth"]] = (
+            declarations[columns["email"]]
+        )
         declarations[columns["activity"]] = declarations.apply(
             lambda row: ositah2hito_project_name(
                 row[columns["masterproject"]], row[columns["project"]]
@@ -410,16 +410,23 @@ def get_team_projects(
             if column not in saved_projects.columns:
                 saved_projects[column] = np.NaN
         declarations = declarations.join(saved_projects)
-        declarations.loc[
-            declarations.project_saved.notna(), columns["masterproject"]
-        ] = declarations.newmaster
-        declarations.loc[
-            declarations.project_saved.notna(), columns["project"]
-        ] = declarations.newproject
+        declarations.loc[declarations.project_saved.notna(), columns["masterproject"]] = (
+            declarations.newmaster
+        )
+        declarations.loc[declarations.project_saved.notna(), columns["project"]] = (
+            declarations.newproject
+        )
         declarations.drop(columns=["newmaster", "newproject"], inplace=True)
-        declarations.loc[
-            declarations.project_saved.notna(), columns["activity"]
-        ] = declarations.project_saved
+        declarations.loc[declarations.project_saved.notna(), columns["activity"]] = (
+            declarations.project_saved
+        )
+
+        # Detect project names not matching the format "masterproject / project"
+        invalid_hito_projects = declarations.loc[declarations[columns["project"]].isnull()]
+        if not invalid_hito_projects.empty:
+            raise InvalidHitoProjectName(
+                pd.Series(invalid_hito_projects[columns["masterproject"]]).unique()
+            )
 
     else:
         raise InvalidDataSource(source)
@@ -577,12 +584,12 @@ def get_hito_nsip_activities(project_activity: bool = True):
             np.NaN,
         ]
     else:
-        activities[
-            ["nsip_master", "nsip_project", "nsip_project_id", "nsip_reference_id"]
-        ] = activities.apply(
-            lambda v: nsip_activity_name_id(v["nsip_name_id"], v["class"]),
-            axis=1,
-            result_type="expand",
+        activities[["nsip_master", "nsip_project", "nsip_project_id", "nsip_reference_id"]] = (
+            activities.apply(
+                lambda v: nsip_activity_name_id(v["nsip_name_id"], v["class"]),
+                axis=1,
+                result_type="expand",
+            )
         )
         activities["nsip_project_id"] = activities["nsip_project_id"].astype(int)
         activities["nsip_reference_id"] = activities["nsip_reference_id"].astype(int)

{ositah-23.8.dev1 → ositah-24.2.dev1}/ositah/utils/utils.py

@@ -328,9 +328,9 @@ def define_config_params(file):
     if "agent_query" not in config["hito"]["db"]:
         raise ConfigMissingParam("hito/db/agent_query", file)
     if config["hito"]["db"]["type"] == "sqlite":
-        app.server.config[
-            "SQLALCHEMY_DATABASE_URI"
-        ] = f"sqlite:///{config['hito']['db']['location']}"
+        app.server.config["SQLALCHEMY_DATABASE_URI"] = (
+            f"sqlite:///{config['hito']['db']['location']}"
+        )
     elif config["hito"]["db"]["type"] == "mysql":
         if "user" not in config["hito"]["db"]:
             raise ConfigMissingParam("hito/db/user", file)

{ositah-23.8.dev1 → ositah-24.2.dev1/ositah.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ositah
-Version: 23.8.dev1
+Version: 24.2.dev1
 Summary: Outils de Suivi d'Activités basé sur Hito
 Author-email: Michel Jouvin <michel.jouvin@ijclab.in2p3.fr>
 License: BSD 3-Clause License
@@ -12,6 +12,20 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: blinker
+Requires-Dist: dash
+Requires-Dist: dash-bootstrap-components
+Requires-Dist: flask~=2.2
+Requires-Dist: flask-multipass
+Requires-Dist: flask-sqlalchemy~=3.0
+Requires-Dist: flask-wtf
+Requires-Dist: hito-tools>=23.2
+Requires-Dist: pandas==2.*
+Requires-Dist: pymysql
+Requires-Dist: python-ldap
+Requires-Dist: pyyaml
+Requires-Dist: simplejson
+Requires-Dist: sqlalchemy~=2.0
 
 # OSITAH : Outil de Suivi de Temps et d'Activités basé sur Hito
 

{ositah-23.8.dev1 → ositah-24.2.dev1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ositah"
-version = "23.8.dev1"
+version = "24.2.dev1"
 description = "Outils de Suivi d'Activités basé sur Hito"
 readme = "README.md"
 requires-python = ">=3.8"