Merge pull request #69 from merico-dev/feat-actions

feat: add support for Python and Nodejs with GitHub Actions plugin

Author: daniel-hutao

examples/config.yaml

@@ -9,6 +9,26 @@ tools:
       name: go
       version: "1.17"
     branch: master
+##for python config
+#- name: githubactions
+#  version: 0.0.1
+#  options:
+#    owner: lfbdev
+#    repo: spotipy
+#    language:
+#      name: python
+#      version: "3"
+#    branch: master
+##for nodejs config
+#- name: githubactions
+#  version: 0.0.1
+#  options:
+#    owner: lfbdev
+#    repo: lowdb
+#    language:
+#      name: nodejs
+#      version: "9"
+#    branch: main
 - name: argocd
   version: 0.0.1
   options:

internal/pkg/githubactions/githubactions.go

@@ -12,20 +12,6 @@ import (
 	"golang.org/x/oauth2"
 )
 
-// Options is the struct for configurations of the githubactions plugin.
-type Options struct {
-	Owner    string
-	Repo     string
-	Language *Language
-	Branch   string
-}
-
-// Language is the struct containing details of a programming language specified in the GitHub Actions workflow.
-type Language struct {
-	Name    string
-	Version string
-}
-
 type GithubActions struct {
 	ctx     context.Context
 	client  *github.Client
@@ -53,13 +39,17 @@ func NewGithubActions(options *map[string]interface{}) (*GithubActions, error) {
 	}, nil
 }
 
