created the app structure and added a command that mocks a project attachments folder

Author: ilievss

.gitignore

@@ -1,129 +1,11 @@
+# Intellij IDEA
+.idea
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
 
 # Environments
-.env
-.venv
-env/
 venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
 
-# Pyre type checker
-.pyre/
+# logging
+log.txt

app.py

@@ -0,0 +1,56 @@
+import argparse
+
+from argparse import ArgumentDefaultsHelpFormatter
+
+import logger
+
+from command.export.issues.attachments import AttachmentsMockCommandHandler
+
+
+class Application:
+
+    def run(self):
+        # top level parser
+        parser = argparse.ArgumentParser(formatter_class=ArgumentDefaultsHelpFormatter)
+        subparsers = parser.add_subparsers(title='subcommands', description='Choose a command')
+
+        # export subcommand
+        export_parser = subparsers.add_parser('export', help='Use a subcommand')
+        export_subparser = export_parser.add_subparsers()
+
+        # issues subcommand
+        issues_parser = export_subparser.add_parser('issues')
+        issues_subparser = issues_parser.add_subparsers()
+
+        # attachments subcommand
+        attachment_parser = issues_subparser.add_parser('attachments')
+        attachment_subparsers = attachment_parser.add_subparsers()
+
+        # mock subcommand
+        mock_parser = attachment_subparsers.add_parser('mock', formatter_class=ArgumentDefaultsHelpFormatter)
+        mock_parser.add_argument('--project_key', help='the project key', default='ABC')
+        mock_parser.add_argument('--num_issues', help='the number of issue folders to create', default=10)
+        mock_parser.add_argument('--num_attachments_per_issue',
+                                 help='the number of attachment folders to create in each issue folder',
+                                 default=2)
+        mock_parser.add_argument('--fileattachment_table_csv_export_file_name',
+                                 help='the name of the mocked csv file with the fileattachment table export',
+                                 default='fileattachment.csv')
+        mock_parser.add_argument('--dates_hours_diff',
+                                 help='the hour difference acting as a timezone for the dates in the attachment '
+                                      'file names and csv export. Values is between -24 and +24. Examples: -1, +3, 0',
+                                 default=0,
+                                 type=int)
+        mock_parser.add_argument('path', help='The path where the mock directory will be created')
+        mock_parser.set_defaults(exec=AttachmentsMockCommandHandler())
+
+        args = parser.parse_args()
+        try:
+            args.exec(args)
+        except AttributeError:
+            logger.info('Please, choose a command or chain of subcommands. Use -h or --help for more details')
+
+
+if __name__ == '__main__':
+    app = Application()
+    app.run()

command/export/issues/attachments/AttachmentsMockCommandHandler.py

@@ -0,0 +1,22 @@
+from export.issues.attachments import mock_dir
+
+
+class AttachmentsMockCommandHandler:
+
+    def __call__(self, *args, **kwargs):
+        if len(args) < 1:
+            raise ValueError('Expecting at least 1 argument, got 0')
+
+        cmdline_args = args[0]
+        if 'path' not in cmdline_args:
+            raise ValueError('Parameter "path" is required!')
+
+        # take only the arguments known to the mock_dir function
+        known_arguments = {'project_key',
+                           'num_issues',
+                           'num_attachments_per_issue',
+                           'fileattachment_table_csv_export',
+                           'dates_hours_diff'}
+
+        kwargs = {k: v for k, v in cmdline_args.__dict__.items() if k in known_arguments}
+        mock_dir(cmdline_args.path, **kwargs)

command/export/issues/attachments/__init__.py

@@ -0,0 +1 @@
+from command.export.issues.attachments.AttachmentsMockCommandHandler import AttachmentsMockCommandHandler

export/issues/attachments.py

@@ -0,0 +1,73 @@
+import os
+from datetime import datetime, timezone, tzinfo, timedelta
+from random import randint
+
+current_year = datetime.now().year
+
+
+def get_random_date_underscored(date_timezone: tzinfo = None):
+    return datetime(year=randint(2005, current_year),
+                    month=randint(1, 12),
+                    day=randint(1, 28),
+                    tzinfo=date_timezone)\
+        .strftime('%Y_%m_%d')
+
+
+def get_random_date_iso(date_timezone=None):
+
+    return datetime(year=randint(2005, current_year),
+                    month=randint(1, 12),
+                    day=randint(1, 28),
+                    tzinfo=date_timezone)\
+        .isoformat()
+
+
+def mkdir_if_not_exists(path):
+    try:
+        # create the directory if it doesn't already exist
+        os.mkdir(path)
+    except FileExistsError:
+        # ignore the error, this means the path exists
+        pass
+
+
+def mock_dir(path, project_key='ABC', num_issues=10, num_attachments_per_issue=2,
+             fileattachment_table_csv_export_file_name='fileattachment.csv', dates_hours_diff=0):
+
+    if not project_key:
+        raise ValueError('project_key cannot be empty')
+
+    if 1 > num_issues > 10000:
+        raise ValueError('num_issues cannot be less than 1 or more than 10 000')
+
+    if 1 > num_attachments_per_issue > 100:
+        raise ValueError('num_attachments_per_issue cannot be less than 1 or more than 100')
+
+    if not fileattachment_table_csv_export_file_name:
+        raise ValueError('fileattachment_table_csv_export cannot be empty')
+
+    mkdir_if_not_exists(path)
+
+    dates_timezone = timezone(timedelta(hours=dates_hours_diff))
+    with open(f'{path}/{fileattachment_table_csv_export_file_name}', 'w') as f:
+        # write the header for the csv
+        f.write('id,issueid,mimetype,filename,created,filesize,author,zip,thumbnailable\n')
+
+        issue_id = 100
+        attachment_id = 1
+        for issue_key in range(1, num_issues + 1):
+            issue_path = f'{path}/{project_key}-{issue_key}'
+            mkdir_if_not_exists(issue_path)
+
+            for _ in range(num_attachments_per_issue):
+                with open(f'{issue_path}/{attachment_id}', 'w') as _:
+                    pass
+
+                mime_type = 'image/png'
+                file_name = f'Screenshot_{get_random_date_underscored(dates_timezone)}.png'
+                created = get_random_date_iso(dates_timezone)
+                file_size = randint(1000, 10000)
+                f.write(f'{attachment_id},{issue_id},{mime_type},{file_name},{created},{file_size},unknown,,1\n')
+                attachment_id += 1
+
+            issue_id += 1

logger.py

@@ -0,0 +1,24 @@
+import logging
+import sys
+
+LOGGER_NAME = 'jira-bot'
+
+_logger = logging.getLogger(LOGGER_NAME)
+_logger.setLevel(logging.INFO)
+
+# create logger formatter
+_formatter = logging.Formatter("%(asctime)s:%(levelname)s:%(message)s")
+
+# log to stdout
+_stdout_handler = logging.StreamHandler(sys.stdout)
+_stdout_handler.setFormatter(_formatter)
+_logger.addHandler(_stdout_handler)
+
+# log the same to a file
+_file_handler = logging.FileHandler('log.txt')
+_file_handler.setFormatter(_formatter)
+_logger.addHandler(_file_handler)
+
+
+def info(message, *args, **kwargs):
+    _logger.info(message, *args, **kwargs)