unit test for token usage

Author: PeeachPie

.github/workflows/tests.yml

@@ -51,3 +51,23 @@ jobs:
 
     - name: Show out.csv
       run: cat out.csv
+
+token-usage-unit_test:
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Cache pip
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Install dependencies
+      run: pip install -r requirements.txt
+
+    - name: Run test
+      run: python3 test_token_usage.py --tt1 ${{ secrets.TEST_TOKEN_GITHUB }} -tt2 ${{ secrets.SECOND_TEST_TOKEN_GITHUB }} --repo moevm/github_repo_commitment_calc --out out.csv

ForgejoRepoAPI.py

@@ -1,21 +1,12 @@
-from interface_wrapper import (
-    logging,
-    IRepositoryAPI,
-    Repository,
-    Commit,
-    Branch,
-    User,
-    Contributor,
-    Issue,
-    PullRequest,
-    WikiPage,
-    Comment,
-    Invite,
-)
 import base64
 import sys
-from pyforgejo import PyforgejoApi
+
 import isodate
+from pyforgejo import PyforgejoApi
+
+from interface_wrapper import (Branch, Comment, Commit, Contributor, Invite,
+                               IRepositoryAPI, Issue, PullRequest, Repository,
+                               User, WikiPage, logging)
 
 
 class ForgejoRepoAPI(IRepositoryAPI):

GitHubRepoAPI.py

@@ -1,17 +1,6 @@
-from interface_wrapper import (
-    logging,
-    Repository,
-    Contributor,
-    Commit,
-    Issue,
-    PullRequest,
-    WikiPage,
-    Branch,
-    IRepositoryAPI,
-    User,
-    Comment,
-    Invite,
-)
+from interface_wrapper import (Branch, Comment, Commit, Contributor, Invite,
+                               IRepositoryAPI, Issue, PullRequest, Repository,
+                               User, WikiPage, logging)
 
 from github import Github, GithubException
 
@@ -117,7 +106,6 @@ def get_issues(self, repo: Repository) -> list[Issue]:
     def get_pull_requests(self, repo: Repository) -> list[PullRequest]:
         try:
             pulls = self.client.get_repo(repo._id).get_pulls(state='all')