-func (ga *GithubActions) AddWorkflow(workflow Workflow) error {
+func (ga *GithubActions) GetLanguage() *Language {
+	return ga.options.Language
+}
+
+func (ga *GithubActions) AddWorkflow(workflow *Workflow) error {
 	exists, err := ga.fileExists(workflow.workflowFileName)
 	if err != nil {
 		return err
 	}
 	if exists {
-		log.Printf("github actions workflow %s already exists\n", workflow.workflowFileName)
+		log.Printf("github actions Workflow %s already exists\n", workflow.workflowFileName)
 		return nil
 	}
 
@@ -68,10 +58,10 @@ func (ga *GithubActions) AddWorkflow(workflow Workflow) error {
 	opts := &github.RepositoryContentFileOptions{
 		Message: github.String(workflow.commitMessage),
 		Content: []byte(workflow.workflowContent),
-		Branch:  github.String("master"),
+		Branch:  github.String(ga.options.Branch),
 	}
 
-	log.Printf("creating github actions workflow %s...\n", workflow.workflowFileName)
+	log.Printf("creating github actions Workflow %s...\n", workflow.workflowFileName)
 	_, _, err = ga.client.Repositories.CreateFile(
 		ga.ctx,
 		ga.options.Owner,
@@ -83,17 +73,17 @@ func (ga *GithubActions) AddWorkflow(workflow Workflow) error {
 		log.Println(err)
 		return err
 	}
-	log.Printf("github actions workflow %s created\n", workflow.workflowFileName)
+	log.Printf("github actions Workflow %s created\n", workflow.workflowFileName)
 	return nil
 }
 
-func (ga *GithubActions) DeleteWorkflow(workflow Workflow) error {
+func (ga *GithubActions) DeleteWorkflow(workflow *Workflow) error {
 	exists, err := ga.fileExists(workflow.workflowFileName)
 	if err != nil {
 		return err
 	}
 	if !exists {
-		log.Printf("github actions workflow %s already removed\n", workflow.workflowFileName)
+		log.Printf("github actions Workflow %s already removed\n", workflow.workflowFileName)
 		return nil
 	}
 
@@ -102,10 +92,10 @@ func (ga *GithubActions) DeleteWorkflow(workflow Workflow) error {
 	opts := &github.RepositoryContentFileOptions{
 		Message: github.String(workflow.commitMessage),
 		Content: []byte(workflow.workflowContent),
-		Branch:  github.String("master"),
+		Branch:  github.String(ga.options.Branch),
 	}
 
-	log.Printf("deleting github actions workflow %s...\n", workflow.workflowFileName)
+	log.Printf("deleting github actions Workflow %s...\n", workflow.workflowFileName)
 	_, _, err = ga.client.Repositories.DeleteFile(
 		ga.ctx,
 		ga.options.Owner,
@@ -117,14 +107,10 @@ func (ga *GithubActions) DeleteWorkflow(workflow Workflow) error {
 		log.Println(err)
 		return err
 	}
-	log.Printf("github actions workflow %s removed\n", workflow.workflowFileName)
+	log.Printf("github actions Workflow %s removed\n", workflow.workflowFileName)
 	return nil
 }
 
-func generateGitHubWorkflowFileByName(f string) string {
-	return fmt.Sprintf(".github/workflows/%s", f)
-}
-
 func (ga *GithubActions) fileExists(filename string) (bool, error) {
 	_, _, resp, err := ga.client.Repositories.GetContents(
 		ga.ctx,
@@ -148,6 +134,10 @@ func (ga *GithubActions) fileExists(filename string) (bool, error) {
 	return false, fmt.Errorf("got some error is not expected")
 }
 
+func generateGitHubWorkflowFileByName(f string) string {
+	return fmt.Sprintf(".github/workflows/%s", f)
+}
+
 func getGitHubToken() string {
 	err := viper.BindEnv("github_token")
 	if err != nil {

internal/pkg/githubactions/templates.go …al/pkg/githubactions/golang/templates.gointernal/pkg/githubactions/templates.go renamed to internal/pkg/githubactions/golang/templates.go internal/pkg/githubactions/templates.go renamed to internal/pkg/githubactions/golang/templates.go

@@ -1,6 +1,6 @@
-package githubactions
+package golang
 
-var prBuilder = `
+var PrBuilder = `
 name: PR Builder
 on:
   pull_request:
@@ -20,7 +20,7 @@ jobs:
       run: go build -v ./...
 `
 
-var masterBuilder = `
+var MasterBuilder = `
 name: Master Builder
 on:
   push:

internal/pkg/githubactions/install.go

@@ -1,9 +1,6 @@
 package githubactions
 
-var workflows = []Workflow{
-	{"pr builder by DevStream", "pr-builder.yml", prBuilder},
-	{"master builder by DevStream", "master-builder.yml", masterBuilder},
-}
+import "fmt"
 
 // Install sets up GitHub Actions workflows.
 func Install(options *map[string]interface{}) (bool, error) {
@@ -12,7 +9,13 @@ func Install(options *map[string]interface{}) (bool, error) {
 		return false, err
 	}
 
-	for _, pipeline := range workflows {
+	language := githubActions.GetLanguage()
+	ws := defaultWorkflows.GetWorkflowByNameVersionTypeString(language.String())
+
+	fmt.Println("lang is ", language.Name, language.Version, language.String())
+	fmt.Println("ws is ", ws)
+
+	for _, pipeline := range ws {
 		err := githubActions.AddWorkflow(pipeline)
 		if err != nil {
 			return false, err

internal/pkg/githubactions/nodejs/templates.go

@@ -0,0 +1,33 @@
+package nodejs
+
+var PrBuilder = `
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test
+`
+
+var MasterBuilder = ``

internal/pkg/githubactions/param.go

@@ -0,0 +1,52 @@
+package python
+
+var PrBuilder = `
+name: "Pull Request Workflow"
+on:
+  pull_request:
+    types: [ready_for_review]
+
+jobs:
+  # Enforces the update of a changelog file on every pull request
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: dangoslen/[email protected]
+        with:
+          changeLogPath: 'CHANGELOG.md'
+          skipLabel: 'skip-changelog'
+`
+
+var MasterBuilder = `
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [2.7, 3.5, 3.6, 3.7]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[test]
+    - name: Lint with flake8
+      run: |
+        pip install -Iv enum34==1.1.6 # https://bitbucket.org/stoneleaf/enum34/issues/27/enum34-118-broken
+        pip install flake8
+        flake8 . --count --show-source --statistics
+    - name: Run unit tests
+      run: |
+        python -m unittest discover -v tests/unit
+`

internal/pkg/githubactions/python/templates.go

@@ -7,7 +7,10 @@ func Reinstall(options *map[string]interface{}) (bool, error) {
 		return false, err
 	}
 
-	for _, pipeline := range workflows {
+	language := githubActions.GetLanguage()
+	ws := defaultWorkflows.GetWorkflowByNameVersionTypeString(language.String())
+
+	for _, pipeline := range ws {
 		err := githubActions.DeleteWorkflow(pipeline)
 		if err != nil {
 			return false, err

internal/pkg/githubactions/reinstall.go

@@ -7,7 +7,10 @@ func Uninstall(options *map[string]interface{}) (bool, error) {
 		return false, err
 	}
 
-	for _, pipeline := range workflows {
+	language := githubActions.GetLanguage()
+	ws := defaultWorkflows.GetWorkflowByNameVersionTypeString(language.String())
+
+	for _, pipeline := range ws {
 		err := githubActions.DeleteWorkflow(pipeline)
 		if err != nil {
 			return false, err

internal/pkg/githubactions/uninstall.go

@@ -0,0 +1,82 @@
+package githubactions
+
+import (
+	"fmt"
+
+	"github.com/merico-dev/stream/internal/pkg/githubactions/golang"
+	"github.com/merico-dev/stream/internal/pkg/githubactions/nodejs"
+	"github.com/merico-dev/stream/internal/pkg/githubactions/python"
+)
+
+const (
+	defaultCommitMessage = "builder by DevStream"
+	BuilderYmlPr         = "pr-builder.yml"
+	BuilderYmlMaster     = "master-builder.yml"
+)
+
+var go117 = &Language{
+	Name:    "go",
+	Version: "1.17",
+}
+
+var python3 = &Language{
+	Name:    "python",
+	Version: "3",
+}
+
+var nodejs9 = &Language{
+	Name:    "nodejs",
+	Version: "9",
+}
+
+var defaultWorkflows = workflows{
+	go117.String(): {
+		{defaultCommitMessage, BuilderYmlPr, golang.PrBuilder},
+		{defaultCommitMessage, BuilderYmlMaster, golang.MasterBuilder},
+	},
+	python3.String(): {
+		{defaultCommitMessage, BuilderYmlPr, python.PrBuilder},
+		{defaultCommitMessage, BuilderYmlMaster, python.MasterBuilder},
+	},
+	nodejs9.String(): {
+		{defaultCommitMessage, BuilderYmlPr, nodejs.PrBuilder},
+		{defaultCommitMessage, BuilderYmlMaster, nodejs.MasterBuilder},
+	},
+}
+
+// Options is the struct for configurations of the githubactions plugin.
+type Options struct {
+	Owner    string
+	Repo     string
+	Branch   string
+	Language *Language
+}
+
+// Language is the struct containing details of a programming language specified in the GitHub Actions Workflow.
+type Language struct {
+	Name    string
+	Version string
+}
+
+// Workflow is the struct for a GitHub Actions Workflow.
+type Workflow struct {
+	commitMessage    string
+	workflowFileName string
+	workflowContent  string
+}
+
+type LanguageString string
+
+type workflows map[LanguageString][]*Workflow
+
+func (l *Language) String() LanguageString {
+	return LanguageString(fmt.Sprintf("%s-%s", l.Name, l.Version))
+}
+
+func (ws *workflows) GetWorkflowByNameVersionTypeString(nvtStr LanguageString) []*Workflow {
+	workflowList, exist := (*ws)[nvtStr]
+	if exist {
+		return workflowList
+	}
+	return nil
+}