Feat: Pipeline Cron Trigger (#90)

## What

* Add resource for Pipeline Cron Trigger
* Fix Terraform Acceptance tests
* Add Acceptance Tests to CI
* Add release automation (release drafter, labeler, automatic changelog
drafting)
* GH Repo best practices (PULL_REQUEST_TEMPLATE, CODEOWNERS, etc)
* Misc documentation fixes

## Why

* Only git triggers are currently supported.
* Triggers should be a standalone resource. The next minor release
(`0.2.0`) will support remaining standalone triggers (registry, helm,
git).

## Notes

* Closes #39 
* Closes #88
* #84

Co-authored-by: Yonatan Koren <[email protected]>
Co-authored-by: korenyoni <[email protected]>

Author: korenyoni

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @codefresh-io/devops @yaroslav-codefresh @denis-codefresh

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+## What
+
+## Why
+
+## Notes

.github/labeler.yml

@@ -0,0 +1,20 @@
+source:
+- 'client/**/*'
+- 'codefresh/**/*'
+- '*.go'
+- '*.mod'
+- '*.sum'
+
+docs:
+- README.md 
+- docs/**/*
+- examples/**/*
+- tf_modules/**/*
+- CHANGELOG.md
+
+automation:
+- scripts/**/*
+- .github/**/*
+- codefresh.yml
+- .goreleaser.yml
+- GNUmakefile

.github/release-drafter.yaml

@@ -0,0 +1,35 @@
+name-template: "v$RESOLVED_VERSION"
+tag-template: "v$RESOLVED_VERSION"
+categories:
+  - title: "🚀  Features"
+    labels:
+      - "feature"
+      - "enhancement"
+  - title: "🐛 Bug Fixes"
+    labels:
+      - "fix"
+      - "bugfix"
+      - "bug"
+  - title: "🧰 Maintenance"
+    label: "chore"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
+change-title-escapes: '\<*_&'
+version-resolver:
+  major:
+    labels:
+      - "major"
+  minor:
+    labels:
+      - "minor"
+      - "feature"
+      - "enhancement"
+  patch:
+    labels:
+      - "patch"
+      - "fix"
+      - "bugfix"
+      - "bug"
+  default: patch
+template: |
+  ## Changes
+  $CHANGES

.github/workflows/changelog-from-release.yaml

@@ -0,0 +1,18 @@
+name: "Changelog from Release"
+
+on:
+  release:
+    types: [published, released]
+
+jobs:
+  update_changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: master
+      - uses: rhysd/changelog-from-release/action@v3
+        with:
+          file: CHANGELOG.md
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          commit_summary_template: 'Update CHANGELOG.md for %s'

.github/workflows/draft-release.yaml

@@ -0,0 +1,19 @@
+name: Draft Release
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          publish: false
+          config-name: release-drafter.yaml

.github/workflows/update-labels.yaml

@@ -0,0 +1,14 @@
+name: "Pull Request Labeler"
+on:
+- pull_request_target
+
+jobs:
+  triage:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/labeler@v4
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"

.goreleaser.yml

@@ -32,12 +32,4 @@ signs:
       - "${signature}"
       - "--detach-sign"
       - "${artifact}"
-release:
-  # draft: true
-changelog:
-  sort: asc
-  filters:
-    exclude:
-    - '^docs:'
-    - '^test:' 
 

CHANGELOG.md

@@ -1,5 +1 @@
-# Changelog
 
-## [1.0.0 (Unreleased)](https://github.com/codefresh-io/terraform-provider-codefresh/tree/HEAD)
-
-[Full Changelog](https://github.com/codefresh-io/terraform-provider-codefresh/compare/17fe7e1b0003bda492682d06ba1917cae91d6faf...HEAD)

README.md

@@ -48,7 +48,7 @@ terraform {
 ```
 
 
-## [Documentations](./docs)
+## [Documentation](./docs)
 
 ## [Examples](./examples)
 
@@ -77,9 +77,14 @@ export CODEFRESH_API_KEY='xyz'
 
 ## Testing the Provider
 
+```bash
+export TF_ACC="test" 
+export CODEFRESH_API_KEY=[YOUR API TOKEN]
+go test -v ./...
+```
+
 ## License
 
-Copyright 2020 Codefresh.
+Copyright 2022 Codefresh.
 
 The Codefresh Provider is available under [MPL2.0 license](./LICENSE).
-

client/hermes_trigger.go

@@ -0,0 +1,80 @@
+package client
+
+import (
+	"fmt"
+)
+
+type HermesTrigger struct {
+	Event      string    `json:"event,omitempty"`
+	PipelineID string    `json:"pipeline,omitempty"`
+	EventData  EventData `json:"event-data,omitempty"`
+}
+
+type EventData struct {
+	Uri     string `json:"uri"`
+	Type    string `json:"type"`
+	Kind    string `json:"kind"`
+	Account string `json:"account"`
+	Secret  string `json:"secret"`
+}
+
+func (client *Client) GetHermesTriggerByEventAndPipeline(event string, pipeline string) (*HermesTrigger, error) {
+
+	fullPath := fmt.Sprintf("/hermes/triggers/event/%s", UriEncodeEvent(event))
+	opts := RequestOptions{
+		Path:   fullPath,
+		Method: "GET",
+	}
+
+	resp, err := client.RequestAPI(&opts)
+	if err != nil {
+		return nil, err
+	}
+
+	var hermesTriggerList []HermesTrigger
+
+	err = DecodeResponseInto(resp, &hermesTriggerList)
+	if err != nil {
+		return nil, err
+	}
+
+	var hermesTrigger HermesTrigger
+	for _, trigger := range hermesTriggerList {
+		if trigger.PipelineID == pipeline {
+			hermesTrigger = trigger
+		}
+	}
+	if hermesTrigger.Event == "" {
+		return nil, fmt.Errorf("No trigger found for event %s and pipeline %s", event, pipeline)
+	}
+
+	return &hermesTrigger, nil
+}
+
+func (client *Client) CreateHermesTriggerByEventAndPipeline(event string, pipeline string) error {
+
+	fullPath := fmt.Sprintf("/hermes/triggers/%s/%s", UriEncodeEvent(event), pipeline)
+	opts := RequestOptions{
+		Path:   fullPath,
+		Method: "POST",
+	}
+
+	_, err := client.RequestAPI(&opts)
+	return err
+}
+
+func (client *Client) DeleteHermesTriggerByEventAndPipeline(event string, pipeline string) error {
+	fullPath := fmt.Sprintf("/hermes/triggers/%s/%s", UriEncodeEvent(event), pipeline)
+	opts := RequestOptions{
+		Path:   fullPath,
+		Method: "DELETE",
+	}
+
+	_, err := client.RequestAPI(&opts)
+
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

client/hermes_trigger_event.go

@@ -0,0 +1,60 @@
+package client
+
+import (
+	"fmt"
+)
+
+type HermesTriggerEvent struct {
+	Type   string            `json:"type,omitempty"`
+	Kind   string            `json:"kind,omitempty"`
+	Filter string            `json:"filter,omitempty"`
+	Secret string            `json:"secret,omitempty"`
+	Values map[string]string `json:"values,omitempty"`
+}
+
+func (client *Client) GetHermesTriggerEvent(event string) (*HermesTriggerEvent, error) {
+	fullPath := fmt.Sprintf("/hermes/triggers/%s", UriEncodeEvent(event))
+
+	opts := RequestOptions{
+		Path:   fullPath,
+		Method: "GET",
+	}
+
+	resp, err := client.RequestAPI(&opts)
+	if err != nil {
+		return nil, err
+	}
+
+	var hermesTriggerEvent HermesTriggerEvent
+	err = DecodeResponseInto(resp, &hermesTriggerEvent)
+	if err != nil {
+		return nil, err
+	}
+
+	return &hermesTriggerEvent, nil
+}
+
+func (client *Client) CreateHermesTriggerEvent(event *HermesTriggerEvent) (string, error) {
+
+	body, err := EncodeToJSON(event)
+	if err != nil {
+		return "", err
+	}
+
+	fullPath := "/hermes/events/"
+	opts := RequestOptions{
+		Path:   fullPath,
+		Method: "POST",
+		Body:   body,
+	}
+
+	resp, err := client.RequestAPI(&opts)
+
+	var eventString string
+	err = DecodeResponseInto(resp, &eventString)
+	if err != nil {
+		return "", err
+	}
+
+	return eventString, err
+}

client/user.go

@@ -264,15 +264,15 @@ func (client *Client) DeleteUser(userName string) error {
 		Method: "DELETE",
 	}
 
-        // The API will return a 500 error if the user cannot be found	
-        // In this case the DeleteUser function should not return an error.
-        // Return error only if the body of the return message does not contain "User does not exist"
-        res, err := client.RequestAPI(&opts)
-        if err != nil {
-            if !strings.Contains(string(res), "User does not exist") {
-                return err
-            }
-        }
+	// The API will return a 500 error if the user cannot be found
+	// In this case the DeleteUser function should not return an error.
+	// Return error only if the body of the return message does not contain "User does not exist"
+	res, err := client.RequestAPI(&opts)
+	if err != nil {
+		if !strings.Contains(string(res), "User does not exist") {
+			return err
+		}
+	}
 
 	return nil
 }

client/utils.go

@@ -1,5 +1,10 @@
 package client
 
+import (
+	"net/url"
+	"strings"
+)
+
 // Variable spec
 type Variable struct {
 	Key   string `json:"key"`
@@ -19,3 +24,14 @@ func FindInSlice(slice []string, val string) bool {
 	}
 	return false
 }
+
+func uriEncode(path string) string {
+	replacer := strings.NewReplacer("+", "%20", "%2A", "*") // match Javascript's encodeURIComponent()
+	return replacer.Replace(url.QueryEscape(path))
+}
+
+func UriEncodeEvent(event string) string {
+	// The following is odd, but it's intentional. The event is URI encoded twice because
+	// the Codefresh API expects it to be encoded twice.
+	return uriEncode(uriEncode(event))
+}

codefresh.yml

@@ -16,9 +16,22 @@ steps:
   go_fmt:
     title: 'Formatting'
     stage: test
-    image:  goreleaser/goreleaser:v1.6.3
+    image:  goreleaser/goreleaser:v1.11.3
     commands:
       - go fmt
+  
+  go_test:
+    title: 'Run tests'
+    stage: test
+    image:  goreleaser/goreleaser:v1.11.3
+    environment:
+      - TF_ACC="test"
+    commands:
+      - go test -v ./... 
+    retry:
+      maxAttempts: 3
+      delay: 5
+      exponentialFactor: 2
 
   prepare_env_vars:
     title: 'Preparing environment variables...'
@@ -40,7 +53,7 @@ steps:
 
   release_binaries:
     title: Create release in Github
-    image:  goreleaser/goreleaser:v1.6.3
+    image:  goreleaser/goreleaser:v1.11.3
     stage: release
     environment:
       - GPG_FINGERPRINT=${{GPG_FINGERPRINT}}