Skip to content
Snippets Groups Projects
Commit 2b3fd4cf authored by Johan de Klerk's avatar Johan de Klerk
Browse files

Merge branch 'main' of gitlab.com:uafrica/mage

parents c869b140 2a2d874b
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
Showing
with 2 additions and 491 deletions
.gitignore 0 → 100644
+ 1
− 0
View file @ 2b3fd4cf
.DS_Store
README.md
+ 1
− 89
View file @ 2b3fd4cf
# Mage
Build tool for the backend
## Getting started
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.com/uafrica/mage.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/user/project/integrations/)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Automatically merge when pipeline succeeds](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://docs.gitlab.com/ee/user/clusters/agent/)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://gitlab.com/-/experiment/new_project_readme_content:2b10436fc9b9fbee4f1b4be3ae0229e3?https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
Shared code to build the backend
_magefile/ask.go → ask.go
+ 0
− 0
View file @ 2b3fd4cf
File moved
_magefile/build.go → build.go
+ 0
− 0
View file @ 2b3fd4cf
File moved
_magefile/cdk.go → cdk.go
+ 0
− 0
View file @ 2b3fd4cf
File moved
_magefile/clear-cdk-cache.sh → clear-cdk-cache.sh
+ 0
− 0
View file @ 2b3fd4cf
File moved
_magefile/database.go → database.go
+ 0
− 0
View file @ 2b3fd4cf
File moved
_magefile/debug.go → debug.go
+ 0
− 0
View file @ 2b3fd4cf
File moved
_magefile/file_system.go → file_system.go
+ 0
− 0
View file @ 2b3fd4cf
File moved
_magefile/git.go → git.go
+ 0
− 0
View file @ 2b3fd4cf
File moved
mage_ci.go deleted 100644 → 0
+ 0
− 13
View file @ c869b140
package main
import (
"os"
"github.com/magefile/mage/mage"
)
func main() { os.Exit(mage.Main()) }
// func main() {
// DebugSQS(nil)
// }
mage_debug.go deleted 100644 → 0
+ 0
− 112
View file @ c869b140
// +build mage
package main
import (
"context"
"sync"
"github.com/magefile/mage/mg"
"gitlab.com/ship-logic/backends/backend/_magefile"
)
// ====================================================================================
// region Debug
// ====================================================================================
// build a debug build and start sam
func Debug(ctx context.Context) error {
mg.Deps(clearCDKCache)
mg.Deps(compileCDKTypeScript)
// Build
api := "handler_api"
if err := _magefile.Build(api, true); err != nil {
return err
}
// Create template file
env := _magefile.CurrentEnv()
cdkDir := "./cdk"
if err := _magefile.CDKSynthDebug(cdkDir, env, api); err != nil {
return err
}
err := _magefile.SamStartApi(ctx, env, api, true)
return err
}
// build a debug build and invoke the sqs queue
func DebugSQS(ctx context.Context) error {
mg.Deps(clearCDKCache)
mg.Deps(compileCDKTypeScript)
// Build
sqs := "handler_sqs"
if err := _magefile.Build(sqs, true); err != nil {
return err
}
// Create template file
cdkDir := "./cdk"
env := _magefile.CurrentEnv()
if err := _magefile.CDKSynthDebug(cdkDir, env, sqs); err != nil {
return err
}
functions, err := _magefile.FunctionFromTemplate("core/" + sqs + "/template.yml")
if err != nil {
return err
}
index := _magefile.Select("Choose a function:", functions)
functionName := functions[index]
err = _magefile.SamInvokeSQS(ctx, env, sqs, functionName)
return err
}
// used from golang to build a debug function
func BuildDebugFunction() error {
var waitGroup sync.WaitGroup
for _, handler := range handlers {
waitGroup.Add(1)
go func(handler string) {
if err := _magefile.Build(handler, true); err != nil {
panic(err)
}
waitGroup.Done()
}(handler)
}
waitGroup.Wait()
return nil
}
// endregion
// ====================================================================================
// region Run
// ====================================================================================
func Run(ctx context.Context) error {
mg.Deps(clearCDKCache)
mg.Deps(compileCDKTypeScript)
// Build
api := "handler_api"
if err := _magefile.Build(api, true); err != nil {
return err
}
// Create template file
env := _magefile.CurrentEnv()
cdkDir := "./cdk"
if err := _magefile.CDKSynthDebug(cdkDir, env, api); err != nil {
return err
}
err := _magefile.SamStartApi(ctx, env, api, false)
return err
}
// endregion
magefile.go deleted 100644 → 0
+ 0
− 277
View file @ c869b140
// +build mage
package main
import (
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
"sync"
"github.com/magefile/mage/mg"
"gitlab.com/ship-logic/backends/backend/_magefile"
)
var handlers = []string{
"handler_adhoc",
"handler_api",
"handler_cron",
"handler_sqs",
}
// ====================================================================================
// region Build
// ====================================================================================
// Builds all the microservices
func Build() error {
var waitGroup sync.WaitGroup
for _, handler := range handlers {
waitGroup.Add(1)
go func(handler string) {
if err := _magefile.Build(handler, false); err != nil {
panic(err)
}
waitGroup.Done()
}(handler)
}
waitGroup.Wait()
return nil
}
func BuildWorkers() error {
if err := _magefile.BuildGolangApp("workers-ec2/high-priority", "./workers-ec2/high-priority", false); err != nil {
return err
}
if err := _magefile.BuildGolangApp("workers-ec2/medium-priority", "./workers-ec2/medium-priority", false); err != nil {
return err
}
if err := _magefile.BuildGolangApp("workers-ec2/low-priority", "./workers-ec2/low-priority", false); err != nil {
return err
}
return nil
}
// endregion
// ====================================================================================
// region CDK
// ====================================================================================
func compileCDKTypeScript() error {
cdkDir := "./cdk"
return _magefile.CDKCompileTypeScript(cdkDir)
}
func clearCDKCache() error {
cdkDir := "./cdk"
fmt.Println("Clean CDK Cache")
if err := _magefile.ClearCDKCache(cdkDir); err != nil {
return err
}
return nil
}
func SetupCDK(local bool) {
env := _magefile.CurrentEnv()
cdkDir := "./cdk"
mg.Deps(Build)
mg.Deps(clearCDKCache)
mg.Deps(compileCDKTypeScript)
mg.Deps(mg.F(_magefile.CDKSynthAll, cdkDir, env, local))
}
// Run a stack diff
func Diff(local bool) error {
mg.Deps(mg.F(SetupCDK, local))
env := _magefile.CurrentEnv()
stack := fmt.Sprintf("shiplogic-backend-%v-core", env)
// CDK Diff
cdkDir := "./cdk"
return _magefile.CDKDiff(cdkDir, env, stack, local)
}
// Use CDK to deploy the base infrastructure to AWS.
func DeployBase(local bool) error {
mg.Deps(mg.F(SetupCDK, local))
cdkDir := "./cdk"
env := _magefile.CurrentEnv()
baseStacks := []string{
"infra",
"infra-us-east",
"cognito",
"policies",
}
for _, stack := range baseStacks {
stackName := fmt.Sprintf("shiplogic-backend-%v-%v", env, stack)
fmt.Println("Deploying: " + stack)
if err := _magefile.CDKDeploy(cdkDir, env, stackName, false, local); err != nil {
return err
}
}
// Frontend
stack := fmt.Sprintf("shiplogic-frontend-%v", env)
fmt.Println("Deploying: " + stack)
if err := _magefile.CDKDeploy(cdkDir, env, stack, false, local); err != nil {
return err
}
return nil
}
// Use CDK to deploy all the service monitoring stacks
func DeployServiceMonitoringStack(local bool) error {
mg.Deps(mg.F(SetupCDK, local))
env := _magefile.CurrentEnv()
stack := fmt.Sprintf("shiplogic-backend-%v-service-monitoring", _magefile.CurrentEnv())
if err := _magefile.CDKDeploy("./cdk", env, stack, false, local); err != nil {
return err
}
return nil
}
// Use CDK to deploy a specific microservice to AWS. Needs to be in the format `mage deploy billing`
func DeployCore(local bool) error {
mg.Deps(mg.F(SetupCDK, local))
// CDK deploy
env := _magefile.CurrentEnv()
stack := fmt.Sprintf("shiplogic-backend-%v-core", env)
// CDK deploy
fmt.Println("Deploying: " + stack)
return _magefile.CDKDeploy("./cdk", env, stack, true, local)
}
// endregion
// ====================================================================================
// region CI
// ====================================================================================
func RunCI(previousCommit string, local bool) error {
mg.Deps(mg.F(SetupCDK, local))
// Deploy base
hasCDKChanges := _magefile.HasChanges(previousCommit, "cdk")
if hasCDKChanges {
fmt.Println("Deploying base")
if err := DeployBase(local); err != nil {
return err
}
}
// Deploy core
utilsChanged := _magefile.HasChanges(previousCommit, "utils")
coreChanged := _magefile.HasChanges(previousCommit, "core")
if coreChanged || utilsChanged || hasCDKChanges {
err := DeployCore(local)
if err != nil {
return err
}
}
return nil
}
func DeployWorkers(previousCommit string, local bool) error {
env := _magefile.CurrentEnv()
hasWorkerChanges := _magefile.HasChanges(previousCommit, "workers-ec2")
if !hasWorkerChanges && env == "dev" {
return nil
}
mg.Deps(mg.F(BuildWorkers))
bucket := fmt.Sprintf("shiplogic-backend-%s-infra-worker-update", env)
if err := _magefile.UploadToS3(env, bucket, "./workers-ec2/high-priority/high-priority", "high-priority", local); err != nil {
return err
}
if err := _magefile.UploadToS3(env, bucket, "./workers-ec2/medium-priority/medium-priority", "medium-priority", local); err != nil {
return err
}
if err := _magefile.UploadToS3(env, bucket, "./workers-ec2/low-priority/low-priority", "low-priority", local); err != nil {
return err
}
// Create version file
file, err := ioutil.TempFile(os.TempDir(), "version")
if err != nil {
return err
}
defer os.Remove(file.Name())
// Save current commit in version file
commitHash := _magefile.CurrentCommit()
_, err = file.Write([]byte(strings.TrimSuffix(commitHash, "\n")))
if err != nil {
return err
}
// Upload to s3
if err := _magefile.UploadToS3(env, bucket, file.Name(), "version", local); err != nil {
return err
}
return nil
}
// endregion
// ====================================================================================
// region MJML
// ====================================================================================
// Builds all the microservices
func BuildMJML() error {
// Install mjml with `npm install -g mjml`
// Recursively traverse all folders in the microservice to find and build MJML files.
err := filepath.Walk("core",
func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if info.Mode().IsDir() {
// Ignore "build" directories
if info.Name() == "build" {
return nil
}
// Get all the subdirectories
files, err := ioutil.ReadDir(path)
if err != nil {
return err
}
// Build all MJML files
for _, f := range files {
if strings.HasSuffix(f.Name(), ".mjml") {
mjmlFilePath := path + "/" + f.Name()
err = _magefile.BuildMJML(mjmlFilePath)
if err != nil {
return err
}
}
}
}
return nil
})
if err != nil {
return err
}
return nil
}
// endregion
_magefile/s3.go → s3.go
+ 0
− 0
View file @ 2b3fd4cf
File moved
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment