troggle/lib/version_control.py

import troggle.settings as settings
import subprocess

def write_and_commit(files, message):
    """Writes the content to the filepath and adds and commits the file to git.  If this fails, a WriteAndCommitError is raised."""
    git = settings.GIT
    try:
        for filepath, content, encoding in files:
            cwd = filepath.parent
            filename = filepath.name
            # GIT see also core/models/cave.py writetrogglefile()
            # GIT see also core/views/uploads.py dwgupload()
    
            if encoding:
                mode = "w"
                kwargs = {"encoding": encoding}
            else:
                mode = "wb"
                kwargs = {}
            try:
                with open(filepath, mode, **kwargs) as f:
                    print(f'WRITING{cwd}---{filename} ')
                    # as the wsgi process www-data, we have group write-access but are not owner, so cannot chmod.
                    # os.chmod(filepath, 0o664) # set file permissions to rw-rw-r--
                    f.write(content)
            except PermissionError:
                raise WriteAndCommitError(f'CANNOT  save this file.\nPERMISSIONS incorrectly set on server for this file {filename}. Ask a nerd to fix this.')

            cp_add = subprocess.run([git, "add", filename], cwd=cwd, capture_output=True, text=True)
            if cp_add.returncode != 0:
                msgdata = 'Ask a nerd to fix this.\n\n' + cp_add.stderr + '\n\n' + cp_add.stdout  + '\n\nreturn code: ' + str(cp_add.returncode)
                raise WriteAndCommitError(f'CANNOT git on server for this file {filename}. Edits saved but not added to git.\n\n' + msgdata)
       
        cp_commit = subprocess.run([git, "commit", "-m", message], cwd=cwd, capture_output=True, text=True)
        # This produces return code = 1 if it commits OK, but when the repo still needs to be pushed to origin/expoweb
        if cp_commit.returncode != 0 and cp_commit.stdout != 'nothing to commit, working tree clean':
            msgdata = 'Ask a nerd to fix this.\n\n' + cp_commit.stderr + '\n\n' + cp_commit.stdout  + '\n\nreturn code: ' + str(cp_commit.returncode)
            raise WriteAndCommitError(f'Error code with git on server for this file {filename}. Edits saved, added to git, but NOT committed.\n\n' + msgdata)

    except subprocess.SubprocessError:
        raise WriteAndCommitError(f'CANNOT git on server for this file {filename}. Subprocess error. Edits not saved.\nAsk a nerd to fix this.')

class WriteAndCommitError(Exception):
    """Exception class for errors writing files and comitting them to git"""
    def __init__(self, message):
        self.message = message

    def __str__(self):
        return f'WriteAndCommitError: {self.message}'