containersolutions / jeeves Goto Github PK

View Code? Open in Web Editor NEW

0.0 5.0 1.0 456 KB

The Container Solutions Bot

License: Apache License 2.0

Dockerfile 4.15% Shell 9.68% Go 86.16%

bot

jeeves's Introduction

Jeeves The Talent Bot

This is the Slack Bot that the Container Solutions Talent Team Uses to Anonymize Candidates Git Repos.

Secrets

Secrets are encrypted with Google KMS, you will need access to the keys in order to decrypt them

Decrypting Secrets

./scripts/decrypt

Encrypting Secrets

./scripts/encrypt

Deployment

Currently it is deployed into the CS Engineering Shared Cluster Manually

How It Works

The bot just listens to mentions on a slack channel and then creates a Kubernetes Job within the cluster that handles the anonyimization, the anonymizer is just a bash script that can be found in the anonymizer directory

In the channel you would just run

/anonymize https://gitlab.com/<gitlab user name>/api-exercise <candidate id>

Roadmap

Automate Build and deployment
Add creation of Scoring Google Sheet
Add Github Intergrations

jeeves's People

Contributors

Watchers

Forkers

isabella232

jeeves's Issues

Anonymize Should Wait for Job to Finish before Responding

Is your feature request related to a problem? Please describe.

Currently, the job that Jeeves creates gets created but we don't check that it completes successfully

Describe the solution you'd like
There Should be a check to make sure that the job has completed, and then send to the slack channel that the API has been anonymized

Add the candidate ID into the response from Jeeves so that Talent knows which API test has been anonymized

Is your feature request related to a problem? Please describe.
This just means adding the candidate ID int the "API Anonymized" response

Describe the solution you'd like
Should just mean adding the candidate ID to the string

Testing is Minimal

Describe the bug
Testing on this project is minimal meaning that it will be prone to bugs and regressions

To Reproduce
Run Tests

Expected behaviour

We should have at least 70%+ coverage to have faith in the application

Automated deployment

Is your feature request related to a problem? Please describe.
Jeeves is currently deployed manually. It would be nice that every time we merged to master the staging bot would be deployed and every time a tag was created it would deploy to production

Describe the solution you'd like
I would like it to use git shas and tags to deploy

Additional context
Jeeves is currently running in the CS shared cluster

Jeeves currently fails if a ID is reused

Describe the bug
When a user tries to anonymize a repo multiple times it will fail as the job is already created.

To Reproduce
Rerun the anonymize slash command with the same input

Expected behavior
We should check if the job already exists and the status of the job, if it has completed we should attach a ID to the end of the job name and rerun it. If it failed we should delete it and rerun it.

Screenshots

Additional context
We should try and make this intuitive.

Anonymizer script should not be specific to gitlab and should allow for Github as well

Is your feature request related to a problem? Please describe.
We are thinking of moving the API Exercises too Github and would like the Anonymizer script to be able to handle this. The feeling is that as it is all git we should make the script generic so as to not worry about this and be able to anonymize any git repo that jeeves has access to

Describe the solution you'd like
Make the script generic to the git rep

Additional context
script can be found in (/anonymizer)[/anonymizer]

Automate Setup of API test scoring sheet in google sheets

Is your feature request related to a problem? Please describe.
It would be great as part of the anonymization process we set up the scoring sheet for that API as well.

Describe the solution you'd like
This would need to be implemented using Google Sheets Templates that could be copied. We would also need to create them in a specific folder on our drive

Additional context
Speak to Talent about and example of the API scoring card