GitHub integration

Flask GitHub Integration for Salesforce project


Now the time to add git integration to our Backup Service. Let's start with GitHub first as I like it. There are different types of authentication to GitHub (https://help.github.com/en/github/authenticating-to-github) but I want to start with Personal Token. So to connect to our git repository in GitHub we need: username, personal token, name of repository. With this data we can connect to GitHub API and use it in git command line tool via https.

To get and store connection data for GitHub I've created new JSONB field in the Task object (at this moment I don't want to reuse connection data between multiple Task, so we can store it in Task level, next we can decide to move it in separate level and join with Task)

GitHub integration modal

Before we store connection details to database we need to validate it. I'm going to do it with call to GitHub API to get repository details (repository details we can also store in DB alongside with git credentials and use in UI).

On github credentials save we run this backend handler in 
./backend/controllers/task.py
@task_bp.route('/git_settings', methods=['POST'])
@login_required
def update_git_settings():

    payload = request.get_json()

    task = (Task.query.filter(Task.id == payload['task']['id'],
                              Task.user_id == current_user.id)
                      .first_or_404())

    git_settings = payload['git_settings']

    if task.git is None:
        task.git = {}

    task.git['auth'] = git_settings

    # Git connection validation
    try:
        repo_details = GitService(task).get_github_repo_details()
    except ValueError as e:
        abort(400, str(e))

    task.git['repo_details'] = repo_details

    flag_modified(task, "git")

    db.session.commit()

    return jsonify(task)
./backend/services/git_service.py
import json
import requests
from models import Task


class GitService:

    task: Task = None

    def __init__(self, task: Task):
        self.task = task

    def get_github_repo_details(self):

        headers = self._get_github_headers()

        url = f"http://api.github.com/repos/{self.task.git['auth']['username']}/{self.task.git['auth']['repo_name']}"
        resp = self.get(url, headers, 200)

        try:
            repo_details = json.loads(resp)
            return repo_details
        except:  # NOQA
            raise ValueError(resp)

    def get(self, url, headers, expected_status_code=200):

        resp = requests.get(url, headers=headers)

        if resp.status_code != expected_status_code:
            print('=== RESPONSE ERROR:')
            print(resp.status_code, resp.text)
            raise ValueError('Unexpected status code: ' + str(resp.status_code) + ' ' + str(resp.text))

        return resp.text

    def _get_github_headers(self):

        if not self.task.git:
            raise ValueError('Git connection information not found')

        return {
            'Authorization': 'Token ' + self.task.git['auth']['token'],
            'Content-Type': 'application/json'
        }

I've updated Git Connection section to show information and if credentials are valid and available in Task then page should look this way

Git Connection details section

















Comments

Post a Comment

Popular posts from this blog

HTTPS in local environment for Angular + Flask project.

Image
Sometimes it is important to run project in local environment with HTTPS. For example when you use third party authentication system in our app. In my case I prefer to have local instance similar as mush as possible to the production. Moreover, it’s easy to implement. First what you need is the ssl key. You can follow this article to create it https://devcenter.heroku.com/articles/ssl-certificate-self Create your ssl key in ./key project folder. Finally it should look like this [dmnbrest@~/Documents/myPython/blog2/project/key]$ ls server.crt server.csr server.key Add HTTPS support to the FLASK: Update init section in your backend server file ( ./backend/app.py ) this way if __name__ == "__main__":     context = ('./key/server.crt', './key/server.key')     app.run(ssl_context=context, host='0.0.0.0', debug=True) But now we need to run backend with other command python ./backend/app.py This time you should see this output in ...
Read more

Task schedule configuration (Cron-like)

Image
I've rethink schedule run flow and decide to focus on Cron like style. User can still select from simple options like 10 mins, 1 hour, 1 day but they will be stored in Cron format. I found great python lib to simplify this work - Croniter ( https://github.com/kiorky/croniter ). It allows us to validate cron expression and calculate next run time. In scheduler we will check next run time and start task processing if time is less or equal and task status is "waiting". ./backend/controllers/task.py ... @task_bp.route('/start', methods=['POST']) @login_required def start_tasks(): task_payload = request.get_json() task = Task.query.filter(Task.id == task_payload['id'], Task.user_id == current_user.id).first_or_404() if not task.config or not croniter.is_valid(task.config['trigger_value']) : abort(400, 'Invalid Trigger Setup') task.status = 'waiting' base = datetime.now...
Read more

Salesforce Lightning Design System (SLDS)

Image
At this moment our UI looks ugly without any styles. To make it looks better we can to use any of existing CSS frameworks. I tried Bootstrap ( https://getbootstrap.com/ ), Foundation ( https://get.foundation/ ), UIkit ( https://getuikit.com/ ). But as a Salesforce developer I found SLDS ( https://www.lightningdesignsystem.com/ ) is closer to my heart. Let's add it to our project. Download last SLDS (current version is 2.11.6) from https://www.lightningdesignsystem.com/downloads/ Extract it to the ./backend/static/slds folder. There are few other ways to add SLDS to the project: - from NPM in the Angular subproject. But in this case it can be accessible by Angular only and is compiled as part of the result bundle. But we have Flask project as global playground and few pages (like /auth/login) should work out of the angular context but have the same look. - external CDN (like  https://cdnjs.com/ ). I like this approach and use it often during development time, but ...
Read more