Assignment validation endpoint

Author: edshadi

pkg/api/assignmentvalidator/endpoint.go

@@ -0,0 +1,45 @@
+package assignmentvalidator
+
+import (
+	"context"
+
+	"github.com/gemsorg/assignment/pkg/apierror"
+	"github.com/gemsorg/assignment/pkg/assignment"
+	"github.com/gemsorg/assignment/pkg/authentication"
+	ds "github.com/gemsorg/assignment/pkg/datastore"
+	"github.com/gemsorg/assignment/pkg/service"
+	"github.com/go-kit/kit/endpoint"
+)
+
+type AssignmentValidatorResponse struct {
+	Valid  bool   `json:"valid"`
+	Reason string `json:"reason"`
+}
+
+func makeAssignmentValidatorEndpoint(svc service.AssignmentService) endpoint.Endpoint {
+	return func(ctx context.Context, request interface{}) (interface{}, error) {
+		res := AssignmentValidatorResponse{}
+		data, _ := authentication.ParseAuthData(ctx)
+		svc.SetAuthData(data)
+
+		req := request.(assignment.NewAssignment)
+		settings, err := svc.GetSettings(req.JobID)
+		if err != nil {
+			if _, ok := err.(ds.NoRowErr); !ok {
+				return nil, errorResponse(err)
+			}
+		}
+
+		valid, err := svc.ValidateAssignment(req, settings)
+		if err != nil {
+			res.Reason = err.Error()
+		}
+		res.Valid = valid
+
+		return res, nil
+	}
+}
+
+func errorResponse(err error) *apierror.APIError {
+	return apierror.New(500, err.Error(), err)
+}

pkg/api/assignmentvalidator/transport.go

@@ -0,0 +1,35 @@
+package assignmentvalidator
+
+import (
+	"context"
+	"encoding/json"
+	"net/http"
+
+	"github.com/gemsorg/assignment/pkg/apierror"
+	"github.com/gemsorg/assignment/pkg/assignment"
+	"github.com/gemsorg/assignment/pkg/service"
+	kithttp "github.com/go-kit/kit/transport/http"
+)
+
+func MakeHandler(s service.AssignmentService) http.Handler {
+	return kithttp.NewServer(
+		makeAssignmentValidatorEndpoint(s),
+		decodeNewAssignmentValidatorRequest,
+		encodeResponse,
+	)
+}
+
+func encodeResponse(ctx context.Context, w http.ResponseWriter, response interface{}) error {
+	w.Header().Set("Content-Type", "application/json; charset=utf-8")
+	return json.NewEncoder(w).Encode(response)
+}
+
+func decodeNewAssignmentValidatorRequest(_ context.Context, r *http.Request) (interface{}, error) {
+	var a assignment.NewAssignment
+	decoder := json.NewDecoder(r.Body)
+	err := decoder.Decode(&a)
+	if err != nil {
+		return nil, apierror.New(500, err.Error(), err)
+	}
+	return a, nil
+}

pkg/server/server.go

@@ -7,6 +7,7 @@ import (
 	"github.com/gemsorg/assignment/pkg/api/assignmentdestroyer"
 	"github.com/gemsorg/assignment/pkg/api/assignmentfetcher"
 	"github.com/gemsorg/assignment/pkg/api/assignmentupdater"
+	"github.com/gemsorg/assignment/pkg/api/assignmentvalidator"
 	"github.com/gemsorg/assignment/pkg/api/settingcreator"
 	"github.com/gemsorg/assignment/pkg/api/settingfetcher"
 
@@ -33,6 +34,7 @@ func New(
 	r.Handle("/assignments", assignmentupdater.MakeHandler(s)).Methods("PATCH")
 	r.Handle("/settings/{job_id}", settingfetcher.MakeHandler(s)).Methods("GET")
 	r.Handle("/settings", settingcreator.MakeHandler(s)).Methods("PUT")
+	r.Handle("/validate", assignmentvalidator.MakeHandler(s)).Methods("GET")
 	r.Use(authentication.AuthMiddleware)
 	return withHandlers(r)
 }

pkg/service/service.go

@@ -20,6 +20,7 @@ type AssignmentService interface {
 	UpdateAssignment(workerID, jobID, responseID uint64, status string) (bool, error)
 	CreateSettings(assignment.Settings) (*assignment.Settings, error)
 	GetStore() datastore.Storage
+	ValidateAssignment(a assignment.NewAssignment, set *assignment.Settings) (bool, error)
 }
 
 type service struct {
@@ -108,3 +109,30 @@ func (s *service) UpdateAssignment(workerID, jobID, responseID uint64, status st
 func (s *service) CreateSettings(set assignment.Settings) (*assignment.Settings, error) {
 	return s.store.CreateSettings(set)
 }
+
+func (s *service) ValidateAssignment(a assignment.NewAssignment, set *assignment.Settings) (bool, error) {
+	allowed := true
+	if set == nil {
+		return allowed, nil
+	}
+
+	// if job has a whitelist, check if worker is part of it
+	if set.Whitelist {
+		wl, err := s.store.GetWhitelist(a.JobID, a.WorkerID)
+		if wl == nil || err != nil {
+			return false, assignment.WorkerNotWhitelisted{}
+		}
+	}
+
+	// Get worker's assignment for this job
+	assigned, err := s.store.WorkerAlreadyAssigned(a.JobID, a.WorkerID)
+	a.WorkerAlreadyAssigned = assigned
+
+	// Check if the assignment is allowed
+	allowed, err = a.IsAllowed(set)
+	if !allowed {
+		return false, err
+	}
+
+	return allowed, nil
+}