Merge pull request ajvb#139 from levrado/remote_support

Remote support

api/api_test.go

@@ -32,6 +32,18 @@ func generateNewJobMap() map[string]string {
 		"owner":    "aj@ajvb.me",
 	}
 }
+
+func generateNewRemoteJobMap() map[string]interface{} {
+	return map[string]interface{}{
+		"name":  "mock_remote_job",
+		"owner": "aj@ajvb.me",
+		"type":  1,
+		"remote_properties": map[string]string{
+			"url": "http://example.com",
+		},
+	}
+}
+
 func generateJobAndCache() (*job.MemoryJobCache, *job.Job) {
 	cache := job.NewMockCache()
 	j := job.GetMockJobWithGenericSchedule()
@@ -70,6 +82,31 @@ func (a *ApiTestSuite) TestHandleAddJob() {
 	a.Equal(defaultOwner, retrievedJob.Owner)
 	a.Equal(w.Code, http.StatusCreated)
 }
+
+func (a *ApiTestSuite) TestHandleAddRemoteJob() {
+	t := a.T()
+	cache := job.NewMockCache()
+	jobMap := generateNewRemoteJobMap()
+	jobMap["owner"] = ""
+	defaultOwner := "aj+tester@ajvb.me"
+	handler := HandleAddJob(cache, defaultOwner)
+
+	jsonJobMap, err := json.Marshal(jobMap)
+	a.NoError(err)
+	w, req := setupTestReq(t, "POST", ApiJobPath, jsonJobMap)
+	handler(w, req)
+
+	var addJobResp AddJobResponse
+	err = json.Unmarshal(w.Body.Bytes(), &addJobResp)
+	a.NoError(err)
+	retrievedJob, err := cache.Get(addJobResp.Id)
+	a.NoError(err)
+	a.Equal(jobMap["name"], retrievedJob.Name)
+	a.NotEqual(jobMap["owner"], retrievedJob.Owner)
+	a.Equal(defaultOwner, retrievedJob.Owner)
+	a.Equal(w.Code, http.StatusCreated)
+}
+
 func (a *ApiTestSuite) TestHandleAddJobFailureBadJson() {
 	t := a.T()
 	cache := job.NewMockCache()

circle.yml

@@ -20,14 +20,6 @@ dependencies:
             pwd: ../gopath/src/${REPO_PATH}
 
 test:
-    pre:
-        - go get github.com/axw/gocov/gocov github.com/mattn/goveralls golang.org/x/tools/cmd/cover github.com/bluesuncorp/overalls:
-            pwd: ../gopath/src/${REPO_PATH}
     override:
         - go test -race ./...:
             pwd: ../gopath/src/${REPO_PATH}
-        - $GOPATH/bin/overalls -project=${REPO_PATH} -covermode=count -debug -ignore=.git,Godeps:
-            pwd: ../gopath/src/${REPO_PATH}
-    post:
-        - $GOPATH/bin/goveralls -coverprofile=overalls.coverprofile -service=circle-ci -repotoken=$COVERALLS_KEY:
-            pwd: ../gopath/src/${REPO_PATH}

job/job.go

@@ -5,6 +5,7 @@ import (
 	"encoding/gob"
 	"errors"
 	"fmt"
+	"net/http"
 	"strconv"
 	"strings"
 	"sync"
@@ -13,23 +14,17 @@ import (
 	"github.com/ajvb/kala/utils/iso8601"
 
 	log "github.com/Sirupsen/logrus"
-	"github.com/mattn/go-shellwords"
 	"github.com/nu7hatch/gouuid"
 )
 
 var (
-	shParser = shellwords.NewParser()
-
 	RFC3339WithoutTimezone = "2006-01-02T15:04:05"
 
-	ErrInvalidJob = errors.New("Invalid Job. Job's must contain a Name and a Command field")
+	ErrInvalidJob       = errors.New("Invalid Local Job. Job's must contain a Name and a Command field")
+	ErrInvalidRemoteJob = errors.New("Invalid Remote Job. Job's must contain a Name and a url field")
+	ErrInvalidJobType   = errors.New("Invalid Job type. Types supported: 0 for local and 1 for remote")
 )
 
-func init() {
-	shParser.ParseEnv = true
-	shParser.ParseBacktick = true
-}
-
 type Job struct {
 	Name string `json:"name"`
 	Id   string `json:"id"`
@@ -76,6 +71,12 @@ type Job struct {
 	// Meta data about successful and failed runs.
 	Metadata Metadata `json:"metadata"`
 
+	// Type of the job
+	JobType jobType `json:"type"`
+
+	// Custom properties for the remote job type
+	RemoteProperties RemoteProperties `json:"remote_properties"`
+
 	// Collection of Job Stats
 	Stats []*JobStat `json:"stats"`
 
@@ -86,6 +87,31 @@ type Job struct {
 	IsDone bool `json:"is_done"`
 }
 
+type jobType int
+
+const (
+	LocalJob jobType = iota
+	RemoteJob
+)
+
+// RemoteProperties Custom properties for the remote job type
+type RemoteProperties struct {
+	Url    string `json:"url"`
+	Method string `json:"method"`
+
+	// A body to attach to the http request
+	Body string `json:"body"`
+
+	// A list of headers to add to http request (e.g. [{"key": "charset", "value": "UTF-8"}])
+	Headers http.Header `json:"headers"`
+
+	// A timeout property for the http request in seconds
+	Timeout int `json:"timeout"`
+
+	// A list of expected response codes (e.g. [200, 201])
+	ExpectedResponseCodes []int `json:"expected_response_codes"`
+}
+
 type Metadata struct {
 	SuccessCount     uint      `json:"success_count"`
 	LastSuccess      time.Time `json:"last_success"`
@@ -124,11 +150,10 @@ func (j *Job) Init(cache JobCache) error {
 	j.lock.Lock()
 	defer j.lock.Unlock()
 
-	// Job Validation
-	// TODO: Move this to a seperated method?
-	if j.Name == "" || j.Command == "" {
-		log.Errorf(ErrInvalidJob.Error())
-		return ErrInvalidJob
+	//validate job type and params
+	err := j.validation()
+	if err != nil {
+		return err
 	}
 
 	u4, err := uuid.NewV4()
@@ -432,3 +457,18 @@ func (j *Job) ShouldStartWaiting() bool {
 	}
 	return true
 }
+
+func (j *Job) validation() error {
+	var err error
+	if j.JobType == LocalJob && (j.Name == "" || j.Command == "") {
+		err = ErrInvalidJob
+	} else if j.JobType == RemoteJob && (j.Name == "" || j.RemoteProperties.Url == "") {
+		err = ErrInvalidRemoteJob
+	} else if j.JobType != LocalJob && j.JobType != RemoteJob {
+		err = ErrInvalidJobType
+	} else {
+		return nil
+	}
+	log.Errorf(err.Error())
+	return err
+}

job/job_test.go

@@ -5,6 +5,8 @@ import (
 	"strings"
 	"testing"
 	"time"
+	"net/http/httptest"
+	"net/http"
 
 	"github.com/stretchr/testify/assert"
 )
@@ -271,9 +273,9 @@ func TestJobEpsilon(t *testing.T) {
 
 	now := time.Now()
 
+	j.lock.RLock()
 	assert.Equal(t, j.Metadata.SuccessCount, uint(0))
 	assert.Equal(t, j.Metadata.ErrorCount, uint(2))
-	j.lock.RLock()
 	assert.WithinDuration(t, j.Metadata.LastError, now, 4*time.Second)
 	assert.WithinDuration(t, j.Metadata.LastAttemptedRun, now, 4*time.Second)
 	assert.True(t, j.Metadata.LastSuccess.IsZero())
@@ -927,3 +929,49 @@ func TestDependentJobsParentJobGetsDeleted(t *testing.T) {
 	assert.True(t, len(j.ParentJobs) == 1)
 	j.lock.RUnlock()
 }
+
+func TestRemoteJobRunner(t *testing.T) {
+	testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintln(w, "Hello, client")
+	}))
+	defer testServer.Close()
+
+	mockRemoteJob := GetMockRemoteJob(RemoteProperties{
+		Url: testServer.URL,
+	})
+
+	cache := NewMockCache()
+	mockRemoteJob.Run(cache)
+	assert.True(t, mockRemoteJob.Metadata.SuccessCount == 1)
+}
+
+func TestRemoteJobBadStatus(t *testing.T) {
+	testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		http.Error(w, "something failed", http.StatusInternalServerError)
+	}))
+	defer testServer.Close()
+
+	mockRemoteJob := GetMockRemoteJob(RemoteProperties{
+		Url: testServer.URL,
+	})
+
+	cache := NewMockCache()
+	mockRemoteJob.Run(cache)
+	assert.True(t, mockRemoteJob.Metadata.SuccessCount == 0)
+}
+
+func TestRemoteJobBadStatusSuccess(t *testing.T) {
+	testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		http.Error(w, "something failed", http.StatusInternalServerError)
+	}))
+	defer testServer.Close()
+
+	mockRemoteJob := GetMockRemoteJob(RemoteProperties{
+		Url: testServer.URL,
+		ExpectedResponseCodes: []int{500},
+	})
+
+	cache := NewMockCache()
+	mockRemoteJob.Run(cache)
+	assert.True(t, mockRemoteJob.Metadata.SuccessCount == 1)
+}