-            print(dir(pulls[0].merged_by))
             return [
                 PullRequest(
                     _id=p.number,

commits_parser.py

@@ -1,24 +1,24 @@
-from utils import logger
-import pytz
+from dataclasses import asdict, dataclass
 from time import sleep
+from typing import Generator
+from datetime import datetime
+
+import pytz
 
-# from github import Github, Repository, GithubException, PullRequest
+from constants import EMPTY_FIELD, GOOGLE_MAX_CELL_LEN, TIMEDELTA, TIMEZONE
 from interface_wrapper import IRepositoryAPI, Repository
+from utils import logger
+
 
-EMPTY_FIELD = 'Empty field'
-TIMEDELTA = 0.05
-TIMEZONE = 'Europe/Moscow'
-FIELDNAMES = (
-    'repository name',
-    'author name',
-    'author login',
-    'author email',
-    'date and time',
-    'changed files',
-    'commit id',
-    'branch',
-)
-GOOGLE_MAX_CELL_LEN = 50000
+@dataclass(kw_only=True, frozen=True)
+class CommitData:
+    repository_name: str = ''
+    author_name: str = ''
+    author_email: str = ''
+    datetime: str = ''
+    changed_files: str = ''
+    commit_id: str = ''
+    branch: str = ''
 
 
 def log_repository_commits(
@@ -45,29 +45,36 @@ def log_repository_commits(
                 continue
 
             changed_files = '; '.join([file for file in commit.files])
-            commit_data = [
-                repository.name,
-                commit.author.username,
-                commit.author.email or EMPTY_FIELD,
-                commit.date,
-                changed_files[:GOOGLE_MAX_CELL_LEN],
-                commit._id,
-                branch,
-            ]
-            info = dict(zip(FIELDNAMES, commit_data))
+            changed_files = changed_files[:GOOGLE_MAX_CELL_LEN]
+            commit_data = CommitData(
+                repository_name=repository.name,
+                author_name=commit.author.username,
+                author_email=commit.author.email or EMPTY_FIELD,
+                datetime=commit.date.astimezone(pytz.timezone(TIMEZONE)).isoformat(),
+                changed_files=changed_files,
+                commit_id=commit._id,
+                branch=branch,
+            )
+            info = asdict(commit_data)
 
-            logger.log_to_csv(csv_name, FIELDNAMES, info)
+            logger.log_to_csv(csv_name, list(info.keys()), info)
             logger.log_to_stdout(info)
 
             sleep(TIMEDELTA)
 
 
 def log_commits(
-    client: IRepositoryAPI, working_repos, csv_name, start, finish, branch, fork_flag
+    binded_repos: Generator[tuple[IRepositoryAPI, Repository, str], None],
+    csv_name: str,
+    start: datetime,
+    finish: datetime,
+    branch: str,
+    fork_flag: bool,
 ):
-    logger.log_to_csv(csv_name, FIELDNAMES)
+    info = asdict(CommitData())
+    logger.log_to_csv(csv_name, list(info.keys()))
 
-    for repo, token in working_repos:
+    for client, repo, token in binded_repos:
         try:
             logger.log_title(repo.name)
             log_repository_commits(client, repo, csv_name, start, finish, branch)

constants.py

@@ -0,0 +1,18 @@
+EMPTY_FIELD = 'Empty field'
+TIMEDELTA = 0.05
+TIMEZONE = 'Europe/Moscow'
+GOOGLE_MAX_CELL_LEN = 50000
+TITLE_LEN = 80
+MIN_SIDE_PADDING = 4
+SIDE_WHITE_SPACES = 1
+WIKI_FIELDNAMES = [
+    'repository name',
+    'author name',
+    'author login',
+    'datetime',
+    'page',
+    'action',
+    'revision id',
+    'added lines',
+    'deleted lines',
+]

contributors_parser.py

@@ -1,25 +1,26 @@
-from utils import logger
+from dataclasses import asdict, dataclass
 from time import sleep
 from typing import Generator
+from datetime import datetime
+
+from constants import EMPTY_FIELD, TIMEDELTA
 from interface_wrapper import IRepositoryAPI, Repository
+from utils import logger
+
 
-EMPTY_FIELD = 'Empty field'
-TIMEDELTA = 0.05
-TIMEZONE = 'Europe/Moscow'
-FIELDNAMES = (
-    'repository name',
-    'login',
-    'name',
-    'email',
-    'url',
-    'permissions',
-    'total_commits',
-    'id',
-    'node_id',
-    'type',
-    'bio',
-    'site_admin',
-)
+@dataclass(kw_only=True, frozen=True)
+class ContributorData:
+    repository_name: str = ''
+    login: str = ''
+    name: str = ''
+    email: str = ''
+    url: str = ''
+    permissions: str = ''
+    total_commits: int = 0
+    node_id: str = ''
+    type: str = ''
+    bio: str = ''
+    site_admin: bool = False
 
 
 def log_repository_contributors(
@@ -36,22 +37,24 @@ def nvl(val):
             repository, contributor
         )
 
-        info_tmp = {
-            'repository name': repository.name,
-            'login': contributor.login,
-            'name': nvl(contributor.username),
-            'email': nvl(contributor_stat['email']),
-            'url': contributor.html_url,
-            'permissions': nvl(contributor_permissions),
-            'total_commits': contributor_stat['total_commits'],
-            'node_id': contributor.node_id,
-            'type': contributor.type,
-            'bio': nvl(contributor.bio),
-            'site_admin': contributor.site_admin,
-        }
-
-        logger.log_to_csv(csv_name, FIELDNAMES, info_tmp)
-        logger.log_to_stdout(info_tmp)
+        contributor_data = ContributorData(
+            repository_name=repository.name,
+            login=contributor.login,
+            name=nvl(contributor.username),
+            email=nvl(contributor_stat['email']),
+            url=contributor.html_url,
+            permissions=nvl(contributor_permissions),
+            total_commits=contributor_stat['total_commits'],
+            node_id=contributor.node_id,
+            type=contributor.type,
+            bio=nvl(contributor.bio),
+            site_admin=contributor.site_admin,
+        )
+
+        info_dict = asdict(contributor_data)
+
+        logger.log_to_csv(csv_name, list(info_dict.keys()), info_dict)
+        logger.log_to_stdout(info_dict)
 
         sleep(TIMEDELTA)
 
@@ -78,11 +81,14 @@ def get_contributors_stats(client: IRepositoryAPI, repository: Repository) -> di
 
 
 def log_contributors(
-    client: IRepositoryAPI, working_repos: Generator, csv_name: str, fork_flag: bool
+    binded_repos: Generator[tuple[IRepositoryAPI, Repository, str], None],
+    csv_name: str,
+    fork_flag: bool,
 ):
-    logger.log_to_csv(csv_name, FIELDNAMES)
+    info = asdict(ContributorData())
+    logger.log_to_csv(csv_name, list(info.keys()))
 
-    for repo, token in working_repos:
+    for client, repo, token in binded_repos:
         try:
             logger.log_title(repo.name)
             log_repository_contributors(client, repo, csv_name)

export_sheets.py

@@ -1,5 +1,5 @@
-import pygsheets
 import pandas as pd
+import pygsheets
 
 INT_MASS = [{"one": 1, "two": 2, "what?": 3}]
 

git_logger.py

@@ -1,7 +1,7 @@
-from interface_wrapper import RepositoryFactory, IRepositoryAPI
 from time import sleep
 
-TIMEDELTA = 0.05
+from constants import TIMEDELTA
+from interface_wrapper import IRepositoryAPI, RepositoryFactory
 
 def login(source, token, base_url):
     client = RepositoryFactory.create_api(source, token, base_url)
@@ -21,7 +21,6 @@ def get_repos_from_file(repos_path: str) -> list[str]:
 
     return list_repos
 
-
 class Clients:
     def __init__(self, source: str, tokens: list[str], base_url: str | None = None):
         # Возможно это можно переписать покрасивее

interface_wrapper.py

@@ -1,7 +1,7 @@
+import logging
 from abc import ABC, abstractmethod
-from datetime import datetime
 from dataclasses import dataclass
-import logging
+from datetime import datetime
 
 from github import Github, Auth
 from pyforgejo import PyforgejoApi
@@ -178,8 +178,8 @@ class RepositoryFactory:
     def create_api(
         source: str, token: str, base_url: str | None = None
     ) -> IRepositoryAPI:
-        from GitHubRepoAPI import GitHubRepoAPI
         from ForgejoRepoAPI import ForgejoRepoAPI
+        from GitHubRepoAPI import GitHubRepoAPI
 
         if source == 'github':
             return GitHubRepoAPI(Github(auth=Auth.Token(token)))