diff --git a/api/handlers/json.go b/api/handlers/json.go index 8230523e..1fa3ebd9 100644 --- a/api/handlers/json.go +++ b/api/handlers/json.go @@ -5,6 +5,9 @@ import ( "fmt" "log" "net/http" + "time" + + "github.com/sirupsen/logrus" ) func writeJSON(w http.ResponseWriter, status int, v interface{}) { @@ -21,6 +24,21 @@ func writeJSON(w http.ResponseWriter, status int, v interface{}) { } } +func internalServerError(w http.ResponseWriter, logger logrus.FieldLogger, msg string) { + ref := time.Now().Unix() + + logger.Errorf("ref (%d): %s", ref, msg) + response := &ErrorResponse{ + Reason: fmt.Sprintf( + "%s - ref (%d)", + http.StatusText(http.StatusInternalServerError), + ref, + ), + } + + writeJSON(w, http.StatusInternalServerError, response) +} + func writeJSONError(w http.ResponseWriter, status int, msg string) { response := &ErrorResponse{ Reason: msg, diff --git a/api/handlers/lineage_handler_test.go b/api/handlers/lineage_handler_test.go index 54fa140a..a4105bf1 100644 --- a/api/handlers/lineage_handler_test.go +++ b/api/handlers/lineage_handler_test.go @@ -22,7 +22,8 @@ func TestLineageHandler(t *testing.T) { graph := new(mock.Graph) graph.On( "Query", - lineage.QueryCfg{TypeWhitelist: []string{"bqtable"}}).Return(lineage.AdjacencyMap{}, record.ErrNoSuchType{TypeName: "bqtable"}) + lineage.QueryCfg{TypeWhitelist: []string{"bqtable"}}). + Return(lineage.AdjacencyMap{}, record.ErrNoSuchType{TypeName: "bqtable"}) lp := new(mock.LineageProvider) lp.On("Graph").Return(graph, nil) diff --git a/api/handlers/tag_handler.go b/api/handlers/tag_handler.go new file mode 100644 index 00000000..cad09b59 --- /dev/null +++ b/api/handlers/tag_handler.go @@ -0,0 +1,217 @@ +package handlers + +import ( + "encoding/json" + "errors" + "fmt" + "net/http" + + "github.com/odpf/columbus/tag" + "github.com/sirupsen/logrus" + + "github.com/gorilla/mux" +) + +var ( + errEmptyRecordURN = errors.New("record urn is empty") + errEmptyRecordType = errors.New("type is empty") + errNilTagService = errors.New("tag service is nil") + errEmptyTemplateURN = errors.New("template urn is empty") +) + +// TagHandler is handler to manage tag related requests +type TagHandler struct { + service *tag.Service + logger logrus.FieldLogger +} + +// NewTagHandler initializes tag handler based on the service +func NewTagHandler(logger logrus.FieldLogger, service *tag.Service) *TagHandler { + if service == nil { + panic("cannot create TagHandler with nil tag.Service") + } + + return &TagHandler{ + service: service, + logger: logger, + } +} + +// Create handles tag creation requests +func (h *TagHandler) Create(w http.ResponseWriter, r *http.Request) { + if h.service == nil { + writeJSONError(w, http.StatusInternalServerError, errNilTagService.Error()) + return + } + + var requestBody tag.Tag + if err := json.NewDecoder(r.Body).Decode(&requestBody); err != nil { + writeJSONError(w, http.StatusBadRequest, err.Error()) + return + } + + err := h.service.Create(&requestBody) + if errors.As(err, new(tag.DuplicateError)) { + writeJSONError(w, http.StatusConflict, err.Error()) + return + } + if errors.As(err, new(tag.TemplateNotFoundError)) { + writeJSONError(w, http.StatusNotFound, err.Error()) + return + } + if errors.As(err, new(tag.ValidationError)) { + writeJSONError(w, http.StatusUnprocessableEntity, err.Error()) + return + } + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error creating tag: %s", err.Error())) + return + } + + writeJSON(w, http.StatusCreated, requestBody) +} + +// GetByRecord handles get tag by record requests +func (h *TagHandler) GetByRecord(w http.ResponseWriter, r *http.Request) { + if h.service == nil { + writeJSONError(w, http.StatusInternalServerError, errNilTagService.Error()) + return + } + + muxVar := mux.Vars(r) + recordType, exists := muxVar["type"] + if !exists || recordType == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyRecordType.Error()) + return + } + recordURN, exists := muxVar["record_urn"] + if !exists || recordURN == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyRecordURN.Error()) + return + } + tags, err := h.service.GetByRecord(recordType, recordURN) + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error getting record tags: %s", err.Error())) + return + } + + writeJSON(w, http.StatusOK, tags) +} + +// FindByRecordAndTemplate handles get tag by record requests +func (h *TagHandler) FindByRecordAndTemplate(w http.ResponseWriter, r *http.Request) { + if h.service == nil { + writeJSONError(w, http.StatusInternalServerError, errNilTagService.Error()) + return + } + + muxVar := mux.Vars(r) + recordType, exists := muxVar["type"] + if !exists || recordType == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyRecordType.Error()) + return + } + recordURN, exists := muxVar["record_urn"] + if !exists || recordURN == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyRecordURN.Error()) + return + } + templateURN, exists := muxVar["template_urn"] + if !exists || templateURN == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyTemplateURN.Error()) + return + } + tags, err := h.service.FindByRecordAndTemplate(recordType, recordURN, templateURN) + if errors.As(err, new(tag.NotFoundError)) || errors.As(err, new(tag.TemplateNotFoundError)) { + writeJSONError(w, http.StatusNotFound, err.Error()) + return + } + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error finding a tag with record and template: %s", err.Error())) + return + } + + writeJSON(w, http.StatusOK, tags) +} + +// Update handles tag update requests +func (h *TagHandler) Update(w http.ResponseWriter, r *http.Request) { + if h.service == nil { + writeJSONError(w, http.StatusInternalServerError, errNilTagService.Error()) + return + } + + muxVar := mux.Vars(r) + recordURN, exists := muxVar["record_urn"] + if !exists || recordURN == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyRecordURN.Error()) + return + } + recordType, exists := muxVar["type"] + if !exists || recordType == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyRecordType.Error()) + return + } + templateURN, exists := muxVar["template_urn"] + if !exists || templateURN == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyTemplateURN.Error()) + return + } + + var requestBody tag.Tag + if err := json.NewDecoder(r.Body).Decode(&requestBody); err != nil { + writeJSONError(w, http.StatusBadRequest, err.Error()) + return + } + + requestBody.RecordURN = recordURN + requestBody.RecordType = recordType + requestBody.TemplateURN = templateURN + err := h.service.Update(&requestBody) + if errors.As(err, new(tag.NotFoundError)) { + writeJSONError(w, http.StatusNotFound, err.Error()) + return + } + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error updating a template: %s", err.Error())) + return + } + + writeJSON(w, http.StatusOK, requestBody) +} + +// Delete handles delete tag by record and template requests +func (h *TagHandler) Delete(w http.ResponseWriter, r *http.Request) { + if h.service == nil { + writeJSONError(w, http.StatusInternalServerError, errNilTagService.Error()) + return + } + muxVar := mux.Vars(r) + recordType, exists := muxVar["type"] + if !exists || recordType == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyRecordType.Error()) + return + } + recordURN, exists := muxVar["record_urn"] + if !exists || recordURN == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyRecordURN.Error()) + return + } + templateURN, exists := muxVar["template_urn"] + if !exists || templateURN == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyTemplateURN.Error()) + return + } + + err := h.service.Delete(recordType, recordURN, templateURN) + if errors.As(err, new(tag.TemplateNotFoundError)) { + writeJSONError(w, http.StatusNotFound, err.Error()) + return + } + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error deleting a template: %s", err.Error())) + return + } + + writeJSON(w, http.StatusNoContent, nil) +} diff --git a/api/handlers/tag_handler_test.go b/api/handlers/tag_handler_test.go new file mode 100644 index 00000000..3edfba06 --- /dev/null +++ b/api/handlers/tag_handler_test.go @@ -0,0 +1,829 @@ +package handlers_test + +import ( + "encoding/json" + "errors" + "net/http" + "net/http/httptest" + "strings" + "testing" + + "github.com/odpf/columbus/api/handlers" + "github.com/odpf/columbus/lib/mock" + "github.com/odpf/columbus/tag" + "github.com/odpf/columbus/tag/mocks" + + "github.com/gorilla/mux" + "github.com/stretchr/testify/suite" +) + +type TagHandlerTestSuite struct { + suite.Suite + handler *handlers.TagHandler + tagRepository *mocks.TagRepository + templateRepository *mocks.TemplateRepository + recorder *httptest.ResponseRecorder +} + +func (s *TagHandlerTestSuite) TestNewHandler() { + s.Run("should return handler and nil if service is not nil", func() { + actualHandler := handlers.NewTagHandler(new(mock.Logger), &tag.Service{}) + + s.NotNil(actualHandler) + }) +} + +func (s *TagHandlerTestSuite) Setup() { + s.tagRepository = new(mocks.TagRepository) + s.templateRepository = new(mocks.TemplateRepository) + templateService := tag.NewTemplateService(s.templateRepository) + service := tag.NewService(s.tagRepository, templateService) + + s.handler = handlers.NewTagHandler(new(mock.Logger), service) + s.recorder = httptest.NewRecorder() +} + +func (s *TagHandlerTestSuite) TestCreate() { + s.Run("should return status bad request and error if body cannot be unmarshalled", func() { + s.Setup() + body := "invalid_body" + request, _ := http.NewRequest(http.MethodPost, "/", strings.NewReader(body)) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"invalid character 'i' looking for beginning of value\"}\n" + + s.handler.Create(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return 404 if template does not exist", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + s.templateRepository.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.tagRepository.On("Create", &t).Return(tag.TemplateNotFoundError{URN: t.TemplateURN}) + + body, err := json.Marshal(t) + s.Require().NoError(err) + request, _ := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + + s.handler.Create(s.recorder, request) + s.Equal(http.StatusNotFound, s.recorder.Result().StatusCode) + }) + + s.Run("should return 422 if there is validation error", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + s.templateRepository.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.tagRepository.On("Create", &t).Return(tag.ValidationError{Err: errors.New("validation error")}) + + body, err := json.Marshal(t) + s.Require().NoError(err) + request, _ := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + + s.handler.Create(s.recorder, request) + s.Equal(http.StatusUnprocessableEntity, s.recorder.Result().StatusCode) + }) + + s.Run("should return 500 if found error during insert", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + s.templateRepository.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.tagRepository.On("Create", &t).Return(errors.New("unexpected error during insert")) + + body, err := json.Marshal(t) + s.Require().NoError(err) + request, _ := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + + s.handler.Create(s.recorder, request) + s.Equal(http.StatusInternalServerError, s.recorder.Result().StatusCode) + }) + + s.Run("should return 409 if found duplicated record during insert", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + s.templateRepository.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.tagRepository.On("Create", &t).Return(tag.DuplicateError{}) + + body, err := json.Marshal(t) + s.Require().NoError(err) + request, _ := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + + s.handler.Create(s.recorder, request) + s.Equal(http.StatusConflict, s.recorder.Result().StatusCode) + }) + + s.Run("should return status created and domain is inserted if found no error", func() { + s.Setup() + originalDomainTag := s.buildTag() + + template := s.buildTemplate() + s.templateRepository.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.tagRepository.On("Create", &originalDomainTag).Return(nil) + + body, err := json.Marshal(originalDomainTag) + s.Require().NoError(err) + request, err := http.NewRequest(http.MethodPost, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + + s.handler.Create(s.recorder, request) + + rsp, err := json.Marshal(originalDomainTag) + s.Require().NoError(err) + expectedResponseBody := string(rsp) + "\n" + + s.Equal(http.StatusCreated, s.recorder.Result().StatusCode) + s.Equal(expectedResponseBody, s.recorder.Body.String()) + }) + +} + +func (s *TagHandlerTestSuite) TestGetByRecord() { + s.Run("should return status bad request error and its message if record urn is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": "sample-type", + "record_urn": "", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"record urn is empty\"}\n" + + s.handler.GetByRecord(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + s.Run("should return status bad request error and its message if type is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": "", + "record_urn": "sample-urn", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"type is empty\"}\n" + + s.handler.GetByRecord(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status unprocessible entity and error if found unexpected error", func() { + s.Setup() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": recordType, + "record_urn": recordURN, + }) + + s.tagRepository.On("Read", tag.Tag{RecordType: recordType, RecordURN: recordURN}).Return(nil, errors.New("unexpected error")) + + s.handler.GetByRecord(s.recorder, request) + s.Equal(http.StatusInternalServerError, s.recorder.Result().StatusCode) + }) + + s.Run("should return status ok and tags for the specified record", func() { + s.Setup() + t := s.buildTag() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": recordType, + "record_urn": recordURN, + }) + s.tagRepository.On("Read", tag.Tag{RecordType: recordType, RecordURN: recordURN}).Return([]tag.Tag{t}, nil) + + expectedStatusCode := http.StatusOK + rsp, err := json.Marshal([]tag.Tag{t}) + s.Require().NoError(err) + expectedResponseBody := string(rsp) + "\n" + + s.handler.GetByRecord(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) +} + +func (s *TagHandlerTestSuite) TestFindByRecordAndTemplate() { + s.Run("should return status bad request error and its message if record urn is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": "sample-type", + "record_urn": "", + "template_urn": "sample-template", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"record urn is empty\"}\n" + + s.handler.FindByRecordAndTemplate(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request error and its message if type is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": "", + "record_urn": "sample-urn", + "template_urn": "sample-template", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"type is empty\"}\n" + + s.handler.FindByRecordAndTemplate(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request error and its message if template urn is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": "sample-type", + "record_urn": "sample-urn", + "template_urn": "", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"template urn is empty\"}\n" + + s.handler.FindByRecordAndTemplate(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return 404 if template does not exist", func() { + s.Setup() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + template := s.buildTemplate() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": recordType, + "record_urn": recordURN, + "template_urn": template.URN, + }) + + s.templateRepository.On("Read", tag.Template{ + URN: template.URN, + }).Return([]tag.Template{}, tag.TemplateNotFoundError{URN: template.URN}) + + s.handler.FindByRecordAndTemplate(s.recorder, request) + s.Equal(http.StatusNotFound, s.recorder.Result().StatusCode) + }) + + s.Run("should return 404 if tag does not exist", func() { + s.Setup() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + template := s.buildTemplate() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": recordType, + "record_urn": recordURN, + "template_urn": template.URN, + }) + + s.templateRepository.On("Read", tag.Template{ + URN: template.URN, + }).Return([]tag.Template{template}, nil) + + s.tagRepository.On("Read", tag.Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: template.URN, + }).Return(nil, tag.NotFoundError{ + URN: recordURN, + Type: recordType, + Template: template.URN, + }) + + s.handler.FindByRecordAndTemplate(s.recorder, request) + s.Equal(http.StatusNotFound, s.recorder.Result().StatusCode) + }) + + s.Run("should return 500 if found unexpected error", func() { + s.Setup() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + var templateURN string = "template-urn" + template := s.buildTemplate() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": recordType, + "record_urn": recordURN, + "template_urn": templateURN, + }) + + s.templateRepository.On("Read", tag.Template{ + URN: templateURN, + }).Return([]tag.Template{template}, nil) + + s.tagRepository.On("Read", tag.Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: templateURN, + }).Return(nil, errors.New("unexpected error")) + + s.handler.FindByRecordAndTemplate(s.recorder, request) + s.Equal(http.StatusInternalServerError, s.recorder.Result().StatusCode) + }) + + s.Run("should return status ok and tag", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": t.RecordType, + "record_urn": t.RecordURN, + "template_urn": t.TemplateURN, + }) + + s.templateRepository.On("Read", tag.Template{ + URN: t.TemplateURN, + }).Return([]tag.Template{template}, nil) + + s.tagRepository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + TemplateURN: t.TemplateURN, + }).Return([]tag.Tag{t}, nil) + + expectedStatusCode := http.StatusOK + rsp, err := json.Marshal(t) + s.Require().NoError(err) + expectedResponseBody := string(rsp) + "\n" + + s.handler.FindByRecordAndTemplate(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) +} + +func (s *TagHandlerTestSuite) TestUpdate() { + s.Run("should return status internal server error and its message if service is nil", func() { + s.Setup() + handler := &handlers.TagHandler{} + t := s.buildTag() + body, _ := json.Marshal(t) + var recordURN string = "sample-urn" + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "record_urn": recordURN, + }) + + handler.Update(s.recorder, request) + + s.Equal(http.StatusInternalServerError, s.recorder.Result().StatusCode) + }) + + s.Run("should return status bad request error and its message if record urn is empty", func() { + s.Setup() + t := s.buildTag() + body, _ := json.Marshal(t) + request, _ := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + request = mux.SetURLVars(request, map[string]string{ + "type": t.RecordType, + "record_urn": "", + "template_urn": t.TemplateURN, + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"record urn is empty\"}\n" + + s.handler.Update(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request error and its message if type is empty", func() { + s.Setup() + t := s.buildTag() + body, _ := json.Marshal(t) + request, _ := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + request = mux.SetURLVars(request, map[string]string{ + "type": "", + "record_urn": t.RecordURN, + "template_urn": t.TemplateURN, + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"type is empty\"}\n" + + s.handler.Update(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request error and its message if record urn is empty", func() { + s.Setup() + t := s.buildTag() + body, _ := json.Marshal(t) + request, _ := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + request = mux.SetURLVars(request, map[string]string{ + "type": t.RecordType, + "record_urn": t.RecordURN, + "template_urn": "", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"template urn is empty\"}\n" + + s.handler.Update(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request and error if body cannot be unmarshalled", func() { + s.Setup() + body := "invalid_body" + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": "sample-type", + "record_urn": "sample-urn", + "template_urn": "template-urn", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"invalid character 'i' looking for beginning of value\"}\n" + + s.handler.Update(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status not found error if tag could not be found", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + s.templateRepository.On("Read", s.templateQuery(t.TemplateURN)).Return([]tag.Template{template}, nil) + s.tagRepository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + TemplateURN: t.TemplateURN, + }).Return([]tag.Tag{}, nil) + s.tagRepository.On("Update", &t).Return(errors.New("unexpected error during update")) + + body, err := json.Marshal(t) + s.Require().NoError(err) + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": t.RecordType, + "record_urn": t.RecordURN, + "template_urn": t.TemplateURN, + }) + + s.handler.Update(s.recorder, request) + s.Equal(http.StatusNotFound, s.recorder.Result().StatusCode) + }) + + s.Run("should return 500 if found error during update", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + s.templateRepository.On("Read", s.templateQuery(t.TemplateURN)).Return([]tag.Template{template}, nil) + s.tagRepository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + TemplateURN: t.TemplateURN, + }).Return([]tag.Tag{t}, nil) + s.tagRepository.On("Update", &t).Return(errors.New("unexpected error during update")) + + body, err := json.Marshal(t) + s.Require().NoError(err) + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": t.RecordType, + "record_urn": t.RecordURN, + "template_urn": t.TemplateURN, + }) + + s.handler.Update(s.recorder, request) + s.Equal(http.StatusInternalServerError, s.recorder.Result().StatusCode) + }) + + s.Run("should return status created and domain is updated if found no error", func() { + s.Setup() + originalDomainTag := s.buildTag() + template := s.buildTemplate() + s.templateRepository.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.tagRepository.On("Read", tag.Tag{ + RecordType: originalDomainTag.RecordType, + RecordURN: originalDomainTag.RecordURN, + TemplateURN: originalDomainTag.TemplateURN, + }).Return([]tag.Tag{originalDomainTag}, nil) + s.tagRepository.On("Update", &originalDomainTag).Return(nil) + + body, err := json.Marshal(originalDomainTag) + s.Require().NoError(err) + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": originalDomainTag.RecordType, + "record_urn": originalDomainTag.RecordURN, + "template_urn": originalDomainTag.TemplateURN, + }) + + expectedStatusCode := http.StatusOK + rsp, err := json.Marshal(originalDomainTag) + s.Require().NoError(err) + expectedResponseBody := string(rsp) + "\n" + + s.handler.Update(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) +} + +func (s *TagHandlerTestSuite) TestDelete() { + s.Run("should return status internal server error and its message if service is nil", func() { + s.Setup() + handler := &handlers.TagHandler{} + var recordType string = "sample-type" + var recordURN string = "sample-urn" + var templateURN string = "template-urn" + request, err := http.NewRequest(http.MethodDelete, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": recordType, + "record_urn": recordURN, + "template_urn": templateURN, + }) + + expectedStatusCode := http.StatusInternalServerError + expectedResponseBody := "{\"reason\":\"tag service is nil\"}\n" + + handler.Delete(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request error and its message if type is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodDelete, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": "", + "record_urn": "sample-urn", + "template_urn": "template-urn", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"type is empty\"}\n" + + s.handler.Delete(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request error and its message if record urn is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodDelete, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "record_urn": "", + "type": "sample-type", + "template_urn": "template-urn", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"record urn is empty\"}\n" + + s.handler.Delete(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request error and its message if template urn is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodDelete, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": "sample-type", + "record_urn": "sample-urn", + "template_urn": "", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"template urn is empty\"}\n" + + s.handler.Delete(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status not found error and its message if template does not exist", func() { + s.Setup() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + var templateURN string = "template-urn" + request, _ := http.NewRequest(http.MethodDelete, "/", nil) + request = mux.SetURLVars(request, map[string]string{ + "type": recordType, + "record_urn": recordURN, + "template_urn": templateURN, + }) + s.templateRepository.On("Read", s.templateQuery(templateURN)).Return([]tag.Template{{}}, nil) + s.tagRepository.On("Delete", tag.Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: templateURN, + }).Return(tag.TemplateNotFoundError{}) + + s.handler.Delete(s.recorder, request) + s.Equal(http.StatusNotFound, s.recorder.Result().StatusCode) + }) + + s.Run("should return 500 if found unexpected error", func() { + s.Setup() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + var templateURN string = "template-urn" + request, err := http.NewRequest(http.MethodDelete, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "type": recordType, + "record_urn": recordURN, + "template_urn": templateURN, + }) + s.templateRepository.On("Read", s.templateQuery(templateURN)).Return([]tag.Template{{}}, nil) + s.tagRepository.On("Delete", tag.Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: templateURN, + }).Return(errors.New("unexpected error")) + + s.handler.Delete(s.recorder, request) + s.Equal(http.StatusInternalServerError, s.recorder.Result().StatusCode) + }) + + s.Run("should return status no content and empty if delete success", func() { + s.Setup() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + var templateURN string = "template-urn" + request, _ := http.NewRequest(http.MethodDelete, "/", nil) + request = mux.SetURLVars(request, map[string]string{ + "type": recordType, + "record_urn": recordURN, + "template_urn": templateURN, + }) + s.templateRepository.On("Read", s.templateQuery(templateURN)).Return([]tag.Template{{}}, nil) + s.tagRepository.On("Delete", tag.Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: templateURN, + }).Return(nil) + + s.handler.Delete(s.recorder, request) + s.Equal(http.StatusNoContent, s.recorder.Result().StatusCode) + }) +} + +func (s *TagHandlerTestSuite) templateQuery(template_urn string) tag.Template { + return tag.Template{ + URN: template_urn, + } +} + +func (s *TagHandlerTestSuite) buildTemplate() tag.Template { + return tag.Template{ + URN: "governance_policy", + DisplayName: "Governance Policy", + Description: "Template that is mandatory to be used.", + Fields: []tag.Field{ + { + ID: 1, + URN: "classification", + DisplayName: "classification", + Description: "The classification of this record", + DataType: "enumerated", + Required: true, + Options: []string{"Public", "Restricted"}, + }, + { + ID: 2, + URN: "is_encrypted", + DisplayName: "Is Encrypted?", + Description: "Specify whether this record is encrypted or not.", + DataType: "boolean", + Required: true, + }, + }, + } +} + +func (s *TagHandlerTestSuite) buildTag() tag.Tag { + return tag.Tag{ + RecordURN: "sample-urn", + RecordType: "sample-type", + TemplateURN: "governance_policy", + TemplateDisplayName: "Governance Policy", + TemplateDescription: "Template that is mandatory to be used.", + TagValues: []tag.TagValue{ + { + FieldID: 1, + FieldValue: "Public", + FieldURN: "classification", + FieldDisplayName: "classification", + FieldDescription: "The classification of this record", + FieldDataType: "enumerated", + FieldRequired: true, + FieldOptions: []string{"Public", "Restricted"}, + }, + { + FieldID: 2, + FieldValue: true, + FieldURN: "is_encrypted", + FieldDisplayName: "Is Encrypted?", + FieldDescription: "Specify whether this record is encrypted or not.", + FieldDataType: "boolean", + FieldRequired: true, + }, + }, + } +} + +func TestTagHandler(t *testing.T) { + suite.Run(t, &TagHandlerTestSuite{}) +} diff --git a/api/handlers/tag_template_handler.go b/api/handlers/tag_template_handler.go new file mode 100644 index 00000000..fff449d5 --- /dev/null +++ b/api/handlers/tag_template_handler.go @@ -0,0 +1,140 @@ +package handlers + +import ( + "encoding/json" + "errors" + "fmt" + "net/http" + + "github.com/odpf/columbus/tag" + "github.com/sirupsen/logrus" + + "github.com/gorilla/mux" +) + +// TagTemplateHandler is handler to manage template related requests +type TagTemplateHandler struct { + service *tag.TemplateService + logger logrus.FieldLogger +} + +// NewTagTemplateHandler initializes template handler based on the service +func NewTagTemplateHandler(logger logrus.FieldLogger, service *tag.TemplateService) *TagTemplateHandler { + if service == nil { + panic("template service is nil") + } + return &TagTemplateHandler{ + service: service, + logger: logger, + } +} + +// Create handles template creation requests +func (h *TagTemplateHandler) Create(w http.ResponseWriter, r *http.Request) { + var requestBody tag.Template + if err := json.NewDecoder(r.Body).Decode(&requestBody); err != nil { + writeJSONError(w, http.StatusBadRequest, err.Error()) + return + } + err := h.service.Create(&requestBody) + if errors.As(err, new(tag.DuplicateTemplateError)) { + writeJSONError(w, http.StatusConflict, err.Error()) + return + } + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error creating tag template: %s", err.Error())) + return + } + + writeJSON(w, http.StatusCreated, requestBody) +} + +// Index handles template read requests +func (h *TagTemplateHandler) Index(w http.ResponseWriter, r *http.Request) { + urn := r.URL.Query().Get("urn") + queryDomainTemplate := tag.Template{ + URN: urn, + } + listOfDomainTemplate, err := h.service.Index(queryDomainTemplate) + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error finding templates: %s", err.Error())) + return + } + writeJSON(w, http.StatusOK, listOfDomainTemplate) +} + +// Update handles template update requests +func (h *TagTemplateHandler) Update(w http.ResponseWriter, r *http.Request) { + params := mux.Vars(r) + urn, ok := params["template_urn"] + if !ok || urn == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyTemplateURN.Error()) + return + } + + var requestBody tag.Template + if err := json.NewDecoder(r.Body).Decode(&requestBody); err != nil { + writeJSONError(w, http.StatusBadRequest, err.Error()) + return + } + requestBody.URN = urn + err := h.service.Update(&requestBody) + if errors.As(err, new(tag.TemplateNotFoundError)) { + writeJSONError(w, http.StatusNotFound, err.Error()) + return + } + if errors.As(err, new(tag.ValidationError)) { + writeJSONError(w, http.StatusUnprocessableEntity, err.Error()) + return + } + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error updating template: %s", err.Error())) + return + } + + writeJSON(w, http.StatusOK, requestBody) +} + +// Find handles template read requests based on URN +func (h *TagTemplateHandler) Find(w http.ResponseWriter, r *http.Request) { + params := mux.Vars(r) + urn, ok := params["template_urn"] + if !ok || urn == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyTemplateURN.Error()) + return + } + + domainTemplate, err := h.service.Find(urn) + if errors.As(err, new(tag.TemplateNotFoundError)) { + writeJSONError(w, http.StatusNotFound, err.Error()) + return + } + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error finding a template: %s", err.Error())) + return + } + + writeJSON(w, http.StatusOK, domainTemplate) +} + +// Delete handles template delete request based on URN +func (h *TagTemplateHandler) Delete(w http.ResponseWriter, r *http.Request) { + params := mux.Vars(r) + urn, ok := params["template_urn"] + if !ok || urn == "" { + writeJSONError(w, http.StatusBadRequest, errEmptyTemplateURN.Error()) + return + } + + err := h.service.Delete(urn) + if errors.As(err, new(tag.TemplateNotFoundError)) { + writeJSONError(w, http.StatusNotFound, err.Error()) + return + } + if err != nil { + internalServerError(w, h.logger, fmt.Sprintf("error deleting a template: %s", err.Error())) + return + } + + writeJSON(w, http.StatusNoContent, nil) +} diff --git a/api/handlers/tag_template_handler_test.go b/api/handlers/tag_template_handler_test.go new file mode 100644 index 00000000..05639e95 --- /dev/null +++ b/api/handlers/tag_template_handler_test.go @@ -0,0 +1,443 @@ +package handlers_test + +import ( + "encoding/json" + "errors" + "net/http" + "net/http/httptest" + "strings" + "testing" + "time" + + "github.com/odpf/columbus/api/handlers" + "github.com/odpf/columbus/tag" + "github.com/odpf/columbus/tag/mocks" + + "github.com/gorilla/mux" + libMock "github.com/odpf/columbus/lib/mock" + "github.com/stretchr/testify/mock" + "github.com/stretchr/testify/suite" +) + +type TagTemplateHandlerTestSuite struct { + suite.Suite + handler *handlers.TagTemplateHandler + templateRepository *mocks.TemplateRepository + recorder *httptest.ResponseRecorder +} + +func (s *TagTemplateHandlerTestSuite) TestNewHandler() { + s.Run("should return handler and nil if service is not nil", func() { + service := &tag.TemplateService{} + + actualHandler := handlers.NewTagTemplateHandler(new(libMock.Logger), service) + s.NotNil(actualHandler) + }) +} + +func (s *TagTemplateHandlerTestSuite) Setup() { + s.templateRepository = new(mocks.TemplateRepository) + service := tag.NewTemplateService(s.templateRepository) + + s.handler = handlers.NewTagTemplateHandler(new(libMock.Logger), service) + s.recorder = httptest.NewRecorder() +} + +func (s *TagTemplateHandlerTestSuite) TestCreate() { + s.Run("should return status bad request and error if body cannot be unmarshalled", func() { + s.Setup() + body := "invalid_body" + request, err := http.NewRequest(http.MethodPost, "/", strings.NewReader(body)) + s.Require().NoError(err) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"invalid character 'i' looking for beginning of value\"}\n" + + s.handler.Create(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return 409 for duplicate template", func() { + s.Setup() + template := s.buildTemplate() + body, err := json.Marshal(template) + s.Require().NoError(err) + s.templateRepository.On("Read", tag.Template{URN: template.URN}).Return(nil, nil) + s.templateRepository.On("Create", &template).Return(tag.DuplicateTemplateError{URN: template.URN}) + request, _ := http.NewRequest(http.MethodPost, "/", strings.NewReader(string(body))) + + s.handler.Create(s.recorder, request) + s.Equal(http.StatusConflict, s.recorder.Result().StatusCode) + }) + + s.Run("should return 500 if found error during insert", func() { + s.Setup() + template := s.buildTemplate() + body, err := json.Marshal(template) + s.Require().NoError(err) + s.templateRepository.On("Read", tag.Template{URN: template.URN}).Return(nil, nil) + s.templateRepository.On("Create", &template).Return(errors.New("unexpected error during insert")) + request, _ := http.NewRequest(http.MethodPost, "/", strings.NewReader(string(body))) + + s.handler.Create(s.recorder, request) + s.Equal(http.StatusInternalServerError, s.recorder.Result().StatusCode) + }) + + s.Run("should return status created and domain is inserted if found no error", func() { + s.Setup() + originalDomainTemplate := s.buildTemplate() + body, err := json.Marshal(originalDomainTemplate) + s.Require().NoError(err) + s.templateRepository.On("Read", tag.Template{URN: originalDomainTemplate.URN}).Return(nil, nil) + s.templateRepository.On("Create", &originalDomainTemplate).Return(nil) + request, err := http.NewRequest(http.MethodPost, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + + expectedStatusCode := http.StatusCreated + rsp, err := json.Marshal(originalDomainTemplate) + s.Require().NoError(err) + expectedResponseBody := string(rsp) + "\n" + + s.handler.Create(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) +} + +func (s *TagTemplateHandlerTestSuite) TestIndex() { + s.Run("should return status unprocessible entity and error if found unexpected error", func() { + s.Setup() + request, err := http.NewRequest(http.MethodGet, "/templates?urn=governance_policy", nil) + s.Require().NoError(err) + s.templateRepository.On("Read", tag.Template{ + URN: "governance_policy", + }).Return(nil, errors.New("unexpected error")) + + s.handler.Index(s.recorder, request) + s.Equal(http.StatusInternalServerError, s.recorder.Result().StatusCode) + }) + + s.Run("should return status ok and templates if found template based on the query", func() { + s.Setup() + request, err := http.NewRequest(http.MethodGet, "/templates?urn=governance_policy", nil) + s.Require().NoError(err) + recordDomainTemplate := s.buildTemplate() + s.templateRepository.On("Read", tag.Template{ + URN: "governance_policy", + }).Return([]tag.Template{recordDomainTemplate}, nil) + + expectedStatusCode := http.StatusOK + rsp, err := json.Marshal([]tag.Template{recordDomainTemplate}) + s.Require().NoError(err) + expectedResponseBody := string(rsp) + "\n" + + s.handler.Index(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) +} + +func (s *TagTemplateHandlerTestSuite) TestUpdate() { + s.Run("should return status bad request error and its message if urn is empty", func() { + s.Setup() + template := s.buildTemplate() + body, err := json.Marshal(template) + s.Require().NoError(err) + var templateURN string = "" + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"template urn is empty\"}\n" + + s.handler.Update(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request error and its message if body cannot be unmarshalled", func() { + s.Setup() + body := "invalid_body" + var templateURN string = "governance_policy" + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(body)) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"invalid character 'i' looking for beginning of value\"}\n" + + s.handler.Update(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return 404 if template does not exist", func() { + s.Setup() + template := s.buildTemplate() + body, err := json.Marshal(template) + s.Require().NoError(err) + var templateURN string = "governance_policy" + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + s.templateRepository.On("Read", tag.Template{ + URN: templateURN, + }).Return([]tag.Template{}, nil) + + s.handler.Update(s.recorder, request) + s.Equal(http.StatusNotFound, s.recorder.Result().StatusCode) + }) + + s.Run("should return 422 if there is validation error", func() { + s.Setup() + template := s.buildTemplate() + body, err := json.Marshal(template) + s.Require().NoError(err) + var templateURN string = "governance_policy" + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + s.templateRepository.On("Read", tag.Template{ + URN: templateURN, + }).Return(nil, tag.ValidationError{Err: errors.New("validation error")}) + + s.handler.Update(s.recorder, request) + s.Equal(http.StatusUnprocessableEntity, s.recorder.Result().StatusCode) + }) + + s.Run("should return 500 if encountered error during update", func() { + s.Setup() + template := s.buildTemplate() + body, err := json.Marshal(template) + s.Require().NoError(err) + var templateURN string = "governance_policy" + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + s.templateRepository.On("Read", tag.Template{ + URN: templateURN, + }).Return(nil, errors.New("unexpected error")) + + s.handler.Update(s.recorder, request) + s.Equal(http.StatusInternalServerError, s.recorder.Result().StatusCode) + }) + + s.Run("should return status ok and its message if successfully updated", func() { + s.Setup() + template := s.buildTemplate() + body, err := json.Marshal(template) + s.Require().NoError(err) + request, err := http.NewRequest(http.MethodGet, "/", strings.NewReader(string(body))) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": template.URN, + }) + + s.templateRepository.On("Read", tag.Template{ + URN: template.URN, + }).Return([]tag.Template{template}, nil).Once() + + s.templateRepository.On("Update", &template).Run(func(args mock.Arguments) { + template.UpdatedAt = time.Now() + }).Return(nil) + + expectedStatusCode := http.StatusOK + rsp, err := json.Marshal(template) + s.Require().NoError(err) + expectedResponseBody := string(rsp) + "\n" + + s.handler.Update(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) +} + +func (s *TagTemplateHandlerTestSuite) TestFind() { + s.Run("should return status bad request error and its message if urn is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": "", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"template urn is empty\"}\n" + + s.handler.Find(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status bad request error and its message if urn is empty", func() { + s.Setup() + var templateURN string = "" + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"template urn is empty\"}\n" + + s.handler.Find(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return status 404 and its message if template is not found", func() { + s.Setup() + var templateURN string = "governance_policy" + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + s.templateRepository.On("Read", tag.Template{ + URN: templateURN, + }).Return([]tag.Template{}, nil) + + s.handler.Find(s.recorder, request) + s.Equal(http.StatusNotFound, s.recorder.Result().StatusCode) + }) + + s.Run("should return status ok and template if domain template is found", func() { + s.Setup() + var templateURN string = "governance_policy" + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + template := s.buildTemplate() + + s.templateRepository.On("Read", tag.Template{ + URN: templateURN, + }).Return([]tag.Template{template}, nil) + + expectedStatusCode := http.StatusOK + rsp, err := json.Marshal(template) + s.Require().NoError(err) + expectedResponseBody := string(rsp) + "\n" + + s.handler.Find(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) +} + +func (s *TagTemplateHandlerTestSuite) TestDelete() { + s.Run("should return status bad request error and its message if urn is empty", func() { + s.Setup() + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": "", + }) + + expectedStatusCode := http.StatusBadRequest + expectedResponseBody := "{\"reason\":\"template urn is empty\"}\n" + + s.handler.Delete(s.recorder, request) + actualStatusCode := s.recorder.Result().StatusCode + actualResponseBody := s.recorder.Body.String() + + s.Equal(expectedStatusCode, actualStatusCode) + s.Equal(expectedResponseBody, actualResponseBody) + }) + + s.Run("should return 404 if template is not found", func() { + s.Setup() + var templateURN string = "governance_policy" + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + s.templateRepository.On("Delete", tag.Template{ + URN: templateURN, + }).Return(tag.TemplateNotFoundError{URN: templateURN}) + + s.handler.Delete(s.recorder, request) + s.Equal(http.StatusNotFound, s.recorder.Result().StatusCode) + }) + + s.Run("should return status no content and template if domain template is found", func() { + s.Setup() + var templateURN string = "governance_policy" + request, err := http.NewRequest(http.MethodGet, "/", nil) + s.Require().NoError(err) + request = mux.SetURLVars(request, map[string]string{ + "template_urn": templateURN, + }) + s.templateRepository.On("Delete", tag.Template{ + URN: templateURN, + }).Return(nil) + + s.handler.Delete(s.recorder, request) + s.Equal(http.StatusNoContent, s.recorder.Result().StatusCode) + }) +} + +func (s *TagTemplateHandlerTestSuite) buildTemplate() tag.Template { + return tag.Template{ + URN: "governance_policy", + DisplayName: "Governance Policy", + Description: "Template that is mandatory to be used.", + Fields: []tag.Field{ + { + ID: 1, + URN: "team_owner", + DisplayName: "Team Owner", + Description: "Owner of the resource.", + DataType: "enumerated", + Required: true, + Options: []string{"PIC", "Escalated"}, + }, + }, + } +} + +func TestTagTemplateHandler(t *testing.T) { + suite.Run(t, &TagTemplateHandlerTestSuite{}) +} diff --git a/api/routes.go b/api/routes.go index c32ffe51..c118902f 100644 --- a/api/routes.go +++ b/api/routes.go @@ -7,11 +7,14 @@ import ( "github.com/odpf/columbus/api/handlers" "github.com/odpf/columbus/discovery" "github.com/odpf/columbus/record" + "github.com/odpf/columbus/tag" "github.com/sirupsen/logrus" ) type Config struct { Logger logrus.FieldLogger + TagService *tag.Service + TagTemplateService *tag.TemplateService TypeRepository record.TypeRepository RecordRepositoryFactory discovery.RecordRepositoryFactory DiscoveryService *discovery.Service @@ -42,14 +45,22 @@ func RegisterRoutes(router *mux.Router, config Config) { config.Logger.WithField("reporter", "search-handler"), config.DiscoveryService, ) - lineageHandler := handlers.NewLineageHandler( config.Logger.WithField("reporter", "lineage-handler"), config.LineageProvider, ) + tagHandler := handlers.NewTagHandler( + config.Logger.WithField("reporter", "tag-handler"), + config.TagService, + ) + tagTemplateHandler := handlers.NewTagTemplateHandler( + config.Logger.WithField("reporter", "tag-template-handler"), + config.TagTemplateService, + ) router.PathPrefix("/ping").Handler(handlers.NewHeartbeatHandler()) setupV1TypeRoutes(router, typeHandler, recordHandler) + setupV1TagRoutes(router, "/v1/tags", tagHandler, tagTemplateHandler) router.Path("/v1/search"). Methods(http.MethodGet). @@ -84,6 +95,10 @@ func setupV1TypeRoutes(router *mux.Router, th *handlers.TypeHandler, rh *handler HandlerFunc(th.Delete) recordURL := "/v1/types/{name}/records" + router.Path(recordURL). + Methods(http.MethodPut, http.MethodHead). + HandlerFunc(rh.UpsertBulk) + router.Path(recordURL). Methods(http.MethodGet, http.MethodHead). HandlerFunc(rh.GetByType) @@ -96,7 +111,23 @@ func setupV1TypeRoutes(router *mux.Router, th *handlers.TypeHandler, rh *handler Methods(http.MethodDelete, http.MethodHead). HandlerFunc(rh.Delete) - router.Path(recordURL). - Methods(http.MethodPut, http.MethodHead). - HandlerFunc(rh.UpsertBulk) +} + +func setupV1TagRoutes(router *mux.Router, baseURL string, th *handlers.TagHandler, tth *handlers.TagTemplateHandler) { + router.Methods(http.MethodPost).Path(baseURL).HandlerFunc(th.Create) + + url := baseURL + "/types/{type}/records/{record_urn}/templates/{template_urn}" + router.Methods(http.MethodGet).Path(url).HandlerFunc(th.FindByRecordAndTemplate) + router.Methods(http.MethodPut).Path(url).HandlerFunc(th.Update) + router.Methods(http.MethodDelete).Path(url).HandlerFunc(th.Delete) + + router.Methods(http.MethodGet).Path(baseURL + "/types/{type}/records/{record_urn}").HandlerFunc(th.GetByRecord) + + templateURL := baseURL + "/templates" + router.Methods(http.MethodGet).Path(templateURL).HandlerFunc(tth.Index) + router.Methods(http.MethodPost).Path(templateURL).HandlerFunc(tth.Create) + router.Methods(http.MethodGet).Path(templateURL + "/{template_urn}").HandlerFunc(tth.Find) + router.Methods(http.MethodPut).Path(templateURL + "/{template_urn}").HandlerFunc(tth.Update) + router.Methods(http.MethodDelete).Path(templateURL + "/{template_urn}").HandlerFunc(tth.Delete) + } diff --git a/cmd/config.go b/cmd/config.go index ee06283c..98b23da4 100644 --- a/cmd/config.go +++ b/cmd/config.go @@ -10,17 +10,39 @@ import ( ) type Config struct { - ServerHost string `mapstructure:"SERVER_HOST" default:"0.0.0.0"` - ServerPort string `mapstructure:"SERVER_PORT" default:"8080"` - ElasticSearchBrokers string `mapstructure:"ELASTICSEARCH_BROKERS" default:"http://localhost:9200"` - StatsdAddress string `mapstructure:"STATSD_ADDRESS" default:"127.0.0.1:8125"` - StatsdPrefix string `mapstructure:"STATSD_PREFIX" default:"columbusApi"` - StatsdEnabled bool `mapstructure:"STATSD_ENABLED" default:"false"` + // Server Config + ServerHost string `mapstructure:"SERVER_HOST" default:"0.0.0.0"` + ServerPort string `mapstructure:"SERVER_PORT" default:"8080"` + + // Elasticsearch + ElasticSearchBrokers string `mapstructure:"ELASTICSEARCH_BROKERS" default:"http://localhost:9200"` + + // StatsD + StatsdAddress string `mapstructure:"STATSD_ADDRESS" default:"127.0.0.1:8125"` + StatsdPrefix string `mapstructure:"STATSD_PREFIX" default:"columbusApi"` + StatsdEnabled bool `mapstructure:"STATSD_ENABLED" default:"false"` + + TypeWhiteListStr string `mapstructure:"SEARCH_WHITELIST" default:""` + SearchTypesCacheDuration int `mapstructure:"SEARCH_TYPES_CACHE_DURATION" default:"300"` + + // Lineage LineageRefreshIntervalStr string `mapstructure:"LINEAGE_REFRESH_INTERVAL" default:"5m"` - NewRelicEnabled bool `mapstructure:"NEW_RELIC_ENABLED" default:"false"` - NewRelicAppName string `mapstructure:"NEW_RELIC_APP_NAME" default:"columbus"` - NewRelicLicenseKey string `mapstructure:"NEW_RELIC_LICENSE_KEY" default:""` - LogLevel string `mapstructure:"LOG_LEVEL" default:"info"` + + // NewRelic + NewRelicEnabled bool `mapstructure:"NEW_RELIC_ENABLED" default:"false"` + NewRelicAppName string `mapstructure:"NEW_RELIC_APP_NAME" default:"columbus"` + NewRelicLicenseKey string `mapstructure:"NEW_RELIC_LICENSE_KEY" default:""` + + // Log + LogLevel string `mapstructure:"LOG_LEVEL" default:"info"` + + // Database + DBHost string `mapstructure:"DB_HOST" default:"localhost"` + DBPort int `mapstructure:"DB_PORT" default:"5432"` + DBName string `mapstructure:"DB_NAME" default:"postgres"` + DBUser string `mapstructure:"DB_USER" default:"root"` + DBPassword string `mapstructure:"DB_PASSWORD" default:""` + DBSSLMode string `mapstructure:"DB_SSL_MODE" default:"disable"` } var config Config diff --git a/cmd/migrate.go b/cmd/migrate.go index 530689dc..c96479b7 100644 --- a/cmd/migrate.go +++ b/cmd/migrate.go @@ -1,9 +1,38 @@ package cmd +import ( + "fmt" + + "github.com/odpf/columbus/store/postgres" +) + func Migrate() { + fmt.Println("Preparing migration...") if err := loadConfig(); err != nil { - log.Fatal(err) + panic(err) + } + + fmt.Println("Initiating DB client...") + pgClient, err := postgres.NewClient(postgres.Config{ + Port: config.DBPort, + Host: config.DBHost, + Name: config.DBName, + User: config.DBUser, + Password: config.DBPassword, + SSLMode: config.DBSSLMode, + }) + if err != nil { + panic(err) + } + + fmt.Println("Migrating DB...") + if err := pgClient.AutoMigrate( + &postgres.Template{}, + &postgres.Field{}, + &postgres.Tag{}, + ); err != nil { + panic(err) } - // TODO: add migration script + fmt.Println("Migration done.") } diff --git a/cmd/serve.go b/cmd/serve.go index c60874e7..a1e5b7a5 100644 --- a/cmd/serve.go +++ b/cmd/serve.go @@ -19,7 +19,10 @@ import ( "github.com/odpf/columbus/lineage" "github.com/odpf/columbus/metrics" esStore "github.com/odpf/columbus/store/elasticsearch" + "github.com/odpf/columbus/store/postgres" + "github.com/odpf/columbus/tag" "github.com/sirupsen/logrus" + "gorm.io/gorm" ) // Version of the current build. overridden by the build system. @@ -77,6 +80,16 @@ func initRouter( rootLogger.Info("lineage build complete") }() + pgClient := initPostgres(config) + tagRepository := postgres.NewTagRepository(pgClient) + tagTemplateService := tag.NewTemplateService( + postgres.NewTemplateRepository(pgClient), + ) + tagService := tag.NewService( + tagRepository, + tagTemplateService, + ) + router := mux.NewRouter() if nrMonitor != nil { nrMonitor.MonitorRouter(router) @@ -94,6 +107,8 @@ func initRouter( DiscoveryService: discovery.NewService(recordRepositoryFactory, recordSearcher), RecordRepositoryFactory: recordRepositoryFactory, LineageProvider: lineageService, + TagService: tagService, + TagTemplateService: tagTemplateService, }) return router @@ -128,6 +143,23 @@ func initElasticsearch(config Config) *elasticsearch.Client { return esClient } +func initPostgres(config Config) *gorm.DB { + pgClient, err := postgres.NewClient(postgres.Config{ + Port: config.DBPort, + Host: config.DBHost, + Name: config.DBName, + User: config.DBUser, + Password: config.DBPassword, + SSLMode: config.DBSSLMode, + }) + if err != nil { + log.Fatalf("error creating postgres client: %v", err) + } + log.Infof("connected to postgres server %s:%d", config.DBHost, config.DBPort) + + return pgClient +} + func initNewRelicMonitor(config Config) *metrics.NewrelicMonitor { if !config.NewRelicEnabled { log.Infof("New Relic monitoring is disabled.") diff --git a/config.yaml.example b/config.yaml.example index 3bd29087..1fa4dc4c 100644 --- a/config.yaml.example +++ b/config.yaml.example @@ -9,3 +9,9 @@ NEW_RELIC_ENABLED: false NEW_RELIC_APP_NAME: columbus NEW_RELIC_LICENSE_KEY: ____LICENSE_STRING_OF_40_CHARACTERS_____ LOG_LEVEL: info +DB_HOST: localhost +DB_PORT: 5432 +DB_NAME: columbus +DB_USER: postgres +DB_PASSWORD: ~ +DB_SSL_MODE: disable diff --git a/docker-compose.yaml b/docker-compose.yaml index 7661e9d9..c2c1e529 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -5,3 +5,12 @@ services: image: 'elasticsearch:7.6.1' environment: discovery.type: single-node + postgres: + ports: + - 5432:5432 + image: 'postgres:13' + environment: + POSTGRES_USER: columbus + POSTGRES_PASSWORD: columbus_password + POSTGRES_DB: columbus + discovery.type: single-node diff --git a/go.mod b/go.mod index 8aa6378f..4348de55 100644 --- a/go.mod +++ b/go.mod @@ -7,8 +7,13 @@ require ( github.com/elastic/go-elasticsearch v0.0.0 github.com/elastic/go-elasticsearch/v7 v7.6.0 github.com/etsy/statsd v0.8.6 + github.com/go-playground/locales v0.14.0 + github.com/go-playground/universal-translator v0.18.0 + github.com/go-playground/validator/v10 v10.9.0 github.com/gorilla/handlers v1.4.2 github.com/gorilla/mux v1.8.0 + github.com/jackc/pgconn v1.10.0 + github.com/jackc/pgerrcode v0.0.0-20201024163028-a0d42d470451 github.com/jeremywohl/flatten v1.0.1 github.com/mcuadros/go-defaults v1.2.0 github.com/mitchellh/mapstructure v1.4.1 @@ -22,4 +27,7 @@ require ( github.com/spf13/cobra v1.2.1 github.com/spf13/viper v1.8.1 github.com/stretchr/testify v1.7.0 + gorm.io/driver/postgres v1.2.2 + gorm.io/driver/sqlite v1.2.6 + gorm.io/gorm v1.22.3 ) diff --git a/go.sum b/go.sum index 8ff2c4b3..6fae0958 100644 --- a/go.sum +++ b/go.sum @@ -41,6 +41,8 @@ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ= github.com/MakeNowJust/heredoc v1.0.0/go.mod h1:mG5amYoWBHf8vpLOuehzbGGw0EHxpZZ6lCpQ4fNJ8LE= +github.com/Masterminds/semver/v3 v3.1.1 h1:hLg3sBzpNErnxhQtUy/mmLR2I9foDujNK030IGemrRc= +github.com/Masterminds/semver/v3 v3.1.1/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs= github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU= github.com/alecthomas/assert v0.0.0-20170929043011-405dbfeb8e38/go.mod h1:r7bzyVFMNntcxPZXK3/+KdruV1H5KSlyVY0gc+NgInI= github.com/alecthomas/chroma v0.8.2/go.mod h1:sko8vR34/90zvl5QdcUdvzL3J8NKjAUx9va9jPuFNoM= @@ -76,9 +78,15 @@ github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGX github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= github.com/cncf/xds/go v0.0.0-20210312221358-fbca930ec8ed/go.mod h1:eXthEFrGJvWHgFFCl3hGmgk+/aYT6PnTQLykKQRLhEs= +github.com/cockroachdb/apd v1.1.0 h1:3LFP3629v+1aKXU5Q37mxmRxX/pIu1nijXydLShEq5I= +github.com/cockroachdb/apd v1.1.0/go.mod h1:8Sl8LxpKi29FqWXR16WEFZRNSz3SoPzUzeMeY4+DwBQ= github.com/coreos/go-semver v0.3.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk= +github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= +github.com/coreos/go-systemd v0.0.0-20190719114852-fd7a80b32e1f/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4= github.com/coreos/go-systemd/v22 v22.3.2/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= github.com/cpuguy83/go-md2man/v2 v2.0.0/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= +github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY= +github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964/go.mod h1:Xd9hchkHSWYkEqJwUGisez3G1QY8Ryz0sdWrLPMGjLk= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= @@ -114,9 +122,19 @@ github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vb github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk= github.com/go-logfmt/logfmt v0.5.0/go.mod h1:wCYkCAKZfumFQihp8CzCvQ3paCTfi41vtzG1KdI/P7A= +github.com/go-playground/assert/v2 v2.0.1 h1:MsBgLAaY856+nPRTKrp3/OZK38U/wa0CcBYNjji3q3A= +github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= +github.com/go-playground/locales v0.14.0 h1:u50s323jtVGugKlcYeyzC0etD1HifMjqmJqb8WugfUU= +github.com/go-playground/locales v0.14.0/go.mod h1:sawfccIbzZTqEDETgFXqTho0QybSa7l++s0DH+LDiLs= +github.com/go-playground/universal-translator v0.18.0 h1:82dyy6p4OuJq4/CByFNOn/jYrnRPArHwAcmLoJZxyho= +github.com/go-playground/universal-translator v0.18.0/go.mod h1:UvRDBj+xPUEGrFYl+lu/H90nyDXpg0fqeB/AQUGNTVA= +github.com/go-playground/validator/v10 v10.9.0 h1:NgTtmN58D0m8+UuxtYmGztBJB7VnPgjj221I1QHci2A= +github.com/go-playground/validator/v10 v10.9.0/go.mod h1:74x4gJWsvQexRdW8Pn3dXSGrTK4nAUsbPlLADvpJkos= github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= +github.com/gofrs/uuid v4.0.0+incompatible h1:1SD/1F5pU8p29ybwgQSwpQk+mwdRrXCYuPhW6m+TnJw= +github.com/gofrs/uuid v4.0.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM= github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= @@ -222,8 +240,61 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1: github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/inconshreveable/mousetrap v1.0.0 h1:Z8tu5sraLXCXIcARxBp/8cbvlwVa7Z1NHg9XEKhtSvM= github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8= +github.com/jackc/chunkreader v1.0.0 h1:4s39bBR8ByfqH+DKm8rQA3E1LHZWB9XWcrz8fqaZbe0= +github.com/jackc/chunkreader v1.0.0/go.mod h1:RT6O25fNZIuasFJRyZ4R/Y2BbhasbmZXF9QQ7T3kePo= +github.com/jackc/chunkreader/v2 v2.0.0/go.mod h1:odVSm741yZoC3dpHEUXIqA9tQRhFrgOHwnPIn9lDKlk= +github.com/jackc/chunkreader/v2 v2.0.1 h1:i+RDz65UE+mmpjTfyz0MoVTnzeYxroil2G82ki7MGG8= +github.com/jackc/chunkreader/v2 v2.0.1/go.mod h1:odVSm741yZoC3dpHEUXIqA9tQRhFrgOHwnPIn9lDKlk= +github.com/jackc/pgconn v0.0.0-20190420214824-7e0022ef6ba3/go.mod h1:jkELnwuX+w9qN5YIfX0fl88Ehu4XC3keFuOJJk9pcnA= +github.com/jackc/pgconn v0.0.0-20190824142844-760dd75542eb/go.mod h1:lLjNuW/+OfW9/pnVKPazfWOgNfH2aPem8YQ7ilXGvJE= +github.com/jackc/pgconn v0.0.0-20190831204454-2fabfa3c18b7/go.mod h1:ZJKsE/KZfsUgOEh9hBm+xYTstcNHg7UPMVJqRfQxq4s= +github.com/jackc/pgconn v1.8.0/go.mod h1:1C2Pb36bGIP9QHGBYCjnyhqu7Rv3sGshaQUvmfGIB/o= +github.com/jackc/pgconn v1.9.0/go.mod h1:YctiPyvzfU11JFxoXokUOOKQXQmDMoJL9vJzHH8/2JY= +github.com/jackc/pgconn v1.9.1-0.20210724152538-d89c8390a530/go.mod h1:4z2w8XhRbP1hYxkpTuBjTS3ne3J48K83+u0zoyvg2pI= +github.com/jackc/pgconn v1.10.0 h1:4EYhlDVEMsJ30nNj0mmgwIUXoq7e9sMJrVC2ED6QlCU= +github.com/jackc/pgconn v1.10.0/go.mod h1:4z2w8XhRbP1hYxkpTuBjTS3ne3J48K83+u0zoyvg2pI= +github.com/jackc/pgerrcode v0.0.0-20201024163028-a0d42d470451 h1:WAvSpGf7MsFuzAtK4Vk7R4EVe+liW4x83r4oWu0WHKw= +github.com/jackc/pgerrcode v0.0.0-20201024163028-a0d42d470451/go.mod h1:a/s9Lp5W7n/DD0VrVoyJ00FbP2ytTPDVOivvn2bMlds= +github.com/jackc/pgio v1.0.0 h1:g12B9UwVnzGhueNavwioyEEpAmqMe1E/BN9ES+8ovkE= +github.com/jackc/pgio v1.0.0/go.mod h1:oP+2QK2wFfUWgr+gxjoBH9KGBb31Eio69xUb0w5bYf8= +github.com/jackc/pgmock v0.0.0-20190831213851-13a1b77aafa2/go.mod h1:fGZlG77KXmcq05nJLRkk0+p82V8B8Dw8KN2/V9c/OAE= +github.com/jackc/pgmock v0.0.0-20201204152224-4fe30f7445fd/go.mod h1:hrBW0Enj2AZTNpt/7Y5rr2xe/9Mn757Wtb2xeBzPv2c= +github.com/jackc/pgmock v0.0.0-20210724152146-4ad1a8207f65 h1:DadwsjnMwFjfWc9y5Wi/+Zz7xoE5ALHsRQlOctkOiHc= +github.com/jackc/pgmock v0.0.0-20210724152146-4ad1a8207f65/go.mod h1:5R2h2EEX+qri8jOWMbJCtaPWkrrNc7OHwsp2TCqp7ak= +github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM= +github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg= +github.com/jackc/pgproto3 v1.1.0 h1:FYYE4yRw+AgI8wXIinMlNjBbp/UitDJwfj5LqqewP1A= +github.com/jackc/pgproto3 v1.1.0/go.mod h1:eR5FA3leWg7p9aeAqi37XOTgTIbkABlvcPB3E5rlc78= +github.com/jackc/pgproto3/v2 v2.0.0-alpha1.0.20190420180111-c116219b62db/go.mod h1:bhq50y+xrl9n5mRYyCBFKkpRVTLYJVWeCc+mEAI3yXA= +github.com/jackc/pgproto3/v2 v2.0.0-alpha1.0.20190609003834-432c2951c711/go.mod h1:uH0AWtUmuShn0bcesswc4aBTWGvw0cAxIJp+6OB//Wg= +github.com/jackc/pgproto3/v2 v2.0.0-rc3/go.mod h1:ryONWYqW6dqSg1Lw6vXNMXoBJhpzvWKnT95C46ckYeM= +github.com/jackc/pgproto3/v2 v2.0.0-rc3.0.20190831210041-4c03ce451f29/go.mod h1:ryONWYqW6dqSg1Lw6vXNMXoBJhpzvWKnT95C46ckYeM= +github.com/jackc/pgproto3/v2 v2.0.6/go.mod h1:WfJCnwN3HIg9Ish/j3sgWXnAfK8A9Y0bwXYU5xKaEdA= +github.com/jackc/pgproto3/v2 v2.1.1 h1:7PQ/4gLoqnl87ZxL7xjO0DR5gYuviDCZxQJsUlFW1eI= +github.com/jackc/pgproto3/v2 v2.1.1/go.mod h1:WfJCnwN3HIg9Ish/j3sgWXnAfK8A9Y0bwXYU5xKaEdA= +github.com/jackc/pgservicefile v0.0.0-20200714003250-2b9c44734f2b h1:C8S2+VttkHFdOOCXJe+YGfa4vHYwlt4Zx+IVXQ97jYg= +github.com/jackc/pgservicefile v0.0.0-20200714003250-2b9c44734f2b/go.mod h1:vsD4gTJCa9TptPL8sPkXrLZ+hDuNrZCnj29CQpr4X1E= +github.com/jackc/pgtype v0.0.0-20190421001408-4ed0de4755e0/go.mod h1:hdSHsc1V01CGwFsrv11mJRHWJ6aifDLfdV3aVjFF0zg= +github.com/jackc/pgtype v0.0.0-20190824184912-ab885b375b90/go.mod h1:KcahbBH1nCMSo2DXpzsoWOAfFkdEtEJpPbVLq8eE+mc= +github.com/jackc/pgtype v0.0.0-20190828014616-a8802b16cc59/go.mod h1:MWlu30kVJrUS8lot6TQqcg7mtthZ9T0EoIBFiJcmcyw= +github.com/jackc/pgtype v1.8.1-0.20210724151600-32e20a603178/go.mod h1:C516IlIV9NKqfsMCXTdChteoXmwgUceqaLfjg2e3NlM= +github.com/jackc/pgtype v1.8.1 h1:9k0IXtdJXHJbyAWQgbWr1lU+MEhPXZz6RIXxfR5oxXs= +github.com/jackc/pgtype v1.8.1/go.mod h1:LUMuVrfsFfdKGLw+AFFVv6KtHOFMwRgDDzBt76IqCA4= +github.com/jackc/pgx/v4 v4.0.0-20190420224344-cc3461e65d96/go.mod h1:mdxmSJJuR08CZQyj1PVQBHy9XOp5p8/SHH6a0psbY9Y= +github.com/jackc/pgx/v4 v4.0.0-20190421002000-1b8f0016e912/go.mod h1:no/Y67Jkk/9WuGR0JG/JseM9irFbnEPbuWV2EELPNuM= +github.com/jackc/pgx/v4 v4.0.0-pre1.0.20190824185557-6972a5742186/go.mod h1:X+GQnOEnf1dqHGpw7JmHqHc1NxDoalibchSk9/RWuDc= +github.com/jackc/pgx/v4 v4.12.1-0.20210724153913-640aa07df17c/go.mod h1:1QD0+tgSXP7iUjYm9C1NxKhny7lq6ee99u/z+IHFcgs= +github.com/jackc/pgx/v4 v4.13.0 h1:JCjhT5vmhMAf/YwBHLvrBn4OGdIQBiFG6ym8Zmdx570= +github.com/jackc/pgx/v4 v4.13.0/go.mod h1:9P4X524sErlaxj0XSGZk7s+LD0eOyu1ZDUrrpznYDF0= +github.com/jackc/puddle v0.0.0-20190413234325-e4ced69a3a2b/go.mod h1:m4B5Dj62Y0fbyuIc15OsIqK0+JU8nkqQjsgx7dvjSWk= +github.com/jackc/puddle v0.0.0-20190608224051-11cab39313c9/go.mod h1:m4B5Dj62Y0fbyuIc15OsIqK0+JU8nkqQjsgx7dvjSWk= +github.com/jackc/puddle v1.1.3/go.mod h1:m4B5Dj62Y0fbyuIc15OsIqK0+JU8nkqQjsgx7dvjSWk= github.com/jeremywohl/flatten v1.0.1 h1:LrsxmB3hfwJuE+ptGOijix1PIfOoKLJ3Uee/mzbgtrs= github.com/jeremywohl/flatten v1.0.1/go.mod h1:4AmD/VxjWcI5SRB0n6szE2A6s2fsNHDLO0nAlMHgfLQ= +github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E= +github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc= +github.com/jinzhu/now v1.1.2 h1:eVKgfIdy9b6zbWBMgFpfDPoAMifwSZagU9HmEU6zgiI= +github.com/jinzhu/now v1.1.2/go.mod h1:d3SSVoowX0Lcu0IBviAWJpolVfI5UJVZZ7cO71lE/z8= github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k= github.com/jpillora/backoff v1.0.0/go.mod h1:J/6gKK9jxlEcS3zixgDgUAsiuZ7yrSoa/FX5e0EB2j4= github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= @@ -238,27 +309,45 @@ github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8 github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/konsorten/go-windows-terminal-sequences v1.0.2/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg= github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= +github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= +github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0= +github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= -github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= +github.com/kr/pty v1.1.8/go.mod h1:O1sed60cT9XZ5uDucP5qwvh+TE3NnUj51EiZO/lmSfw= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leodido/go-urn v1.2.1 h1:BqpAaACuzVSgi/VLzGZIobT2z4v53pjosyNd9Yv6n/w= +github.com/leodido/go-urn v1.2.1/go.mod h1:zt4jvISO2HfUBqxjfIshjdMTYS56ZS/qv49ictyFfxY= +github.com/lib/pq v1.0.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo= +github.com/lib/pq v1.1.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo= +github.com/lib/pq v1.2.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo= +github.com/lib/pq v1.10.2 h1:AqzbZs4ZoCBp+GtejcpCpcxM3zlSMx29dXbUSeVtJb8= +github.com/lib/pq v1.10.2/go.mod h1:AlVN5x4E4T544tWzH6hKfbfQvm3HdbOxrmggDNAPY9o= github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= github.com/magiconair/properties v1.8.5 h1:b6kJs+EmPFMYGkow9GiUyCyOvIwYetYJ3fSaWak/Gls= github.com/magiconair/properties v1.8.5/go.mod h1:y3VJvCyxH9uVvJTWEGAELF3aiYNyPKd5NZ3oSwXrF60= github.com/mailru/easyjson v0.7.1 h1:mdxE1MF9o53iCb2Ghj1VfWvh7ZOwHpnVG/xwXrV90U8= github.com/mailru/easyjson v0.7.1/go.mod h1:KAzv3t3aY1NaHWoQz1+4F1ccyAH66Jk7yos7ldAVICs= github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU= +github.com/mattn/go-colorable v0.1.1/go.mod h1:FuOcm+DKB9mbwrcAfNl7/TZVBZ6rcnceauSikq3lYCQ= github.com/mattn/go-colorable v0.1.6/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc= github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4= +github.com/mattn/go-isatty v0.0.5/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= +github.com/mattn/go-isatty v0.0.7/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= github.com/mattn/go-isatty v0.0.13/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI= github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= +github.com/mattn/go-sqlite3 v1.14.9 h1:10HX2Td0ocZpYEjhilsuo6WWtUqttj2Kb0KtD86/KYA= +github.com/mattn/go-sqlite3 v1.14.9/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU= github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= github.com/mcuadros/go-defaults v1.2.0 h1:FODb8WSf0uGaY8elWJAkoLL0Ri6AlZ1bFlenk56oZtc= github.com/mcuadros/go-defaults v1.2.0/go.mod h1:WEZtHEVIGYVDqkKSWBdWKUVdRyKlMfulPaGDWIVeCWY= @@ -289,7 +378,6 @@ github.com/newrelic/go-agent/v3/integrations/nrelasticsearch-v7 v1.0.0 h1:8bnHOp github.com/newrelic/go-agent/v3/integrations/nrelasticsearch-v7 v1.0.0/go.mod h1:MqWii42Cz9ouZ3OGXaqoNrflnkF8e73aG/v7jLIzH2w= github.com/newrelic/go-agent/v3/integrations/nrgorilla v1.1.0 h1:3RDWj/QcU5CBP0lJnkh4CwK7tIxsSH53C+GPo5OGFCE= github.com/newrelic/go-agent/v3/integrations/nrgorilla v1.1.0/go.mod h1:1XnCVdRSKjS5ikMycFh7VKXBkk0oYPaKQb+sd6aSCoA= -github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs= github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= github.com/odpf/salt v0.0.0-20211028100023-de463ef825e1 h1:iFoq6ugjCrjmZ4eS4AS/HoFwX+uQVSxVpX/qJF4lMzs= github.com/odpf/salt v0.0.0-20211028100023-de463ef825e1/go.mod h1:NVnVQaXur70W/1wo06X6DYu6utZIUI/bMeMGyvFIwyo= @@ -300,6 +388,7 @@ github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFSt github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc= github.com/pelletier/go-toml v1.9.3 h1:zeC5b1GviRUyKYd6OJPvBU/mcVDVoL1OhT17FCt5dSQ= github.com/pelletier/go-toml v1.9.3/go.mod h1:u1nR/EPcESfeI/szUZKdtJ0xRNbUoANCkoOuaOx1Y+c= +github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA= github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= @@ -327,12 +416,23 @@ github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJ github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rogpeppe/fastuuid v1.2.0/go.mod h1:jVj6XXZzXRy/MSR5jhDC/2q6DgLz+nrA6LYCDYWNEvQ= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= +github.com/rogpeppe/go-internal v1.6.1/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc= +github.com/rogpeppe/go-internal v1.8.0 h1:FCbCCtXNOY3UtUuHUYaghJg4y7Fd14rXifAYUAtL9R8= +github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE= +github.com/rs/xid v1.2.1/go.mod h1:+uKXf+4Djp6Md1KODXJxgGQPKngRmWyn10oCKFzNHOQ= +github.com/rs/zerolog v1.13.0/go.mod h1:YbFCdg8HfsridGWAh22vktObvhZbQsZXe4/zB0OKkWU= +github.com/rs/zerolog v1.15.0/go.mod h1:xYTKnLHcpfU2225ny5qZjxnj9NvkumZYjJHlAThCjNc= github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts= +github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0= github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc= github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo= +github.com/shopspring/decimal v0.0.0-20180709203117-cd690d0c9e24/go.mod h1:M+9NzErvs504Cn4c5DxATwIqPbtswREoFCre64PpcG4= +github.com/shopspring/decimal v1.2.0 h1:abSATXmQEYyShuxI4/vyW3tV1MrKAJzCZ/0zLUXYbsQ= +github.com/shopspring/decimal v1.2.0/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o= github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= +github.com/sirupsen/logrus v1.4.1/go.mod h1:ni0Sbl8bgC9z8RoU9G6nDWqqs/fq4eDPysMBDgk/93Q= github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88= github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE= @@ -359,8 +459,9 @@ github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An github.com/spf13/viper v1.8.1 h1:Kq1fyeebqsBfbjZj4EL7gj2IO0mMaiyjYUWcUsl2O44= github.com/spf13/viper v1.8.1/go.mod h1:o0Pch8wJ9BVSWGQMbra6iw0oQ5oktSIBaujf1rJH9Ns= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.1.1 h1:2vfRuCMp5sSVIDSqO8oNnWJq7mPa6KVP3iPIwFBuy8A= github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.2.0 h1:Hbg2NidpLE8veEBkEZTL3CvlkUIVzuU9jDplZO54c48= +github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= @@ -377,6 +478,7 @@ github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9dec github.com/yuin/goldmark v1.3.3/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= github.com/yuin/goldmark-emoji v1.0.1/go.mod h1:2w1E6FEWLcDQkoTE+7HU6QF1F6SLlNGjRIBbIZQFqkQ= +github.com/zenazn/goji v0.9.0/go.mod h1:7S9M489iMyHBNxwZnk9/EHS098H4/F6TATF2mIxtB1Q= go.buf.build/odpf/gw/grpc-ecosystem/grpc-gateway v1.1.35/go.mod h1:/LuddrGPi0fwj7ay6Orutt8oFfPz8Y3c8qdBkacJq1A= go.buf.build/odpf/gw/odpf/proton v1.1.9/go.mod h1:I9E8CF7w/690vRNWqBU6qDcUbi3Pi2THdn1yycBVTDQ= go.etcd.io/etcd/api/v3 v3.5.0/go.mod h1:cbVKeC6lCfl7j/8jBhAK6aIYO9XOjdptoxU/nLQcPvs= @@ -390,22 +492,36 @@ go.opencensus.io v0.22.4/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= go.opencensus.io v0.22.5/go.mod h1:5pWMHQbX5EPX2/62yrJeAkowc+lfs/XD7Uxpq3pI6kk= go.opencensus.io v0.23.0/go.mod h1:XItmlyltB5F7CS4xOC1DcqMoFqwtC6OG2xF7mCv7P7E= go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI= +go.uber.org/atomic v1.3.2/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= go.uber.org/atomic v1.4.0/go.mod h1:gD2HeocX3+yG+ygLZcrzQJaqmWj9AIm7n08wl/qW/PE= +go.uber.org/atomic v1.5.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ= +go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ= go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc= go.uber.org/goleak v1.1.10/go.mod h1:8a7PlsEVH3e/a/GLqe5IIrQx6GzcnRmZEufDUTk4A7A= go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0= +go.uber.org/multierr v1.3.0/go.mod h1:VgVr7evmIr6uPjLBxg28wmKNXyqE9akIJ5XnfpiKl+4= +go.uber.org/multierr v1.5.0/go.mod h1:FeouvMocqHpRaaGuG9EjoKcStLC43Zu/fmqdUMPcKYU= go.uber.org/multierr v1.6.0/go.mod h1:cdWPpRnG4AhwMwsgIHip0KRBQjJy5kYEpYjJxpXp9iU= +go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee/go.mod h1:vJERXedbb3MVM5f9Ejo0C68/HhF8uaILCdgjnY+goOA= +go.uber.org/zap v1.9.1/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= go.uber.org/zap v1.10.0/go.mod h1:vwi/ZaCAaUcBkycHslxD9B2zi4UTXhF60s6SWpuDF0Q= +go.uber.org/zap v1.13.0/go.mod h1:zwrFLgMcdUuIBviXEYEH1YKNaOBnKXsx2IPda5bBwHM= go.uber.org/zap v1.17.0/go.mod h1:MXVU+bhUf/A7Xi2HNOnopQOrmycQ5Ih87HtOu4q5SSo= go.uber.org/zap v1.19.0/go.mod h1:xg/QME4nWcxGxrpdeYfq7UvYrLh66cuVKdrbD1XF/NI= golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20181029021203-45a5f77698d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20190411191339-88737f569e3a/go.mod h1:WFFai1msRO1wXaEeE5yQxYXgSfI8pQAWXbQop6sCtWE= golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20190820162420-60c769a6c586/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20201203163018-be400aefbc4c/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I= +golang.org/x/crypto v0.0.0-20210616213533-5ff15b29337e/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 h1:7I4JAnoQBe7ZtJcBaYHi5UtiO8tQHbUSXxL+pnGRANg= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190306152737-a1d7652674e8/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190510132918-efd6b22b2522/go.mod h1:ZjyILWgesfNpC6sMxTJOJm9Kp84zZh5NQWvqDGG3Qr8= @@ -457,6 +573,7 @@ golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLL golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190628185345-da137c7871d7/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20190724013045-ca1201d0de80/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20190813141303-74dc4d7220e7/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200114155413-6afb5195e5aa/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -512,7 +629,9 @@ golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5h golang.org/x/sys v0.0.0-20181026203630-95b1ffbd15a5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190403152447-81d4e9dc473e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190502145724-3ef323f4f1fd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -520,6 +639,7 @@ golang.org/x/sys v0.0.0-20190507160741-ecd444e8653b/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20190606165138-5da285871e9c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190624142023-c5567b49c5d0/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190726091711-fc99dfbffb4e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190813064441-fde4db37ae7a/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -557,8 +677,11 @@ golang.org/x/sys v0.0.0-20210320140829-1e4c9ba3b0c4/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210403161142-5e06dd20ab57/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210603081109-ebe580a85c40 h1:JWgyZ1qgdTaF3N3oxC+MdTV7qvEEgHo3otj+HB5CM7Q= golang.org/x/sys v0.0.0-20210603081109-ebe580a85c40/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069 h1:siQdpVirKtzPhKl3lZWozZraCFObP8S1v6PRp0bLrtU= +golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= @@ -566,8 +689,10 @@ golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3 golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.5 h1:i6eZZ+zk0SOf0xgBpEpPD18qWcJda6q1sxt3S0kzyUQ= golang.org/x/text v0.3.5/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= @@ -579,14 +704,18 @@ golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3 golang.org/x/tools v0.0.0-20190312170243-e65039ee4138/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20190425150028-36563e24a262/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= +golang.org/x/tools v0.0.0-20190425163242-31fd60d6bfdc/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190506145303-2d16b83fe98c/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q= golang.org/x/tools v0.0.0-20190606124116-d0a3d012864b/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190628153133-6cdbf07be9d0/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20190816200558-6889da9d5479/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20190823170909-c4a336ef6a2f/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20190911174233-4f2ddba30aff/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191012152004-8de300cfc20a/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191029041327-9cc4af7d6b2c/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.0.0-20191029190741-b9c20aec41a5/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191108193012-7d206e10da11/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191112195655-aa38f8e97acc/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191113191852-77e3bb0ad9e7/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= @@ -596,6 +725,7 @@ golang.org/x/tools v0.0.0-20191125144606-a911d9008d1f/go.mod h1:b+2E5dAYhXwXZwtn golang.org/x/tools v0.0.0-20191130070609-6e064ea0cf2d/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20191216173652-a0e659d51361/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20191227053925-7b8e75db28f4/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= +golang.org/x/tools v0.0.0-20200103221440-774c71fcf114/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200117161641-43d50277825c/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200122220014-bf1340f18c4a/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.0.0-20200130002326-2f3ba24bd6e7/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= @@ -624,6 +754,8 @@ golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4f golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= golang.org/x/tools v0.1.2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= +golang.org/x/xerrors v0.0.0-20190410155217-1f06c39b4373/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20190513163551-3ee3066db522/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -743,9 +875,11 @@ gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLks gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= -gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU= gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= +gopkg.in/inconshreveable/log15.v2 v2.0.0-20180818164646-67afb5ed74ec/go.mod h1:aPpfJ7XW+gOuirDoZ8gHhLh3kZ1B08FtV2bbmy7Jv3s= gopkg.in/ini.v1 v1.62.0 h1:duBzk771uxoUuOlyRLkHsygud9+5lrlGjdFBb4mSKDU= gopkg.in/ini.v1 v1.62.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= @@ -760,6 +894,13 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo= gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gorm.io/driver/postgres v1.2.2 h1:Ka9W6feOU+rPM9m007eYLMD4QoZuYGBnQ3Jp0faGSwg= +gorm.io/driver/postgres v1.2.2/go.mod h1:Ik3tK+a3FMp8ORZl29v4b3M0RsgXsaeMXh9s9eVMXco= +gorm.io/driver/sqlite v1.2.6 h1:SStaH/b+280M7C8vXeZLz/zo9cLQmIGwwj3cSj7p6l4= +gorm.io/driver/sqlite v1.2.6/go.mod h1:gyoX0vHiiwi0g49tv+x2E7l8ksauLK0U/gShcdUsjWY= +gorm.io/gorm v1.22.2/go.mod h1:F+OptMscr0P2F2qU97WT1WimdH9GaQPoDW7AYd5i2Y0= +gorm.io/gorm v1.22.3 h1:/JS6z+GStEQvJNW3t1FTwJwG/gZ+A7crFdRqtvG5ehA= +gorm.io/gorm v1.22.3/go.mod h1:F+OptMscr0P2F2qU97WT1WimdH9GaQPoDW7AYd5i2Y0= honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190106161140-3f1c8253044a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4= diff --git a/store/postgres/errors.go b/store/postgres/errors.go new file mode 100644 index 00000000..d4b6ea35 --- /dev/null +++ b/store/postgres/errors.go @@ -0,0 +1,7 @@ +package postgres + +import "errors" + +var ( + errNilDBClient = errors.New("db client is nil") +) diff --git a/store/postgres/model.go b/store/postgres/model.go new file mode 100644 index 00000000..02c0c0af --- /dev/null +++ b/store/postgres/model.go @@ -0,0 +1,40 @@ +package postgres + +import "time" + +// Tag is a model for tag value in database table +type Tag struct { + ID uint `gorm:"primaryKey"` + Value string `gorm:"not null"` + RecordType string `gorm:"not null;uniqueIndex:tag_idx_record_urn_record_type_field_id"` + RecordURN string `gorm:"not null;uniqueIndex:tag_idx_record_urn_record_type_field_id"` + FieldID uint `gorm:"not null;uniqueIndex:tag_idx_record_urn_record_type_field_id"` + Field Field `gorm:"not null;constraint:OnDelete:CASCADE"` + CreatedAt time.Time + UpdatedAt time.Time +} + +// Template is a model for template database table +type Template struct { + URN string `gorm:"primaryKey"` + DisplayName string `gorm:"not null"` + Description string `gorm:"not null"` + Fields []Field `gorm:"not null"` + CreatedAt time.Time + UpdatedAt time.Time +} + +// Field is a model for field tag in database table +type Field struct { + ID uint `gorm:"primaryKey"` + URN string `gorm:"not null;uniqueIndex:field_idx_urn_template_urn"` + DisplayName string `gorm:"not null"` + Description string `gorm:"not null"` + DataType string `gorm:"not null"` + Options *string + Required bool `gorm:"not null"` + TemplateURN string `gorm:"not null;uniqueIndex:field_idx_urn_template_urn"` + Template Template `gorm:"not null;constraint:OnDelete:CASCADE"` + CreatedAt time.Time + UpdatedAt time.Time +} diff --git a/store/postgres/setup.go b/store/postgres/setup.go new file mode 100644 index 00000000..c4e68cda --- /dev/null +++ b/store/postgres/setup.go @@ -0,0 +1,33 @@ +package postgres + +import ( + "fmt" + "strings" + + "gorm.io/driver/postgres" + "gorm.io/gorm" +) + +type Config struct { + Host string + Port int + Name string + User string + Password string + SSLMode string +} + +// NewClient initializes database connection +func NewClient(cfg Config) (*gorm.DB, error) { + dsn := fmt.Sprintf( + "host=%s port=%d dbname=%s user=%s password=%s sslmode=%s", + strings.TrimSpace(cfg.Host), + cfg.Port, + strings.TrimSpace(cfg.Name), + strings.TrimSpace(cfg.User), + strings.TrimSpace(cfg.Password), + strings.TrimSpace(cfg.SSLMode), + ) + + return gorm.Open(postgres.Open(dsn), &gorm.Config{}) +} diff --git a/store/postgres/tag_repository.go b/store/postgres/tag_repository.go new file mode 100644 index 00000000..670c2b3d --- /dev/null +++ b/store/postgres/tag_repository.go @@ -0,0 +1,395 @@ +package postgres + +import ( + "fmt" + "strings" + + "github.com/jackc/pgconn" + "github.com/jackc/pgerrcode" + "github.com/odpf/columbus/tag" + "github.com/pkg/errors" + + "gorm.io/gorm" +) + +var ( + errNilDomainTag = errors.New("domain tag is nil") + errEmptyRecordType = errors.New("record type should not be empty") + errEmptyRecordURN = errors.New("record urn should not be empty") +) + +// TagRepository is a type that manages tag operation ot the primary database +type TagRepository struct { + dbClient *gorm.DB +} + +// Create inserts tag to database +func (r *TagRepository) Create(domainTag *tag.Tag) error { + if r.dbClient == nil { + return errNilDBClient + } + if domainTag == nil { + return errNilDomainTag + } + recordModelTemplate, err := r.getTemplateWithFields(domainTag.TemplateURN) + if err != nil { + return err + } + domainTemplate := r.convertToDomainTemplate(recordModelTemplate) + err = r.dbClient.Transaction(func(tx *gorm.DB) error { + return r.insertDomainTagToDB(tx, domainTag) + }) + if err != nil { + return err + } + + listOfRecordModelTag, err := r.readListOfModelTagFromDB(r.dbClient, domainTag.RecordType, domainTag.RecordURN, domainTemplate) + if err == nil { + err = r.complementDomainTag(domainTag, domainTemplate, listOfRecordModelTag) + return err + } + + return nil +} + +// Read reads tags grouped by its template +func (r *TagRepository) Read(filter tag.Tag) ([]tag.Tag, error) { + if r.dbClient == nil { + return nil, errNilDBClient + } + if filter.RecordType == "" { + return nil, errEmptyRecordType + } + if filter.RecordURN == "" { + return nil, errEmptyRecordURN + } + if filter.TemplateURN != "" { + recordModelTemplate, err := r.getTemplateWithFields(filter.TemplateURN) + if err != nil { + return nil, err + } + domainTag, err := r.readByRecordAndTemplateFromDB(r.dbClient, filter.RecordType, filter.RecordURN, recordModelTemplate) + if err != nil { + return nil, err + } + return []tag.Tag{domainTag}, nil + } + return r.readByRecordFromDB(r.dbClient, filter.RecordType, filter.RecordURN) +} + +// Update updates tags in the database +func (r *TagRepository) Update(domainTag *tag.Tag) error { + if r.dbClient == nil { + return errNilDBClient + } + if domainTag == nil { + return errNilDomainTag + } + recordModelTemplate, err := r.getTemplateWithFields(domainTag.TemplateURN) + if err != nil { + return err + } + domainTemplate := r.convertToDomainTemplate(recordModelTemplate) + err = r.dbClient.Transaction(func(tx *gorm.DB) error { + return r.updateDomainTagToDB(tx, domainTag) + }) + if err == nil { + listOfRecordModelTag, err := r.readListOfModelTagFromDB(r.dbClient, domainTag.RecordType, domainTag.RecordURN, domainTemplate) + if err == nil { + err = r.complementDomainTag(domainTag, domainTemplate, listOfRecordModelTag) + } + } + return err +} + +// Delete deletes tags from database +func (r *TagRepository) Delete(domainTag tag.Tag) error { + if r.dbClient == nil { + return errNilDBClient + } + if domainTag.RecordURN == "" { + return errEmptyRecordURN + } + if domainTag.TemplateURN != "" { + recordModelTemplate, err := r.getTemplateWithFields(domainTag.TemplateURN) + if err != nil { + return err + } + return r.deleteByRecordAndTemplate(r.dbClient, domainTag.RecordType, domainTag.RecordURN, recordModelTemplate) + } + return r.dbClient.Where("record_type = ? and record_urn = ?", domainTag.RecordType, domainTag.RecordURN).Delete(&Tag{}).Error +} + +func (r *TagRepository) updateDomainTagToDB(tx *gorm.DB, domainTag *tag.Tag) error { + for _, value := range domainTag.TagValues { + if value.FieldValue == nil || value.FieldValue == "" { + continue + } + var recordModelTag Tag + queryResult := tx.Where("record_type = ? and record_urn = ? and field_id = ?", domainTag.RecordType, domainTag.RecordURN, value.FieldID).First(&recordModelTag) + recordModelTag.Value = fmt.Sprintf("%v", value.FieldValue) + if queryResult.Error != nil { + recordModelTag.RecordURN = domainTag.RecordURN + recordModelTag.FieldID = value.FieldID + createResult := tx.Create(&recordModelTag) + if createResult.Error != nil { + return createResult.Error + } + continue + } + updateResult := tx.Updates(&recordModelTag) + if updateResult.Error != nil { + return updateResult.Error + } + } + return nil +} + +func (r *TagRepository) convertToDomainTemplate(modelTemplate Template) tag.Template { + listOfDomainField := []tag.Field{} + for _, field := range modelTemplate.Fields { + var options []string + if field.Options != nil { + options = strings.Split(*field.Options, ",") + } + listOfDomainField = append(listOfDomainField, tag.Field{ + ID: field.ID, + URN: field.URN, + DisplayName: field.DisplayName, + Description: field.Description, + DataType: field.DataType, + Required: field.Required, + Options: options, + CreatedAt: field.CreatedAt, + UpdatedAt: field.UpdatedAt, + }) + } + return tag.Template{ + URN: modelTemplate.URN, + DisplayName: modelTemplate.DisplayName, + Description: modelTemplate.Description, + Fields: listOfDomainField, + CreatedAt: modelTemplate.CreatedAt, + UpdatedAt: modelTemplate.UpdatedAt, + } +} + +func (r *TagRepository) deleteByRecordAndTemplate(tx *gorm.DB, recordType, recordURN string, template Template) error { + var listOfFieldID []uint + for _, field := range template.Fields { + listOfFieldID = append(listOfFieldID, field.ID) + } + return tx.Where("record_type = ? and record_urn = ? and field_id in ?", recordType, recordURN, listOfFieldID).Delete(&Tag{}).Error +} + +func (r *TagRepository) readByRecordFromDB(tx *gorm.DB, recordType, recordURN string) ([]tag.Tag, error) { + var listOfRecordModelTag []Tag + err := tx.Preload("Field"). + Where("record_type = ? AND record_urn = ?", recordType, recordURN). + Find(&listOfRecordModelTag).Error + if err != nil { + return nil, err + } + listOfTemplateURN := r.getListOfTemplateURN(listOfRecordModelTag) + listOfTemplate, err := r.getListOfTemplateByListOfURNFromDB(tx, listOfTemplateURN) + if err != nil { + return nil, err + } + templateByURN := r.mapTemplateByTemplateURN(listOfTemplate) + tagsByTemplateURN := r.mapTagsByTemplateURN(listOfRecordModelTag) + output := []tag.Tag{} + for templateURN, tags := range tagsByTemplateURN { + domainTag := r.convertToDomainTag(recordType, recordURN, templateByURN[templateURN], tags) + output = append(output, domainTag) + } + return output, nil +} + +func (r *TagRepository) mapTagsByTemplateURN(tags []Tag) map[string][]Tag { + tagsByTemplateURN := make(map[string][]Tag) + for _, t := range tags { + key := t.Field.TemplateURN + if tagsByTemplateURN[key] == nil { + tagsByTemplateURN[key] = []Tag{} + } + tagsByTemplateURN[key] = append(tagsByTemplateURN[key], t) + } + return tagsByTemplateURN +} + +func (r *TagRepository) mapTemplateByTemplateURN(templates []Template) map[string]Template { + templateByURN := make(map[string]Template) + for _, t := range templates { + templateByURN[t.URN] = t + } + return templateByURN +} + +func (r *TagRepository) getListOfTemplateURN(tags []Tag) []string { + isURNRegistered := make(map[string]bool) + for _, t := range tags { + key := t.Field.TemplateURN + if !isURNRegistered[key] { + isURNRegistered[key] = true + } + } + var output []string + for urn := range isURNRegistered { + output = append(output, urn) + } + return output +} + +func (r *TagRepository) getListOfTemplateByListOfURNFromDB(tx *gorm.DB, listOfTemplateURN []string) ([]Template, error) { + var listOfTemplate []Template + err := tx.Where("urn in ?", listOfTemplateURN).Find(&listOfTemplate).Error + if err != nil { + return nil, err + } + return listOfTemplate, nil +} + +func (r *TagRepository) readByRecordAndTemplateFromDB(tx *gorm.DB, recordType, recordURN string, template Template) (tag.Tag, error) { + var listOfRecordModelTag []Tag + for _, field := range template.Fields { + var recordModelTag Tag + result := tx.Preload("Field"). + Where("record_type = ? and record_urn = ? and field_id = ?", recordType, recordURN, field.ID). + First(&recordModelTag) + if result.Error != nil { + wrappedErr := fmt.Errorf("error looking for record urn [%s] and template urn [%s]: %w", recordURN, template.URN, result.Error) + + if errors.Is(result.Error, gorm.ErrRecordNotFound) { + wrappedErr = tag.NotFoundError{ + URN: recordURN, + Type: recordType, + Template: field.TemplateURN, + } + } + return tag.Tag{}, wrappedErr + } + listOfRecordModelTag = append(listOfRecordModelTag, recordModelTag) + } + return r.convertToDomainTag(recordType, recordURN, template, listOfRecordModelTag), nil +} + +func (r *TagRepository) convertToDomainTag(recordType, recordURN string, template Template, tags []Tag) tag.Tag { + var listOfDomainTagValue []tag.TagValue + for _, t := range tags { + var options []string + if t.Field.Options != nil { + options = strings.Split(*t.Field.Options, ",") + } + parsedValue, _ := tag.ParseTagValue(template.URN, t.FieldID, t.Field.DataType, t.Value, options) + listOfDomainTagValue = append(listOfDomainTagValue, tag.TagValue{ + FieldID: t.FieldID, + FieldValue: parsedValue, + FieldURN: t.Field.URN, + FieldDisplayName: t.Field.DisplayName, + FieldDescription: t.Field.Description, + FieldDataType: t.Field.DataType, + FieldOptions: options, + FieldRequired: t.Field.Required, + CreatedAt: t.CreatedAt, + UpdatedAt: t.UpdatedAt, + }) + } + return tag.Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: template.URN, + TagValues: listOfDomainTagValue, + TemplateDisplayName: template.DisplayName, + TemplateDescription: template.Description, + } +} + +func (r *TagRepository) complementDomainTag(domainTag *tag.Tag, domainTemplate tag.Template, listOfRecordModelTag []Tag) error { + tagByFieldID := make(map[uint]Tag) + for _, t := range listOfRecordModelTag { + tagByFieldID[t.FieldID] = t + } + var listOfDomainTagValue []tag.TagValue + for _, field := range domainTemplate.Fields { + t := tagByFieldID[field.ID] + parsedValue, _ := tag.ParseTagValue(domainTag.TemplateURN, field.ID, field.DataType, t.Value, field.Options) + listOfDomainTagValue = append(listOfDomainTagValue, tag.TagValue{ + FieldID: field.ID, + FieldValue: parsedValue, + FieldURN: field.URN, + FieldDisplayName: field.DisplayName, + FieldDescription: field.Description, + FieldDataType: field.DataType, + FieldOptions: field.Options, + FieldRequired: field.Required, + CreatedAt: t.CreatedAt, + UpdatedAt: t.UpdatedAt, + }) + } + domainTag.TemplateURN = domainTemplate.URN + domainTag.TemplateDescription = domainTemplate.Description + domainTag.TemplateDisplayName = domainTemplate.DisplayName + domainTag.TagValues = listOfDomainTagValue + return nil +} + +func (r *TagRepository) getTemplateWithFields(templateURN string) (Template, error) { + var template Template + queryResult := r.dbClient.Preload("Fields").First(&template, "urn = ?", templateURN) + if queryResult.Error == gorm.ErrRecordNotFound { + return template, tag.TemplateNotFoundError{URN: templateURN} + } + + return template, queryResult.Error +} + +func (r *TagRepository) readListOfModelTagFromDB(tx *gorm.DB, recordType, recordURN string, domainTemplate tag.Template) ([]Tag, error) { + var tags []Tag + for _, field := range domainTemplate.Fields { + var t Tag + err := tx.Preload("Field").Where("record_type = ? and record_urn = ? and field_id = ?", recordType, recordURN, field.ID).First(&t).Error + if err != nil { + continue + } + tags = append(tags, t) + } + return tags, nil +} +func (r *TagRepository) insertDomainTagToDB(tx *gorm.DB, domainTag *tag.Tag) error { + for _, tv := range domainTag.TagValues { + if tv.FieldValue == nil { + continue + } + modelTag := Tag{ + RecordType: domainTag.RecordType, + RecordURN: domainTag.RecordURN, + FieldID: tv.FieldID, + Value: fmt.Sprintf("%v", tv.FieldValue), + } + createResult := tx.Create(&modelTag) + if createResult.Error != nil { + // this is pg driver specific error and not gorm + // might not work for DB other than pg + var pgErr *pgconn.PgError + if errors.As(createResult.Error, &pgErr) { + switch pgErr.Code { + case pgerrcode.UniqueViolation: + return tag.DuplicateError{RecordURN: domainTag.RecordURN, RecordType: domainTag.RecordType, TemplateURN: domainTag.TemplateURN} + } + } + + return createResult.Error + } + } + return nil +} + +// NewTagRepository initializes tag repository +func NewTagRepository(dbClient *gorm.DB) *TagRepository { + if dbClient == nil { + panic(errNilDBClient.Error()) + } + return &TagRepository{ + dbClient: dbClient, + } +} diff --git a/store/postgres/tag_repository_test.go b/store/postgres/tag_repository_test.go new file mode 100644 index 00000000..4270078d --- /dev/null +++ b/store/postgres/tag_repository_test.go @@ -0,0 +1,493 @@ +package postgres_test + +import ( + "fmt" + "strings" + "testing" + + "github.com/odpf/columbus/store/postgres" + "github.com/odpf/columbus/tag" + + "github.com/stretchr/testify/suite" + "gorm.io/gorm" +) + +type TagRepositoryTestSuite struct { + suite.Suite + dbClient *gorm.DB + repository *postgres.TagRepository +} + +func (r *TagRepositoryTestSuite) TestNewTagRepository() { + r.Run("should return repository and nil if db client is not nil", func() { + dbClient := &gorm.DB{} + + actualTagRepository := postgres.NewTagRepository(dbClient) + + r.NotNil(actualTagRepository) + }) +} + +func (r *TagRepositoryTestSuite) Setup() { + r.dbClient, _ = newTestClient("file::memory:") + r.dbClient.AutoMigrate(&postgres.Template{}) + r.dbClient.AutoMigrate(&postgres.Field{}) + r.dbClient.AutoMigrate(&postgres.Tag{}) + repository := postgres.NewTagRepository(r.dbClient) + r.repository = repository +} + +func (r *TagRepositoryTestSuite) TestCreate() { + r.Run("should return error if domain tag is nil", func() { + r.Setup() + var domainTag *tag.Tag = nil + + expectedErrorMsg := "domain tag is nil" + + actualError := r.repository.Create(domainTag) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if db client is nil", func() { + domainTag := &tag.Tag{} + repository := &postgres.TagRepository{} + + expectedErrorMsg := "db client is nil" + + actualError := repository.Create(domainTag) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if template is not found", func() { + r.Setup() + t := r.getDomainTag() + + err := r.repository.Create(&t) + r.ErrorIs(err, tag.TemplateNotFoundError{URN: t.TemplateURN}) + }) + + r.Run("should return nil and create tag if no error found", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + r.createDomainTemplate(domainTemplate) + domainTag := r.getDomainTag() + + actualError := r.repository.Create(&domainTag) + r.NoError(actualError) + + for _, value := range domainTag.TagValues { + var actualRecord postgres.Tag + queryResult := r.dbClient.Where(postgres.Tag{ + RecordURN: domainTag.RecordURN, + FieldID: value.FieldID, + }).First(&actualRecord) + + r.NoError(queryResult.Error) + } + }) + + r.Run("should return nil and update domain tag if no error found", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + r.createDomainTemplate(domainTemplate) + domainTag := r.getDomainTag() + + actualError := r.repository.Create(&domainTag) + r.NoError(actualError) + + for _, value := range domainTag.TagValues { + r.NotZero(value.CreatedAt) + } + }) +} + +func (r *TagRepositoryTestSuite) TestRead() { + r.Run("should return nil and error if db client is nil", func() { + var recordURN string = "sample-urn" + repository := &postgres.TagRepository{} + paramDomainTag := tag.Tag{ + RecordURN: recordURN, + } + + expectedErrorMsg := "db client is nil" + + actualTag, actualError := repository.Read(paramDomainTag) + + r.Nil(actualTag) + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if record type is empty", func() { + r.Setup() + paramDomainTag := tag.Tag{ + RecordType: "", + RecordURN: "sample-urn", + } + + expectedErrorMsg := "record type should not be empty" + + actualTag, actualError := r.repository.Read(paramDomainTag) + + r.Nil(actualTag) + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return nil and error if record urn is empty", func() { + r.Setup() + var recordURN string = "" + paramDomainTag := tag.Tag{ + RecordType: "sample-type", + RecordURN: recordURN, + } + + expectedErrorMsg := "record urn should not be empty" + + actualTag, actualError := r.repository.Read(paramDomainTag) + + r.Nil(actualTag) + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return empty and nil if no record found for the specified record", func() { + r.Setup() + paramDomainTag := tag.Tag{ + RecordType: "sample-type", + RecordURN: "sample-urn", + } + + actualTag, actualError := r.repository.Read(paramDomainTag) + r.NoError(actualError) + r.Empty(actualTag) + }) + + r.Run("should return record if found for the specified record", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + r.createDomainTemplate(domainTemplate) + domainTag := r.getDomainTag() + err := r.repository.Create(&domainTag) + r.Require().NoError(err) + + tags, err := r.repository.Read(tag.Tag{ + RecordType: domainTag.RecordType, + RecordURN: domainTag.RecordURN, + }) + r.NoError(err) + r.NotEmpty(tags) + }) + + r.Run("should return nil and error if template urn is not empty but template is not found", func() { + r.Setup() + paramDomainTag := tag.Tag{ + RecordURN: "sample-urn", + RecordType: "sample-type", + TemplateURN: "governance_policy", + } + + _, err := r.repository.Read(paramDomainTag) + r.ErrorIs(err, tag.TemplateNotFoundError{URN: "governance_policy"}) + }) + + r.Run("should return nil and not found error if no record found for the specified record and template", func() { + r.Setup() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + var templateURN string = "governance_policy" + domainTemplate := r.getDomainTemplate() + r.createDomainTemplate(domainTemplate) + paramDomainTag := tag.Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: templateURN, + } + + expectedErrorMsg := fmt.Sprintf("could not find tag with record type: \"%s\", record: \"%s\", template: \"%s\"", + recordType, recordURN, templateURN, + ) + + actualTag, actualError := r.repository.Read(paramDomainTag) + r.ErrorAs(actualError, new(tag.NotFoundError)) + r.EqualError(actualError, expectedErrorMsg) + r.Nil(actualTag) + }) + + r.Run("should return maximum of one domain tag for the specified record and template", func() { + r.Setup() + var recordType string = "sample-type" + var recordURN string = "sample-urn" + var templateURN string = "governance_policy" + domainTemplate := r.getDomainTemplate() + r.createDomainTemplate(domainTemplate) + domainTag := r.getDomainTag() + if err := r.repository.Create(&domainTag); err != nil { + panic(err) + } + paramDomainTag := tag.Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: templateURN, + } + + expectedLength := 1 + + actualTag, actualError := r.repository.Read(paramDomainTag) + + r.Len(actualTag, expectedLength) + r.NoError(actualError) + }) +} + +func (r *TagRepositoryTestSuite) TestUpdate() { + r.Run("should return error if domain tag is nil", func() { + r.Setup() + var domainTag *tag.Tag = nil + + expectedErrorMsg := "domain tag is nil" + + actualError := r.repository.Update(domainTag) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if db client is nil", func() { + domainTag := &tag.Tag{} + repository := &postgres.TagRepository{} + + expectedErrorMsg := "db client is nil" + + actualError := repository.Update(domainTag) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if template is not found", func() { + r.Setup() + t := r.getDomainTag() + + err := r.repository.Update(&t) + r.ErrorIs(err, tag.TemplateNotFoundError{URN: t.TemplateURN}) + }) + + r.Run("should return nil and update tag if no error found", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + r.createDomainTemplate(domainTemplate) + domainTag := r.getDomainTag() + err := r.repository.Create(&domainTag) + r.Require().NoError(err) + + domainTag.TagValues[0].FieldValue = "Restricted" + actualError := r.repository.Update(&domainTag) + r.Require().NoError(actualError) + + for _, value := range domainTag.TagValues { + var actualRecord postgres.Tag + queryResult := r.dbClient.Where( + "record_urn = ? and field_id = ?", domainTag.RecordURN, value.FieldID, + ).First(&actualRecord) + + r.NoError(queryResult.Error) + r.EqualValues(value.UpdatedAt, actualRecord.UpdatedAt) + } + }) + + r.Run("should return nil and update domain tag if no error found", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + r.createDomainTemplate(domainTemplate) + domainTag := r.getDomainTag() + if err := r.repository.Create(&domainTag); err != nil { + panic(err) + } + domainTag.TagValues = domainTag.TagValues[:1] + + actualError := r.repository.Update(&domainTag) + + r.NoError(actualError) + r.Len(domainTag.TagValues, 2) + }) +} + +func (r *TagRepositoryTestSuite) TestDelete() { + r.Run("should return error if db client is nil", func() { + var recordURN string = "sample-urn" + repository := &postgres.TagRepository{} + paramDomainTag := tag.Tag{ + RecordURN: recordURN, + } + + expectedErrorMsg := "db client is nil" + + actualError := repository.Delete(paramDomainTag) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if record urn is empty", func() { + r.Setup() + var recordURN string = "" + paramDomainTag := tag.Tag{ + RecordURN: recordURN, + } + + expectedErrorMsg := "record urn should not be empty" + + actualError := r.repository.Delete(paramDomainTag) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should delete tags related to the record and return error if record has one", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + r.createDomainTemplate(domainTemplate) + domainTag := r.getDomainTag() + if err := r.repository.Create(&domainTag); err != nil { + r.T().Fatal(err) + } + paramDomainTag := tag.Tag{ + RecordType: domainTag.RecordType, + RecordURN: domainTag.RecordURN, + } + + actualError := r.repository.Delete(paramDomainTag) + var listOfRecordModelTag []postgres.Tag + err := r.dbClient.Where("record_type = ? and record_urn = ?", domainTag.RecordType, domainTag.RecordURN). + Find(&listOfRecordModelTag).Error + if err != nil { + r.T().Fatal(err) + } + + r.NoError(actualError) + r.Empty(listOfRecordModelTag) + }) + + r.Run("should return error if template is not found", func() { + r.Setup() + var recordURN string = "sample-urn" + var templateURN string = "random-urn" + paramDomainTag := tag.Tag{ + RecordURN: recordURN, + TemplateURN: templateURN, + } + + err := r.repository.Delete(paramDomainTag) + r.ErrorIs(err, tag.TemplateNotFoundError{URN: templateURN}) + }) + + r.Run("should delete only the tag for record and template and return nil if record has one", func() { + r.Setup() + var recordURN string = "sample-urn" + domainTemplate := r.getDomainTemplate() + r.createDomainTemplate(domainTemplate) + paramDomainTag := tag.Tag{ + RecordURN: recordURN, + TemplateURN: domainTemplate.URN, + } + + actualError := r.repository.Delete(paramDomainTag) + var listOfRecordModelTag []postgres.Tag + err := r.dbClient.Where("record_urn = ?", recordURN).Find(&listOfRecordModelTag).Error + if err != nil { + panic(err) + } + + r.NoError(actualError) + r.Empty(listOfRecordModelTag) + }) +} + +func (r *TagRepositoryTestSuite) createDomainTemplate(domainTemplate *tag.Template) { + listOfModelField := make([]postgres.Field, len(domainTemplate.Fields)) + for i, domainField := range domainTemplate.Fields { + var options *string + if len(domainField.Options) > 0 { + var concatenatedOption string + strings.Join(domainField.Options, ",") + options = &concatenatedOption + } + listOfModelField[i] = postgres.Field{ + ID: domainField.ID, + URN: domainField.URN, + DisplayName: domainField.DisplayName, + Description: domainField.Description, + DataType: domainField.DataType, + Options: options, + Required: domainField.Required, + } + } + modelTemplate := postgres.Template{ + URN: domainTemplate.URN, + DisplayName: domainTemplate.DisplayName, + Description: domainTemplate.Description, + Fields: listOfModelField, + } + createResult := r.dbClient.Create(&modelTemplate) + if createResult.Error != nil { + r.T().Fatal(createResult.Error) + } +} + +func (r *TagRepositoryTestSuite) getDomainTemplate() *tag.Template { + return &tag.Template{ + URN: "governance_policy", + DisplayName: "Governance Policy", + Description: "Template that is mandatory to be used.", + Fields: []tag.Field{ + { + ID: 1, + URN: "classification", + DisplayName: "classification", + Description: "The classification of this record", + DataType: "enumerated", + Required: true, + Options: []string{"Public", "Restricted"}, + }, + { + ID: 2, + URN: "admin_email", + DisplayName: "Admin Email", + Description: "Email of the admin of therecord.", + DataType: "string", + Required: true, + }, + }, + } +} + +func (r *TagRepositoryTestSuite) getDomainTag() tag.Tag { + return tag.Tag{ + RecordType: "sample-type", + RecordURN: "sample-urn", + TemplateURN: "governance_policy", + TemplateDisplayName: "Governance Policy", + TemplateDescription: "Template that is mandatory to be used.", + TagValues: []tag.TagValue{ + { + FieldID: 1, + FieldValue: "Public", + FieldURN: "classification", + FieldDisplayName: "classification", + FieldDescription: "The classification of this record", + FieldDataType: "enumerated", + FieldRequired: true, + FieldOptions: []string{"Public", "Restricted"}, + }, + { + FieldID: 2, + FieldValue: "dexter@odpf.io", + FieldURN: "admin_email", + FieldDisplayName: "Admin Email", + FieldDescription: "Email of the admin of therecord.", + FieldDataType: "string", + FieldRequired: true, + }, + }, + } +} + +func TestTagRepository(t *testing.T) { + suite.Run(t, &TagRepositoryTestSuite{}) +} diff --git a/store/postgres/template_repository.go b/store/postgres/template_repository.go new file mode 100644 index 00000000..46c19655 --- /dev/null +++ b/store/postgres/template_repository.go @@ -0,0 +1,232 @@ +package postgres + +import ( + "strings" + + "github.com/odpf/columbus/tag" + "github.com/pkg/errors" + "gorm.io/gorm" +) + +const fieldOptionSeparator = "," + +var ( + errNilDomainTemplate = errors.New("domain template is nil") +) + +// TemplateRepository is a type that manages template operation to the primary database +type TemplateRepository struct { + dbClient *gorm.DB +} + +// Create inserts template to database +func (r *TemplateRepository) Create(domainTemplate *tag.Template) error { + if domainTemplate == nil { + return errNilDomainTemplate + } + if r.dbClient == nil { + return errNilDBClient + } + modelTemplate := r.toModelTemplate(*domainTemplate) + if result := r.dbClient.Create(&modelTemplate); result.Error != nil { + return result.Error + } + r.updateDomainTemplate(domainTemplate, modelTemplate) + return nil +} + +// Read reads template from database +func (r *TemplateRepository) Read(filter tag.Template) ([]tag.Template, error) { + if r.dbClient == nil { + return nil, errNilDBClient + } + output := []tag.Template{} + modelTemplate := r.toModelTemplate(filter) + var rows []Template + res := r.dbClient.Where(modelTemplate).Preload("Fields").Find(&rows) + if res.Error != nil { + return output, errors.Wrap(res.Error, "error fetching templates") + } + for _, record := range rows { + tmplt := r.toDomainTemplate(record) + output = append(output, tmplt) + } + return output, nil +} + +// Update updates template into database +func (r *TemplateRepository) Update(domainTemplate *tag.Template) error { + if domainTemplate == nil { + return errNilDomainTemplate + } + if r.dbClient == nil { + return errNilDBClient + } + err := r.dbClient.Transaction(func(tx *gorm.DB) error { + templateToUpdateWith := r.toModelTemplate(*domainTemplate) + if err := r.updateModelTemplateToDB(tx, domainTemplate.URN, templateToUpdateWith); err != nil { + return err + } + return r.updateModelFieldsToDB(tx, templateToUpdateWith.URN, templateToUpdateWith.Fields) + }) + if err != nil { + return errors.Wrap(err, "error updating template") + } + var recordModelTemplate Template + res := r.dbClient.Preload("Fields").First(&recordModelTemplate, "urn = ?", domainTemplate.URN) + if errors.Is(res.Error, gorm.ErrRecordNotFound) { + return tag.TemplateNotFoundError{URN: domainTemplate.URN} + } + if res.Error != nil { + return errors.Wrap(res.Error, "error finding template") + } + + r.updateDomainTemplate(domainTemplate, recordModelTemplate) + return nil +} + +// Delete deletes template and its fields from database +func (r *TemplateRepository) Delete(filter tag.Template) error { + if r.dbClient == nil { + return errNilDBClient + } + var recordModelTemplate Template + res := r.dbClient.Preload("Fields").First(&recordModelTemplate, "urn = ?", filter.URN) + if errors.Is(res.Error, gorm.ErrRecordNotFound) { + return tag.TemplateNotFoundError{URN: filter.URN} + } + if res.Error != nil { + return errors.Wrap(res.Error, "error finding template") + } + deleteResult := r.dbClient.Transaction(func(tx *gorm.DB) error { + for _, field := range recordModelTemplate.Fields { + if err := tx.Delete(&field).Error; err != nil { + return err + } + } + return tx.Delete(&recordModelTemplate).Error + }) + return deleteResult +} + +func (r *TemplateRepository) updateModelTemplateToDB(tx *gorm.DB, targetURN string, templateToUpdateWith Template) error { + var recordModelTemplate Template + if err := tx.First(&recordModelTemplate, "urn = ?", targetURN).Error; err != nil { + return err + } + result := tx.Model(&recordModelTemplate).Updates(&templateToUpdateWith) + if result.Error != nil { + return result.Error + } + return nil +} + +func (r *TemplateRepository) updateModelFieldsToDB(tx *gorm.DB, templateURN string, fields []Field) error { + for _, field := range fields { + field.TemplateURN = templateURN + if field.ID == 0 { + createResult := tx.Create(&field) + if createResult.Error != nil { + return createResult.Error + } + } + var recordModelFieldByID Field + queryResult := tx.Where("id = ? and template_urn = ?", field.ID, field.TemplateURN). + First(&recordModelFieldByID) + if err := queryResult.Error; err != nil { + return err + } + recordModelFieldByID.URN = field.URN + recordModelFieldByID.DisplayName = field.DisplayName + recordModelFieldByID.Description = field.Description + recordModelFieldByID.DataType = field.DataType + recordModelFieldByID.Options = field.Options + recordModelFieldByID.Required = field.Required + if err := tx.Model(&recordModelFieldByID).Updates(&recordModelFieldByID).Error; err != nil { + return err + } + } + return nil +} + +func (r *TemplateRepository) updateDomainTemplate(target *tag.Template, source Template) { + target.URN = source.URN + target.DisplayName = source.DisplayName + target.Description = source.Description + target.CreatedAt = source.CreatedAt + target.UpdatedAt = source.UpdatedAt + target.Fields = r.toDomainField(source.Fields) +} + +func (r *TemplateRepository) toDomainTemplate(modelTemplate Template) tag.Template { + return tag.Template{ + URN: modelTemplate.URN, + DisplayName: modelTemplate.DisplayName, + Description: modelTemplate.Description, + Fields: r.toDomainField(modelTemplate.Fields), + CreatedAt: modelTemplate.CreatedAt, + UpdatedAt: modelTemplate.UpdatedAt, + } +} + +func (r *TemplateRepository) toDomainField(listOfModelField []Field) []tag.Field { + output := make([]tag.Field, len(listOfModelField)) + for i, field := range listOfModelField { + var options []string + if field.Options != nil { + options = strings.Split(*field.Options, fieldOptionSeparator) + } + output[i] = tag.Field{ + ID: field.ID, + URN: field.URN, + DisplayName: field.DisplayName, + Description: field.Description, + DataType: field.DataType, + Options: options, + Required: field.Required, + CreatedAt: field.CreatedAt, + UpdatedAt: field.UpdatedAt, + } + } + return output +} + +func (r *TemplateRepository) toModelTemplate(domainTemplate tag.Template) Template { + return Template{ + URN: domainTemplate.URN, + DisplayName: domainTemplate.DisplayName, + Description: domainTemplate.Description, + Fields: r.toModelField(domainTemplate.Fields), + } +} + +func (r *TemplateRepository) toModelField(listOfDomainField []tag.Field) []Field { + var output []Field + for _, field := range listOfDomainField { + var options *string + if len(field.Options) > 0 { + joinedOptions := strings.Join(field.Options, fieldOptionSeparator) + options = &joinedOptions + } + output = append(output, Field{ + ID: field.ID, + URN: field.URN, + DisplayName: field.DisplayName, + Description: field.Description, + DataType: field.DataType, + Options: options, + Required: field.Required, + }) + } + return output +} + +// NewTemplateRepository initializes template repository clients +func NewTemplateRepository(dbClient *gorm.DB) *TemplateRepository { + if dbClient == nil { + panic(errNilDBClient.Error()) + } + return &TemplateRepository{ + dbClient: dbClient, + } +} diff --git a/store/postgres/template_repository_test.go b/store/postgres/template_repository_test.go new file mode 100644 index 00000000..be6e8275 --- /dev/null +++ b/store/postgres/template_repository_test.go @@ -0,0 +1,337 @@ +package postgres_test + +import ( + "testing" + "time" + + "github.com/odpf/columbus/store/postgres" + "github.com/odpf/columbus/tag" + + "github.com/stretchr/testify/suite" + "gorm.io/gorm" +) + +type TemplateRepositoryTestSuite struct { + suite.Suite + dbClient *gorm.DB + repository *postgres.TemplateRepository +} + +func (r *TemplateRepositoryTestSuite) Setup() { + r.dbClient, _ = newTestClient("file::memory:") + r.dbClient.AutoMigrate(&postgres.Template{}) + r.dbClient.AutoMigrate(&postgres.Field{}) + r.dbClient.AutoMigrate(&postgres.Tag{}) + repository := postgres.NewTemplateRepository(r.dbClient) + r.repository = repository +} + +func (r *TemplateRepositoryTestSuite) TestNewRepository() { + r.Run("should return repository and nil if db client is not nil", func() { + dbClient := &gorm.DB{} + + actualRepository := postgres.NewTemplateRepository(dbClient) + r.NotNil(actualRepository) + }) +} + +func (r *TemplateRepositoryTestSuite) TestCreate() { + r.Run("should return error if domain template is nil", func() { + r.Setup() + var domainTemplate *tag.Template = nil + + expectedErrorMsg := "domain template is nil" + + actualError := r.repository.Create(domainTemplate) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if db client is nil", func() { + domainTemplate := tag.Template{ + URN: "governance_policy", + } + repository := &postgres.TemplateRepository{} + + expectedErrorMsg := "db client is nil" + + actualError := repository.Create(&domainTemplate) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return nil and insert new record if no error found", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + + actualError := r.repository.Create(&domainTemplate) + var actualRecord postgres.Template + result := r.dbClient.Preload("Fields").First(&actualRecord) + + r.NoError(actualError) + r.NotZero(result.RowsAffected) + r.Equal(domainTemplate.URN, actualRecord.URN) + r.Equal(domainTemplate.DisplayName, actualRecord.DisplayName) + r.Equal(domainTemplate.Description, actualRecord.Description) + r.Equal(len(domainTemplate.Fields), len(actualRecord.Fields)) + r.Equal(domainTemplate.Fields[0].DisplayName, actualRecord.Fields[0].DisplayName) + r.Equal(domainTemplate.Fields[0].URN, actualRecord.Fields[0].URN) + }) + + r.Run("should return nil and update domain template", func() { + r.Setup() + originalDomainTemplate := r.getDomainTemplate() + referenceDomainTemplate := r.getDomainTemplate() + + actualError := r.repository.Create(&originalDomainTemplate) + var actualRecord postgres.Template + r.dbClient.Preload("Fields").First(&actualRecord) + + r.NoError(actualError) + r.Equal(referenceDomainTemplate.URN, originalDomainTemplate.URN) + r.NotEqual(referenceDomainTemplate.CreatedAt, originalDomainTemplate.CreatedAt) + r.NotEqual(referenceDomainTemplate.UpdatedAt, originalDomainTemplate.UpdatedAt) + r.Equal(referenceDomainTemplate.Fields[0].ID, originalDomainTemplate.Fields[0].ID) + r.Equal(referenceDomainTemplate.Fields[0].URN, originalDomainTemplate.Fields[0].URN) + r.NotEqual(referenceDomainTemplate.Fields[0].CreatedAt, originalDomainTemplate.Fields[0].CreatedAt) + r.NotEqual(referenceDomainTemplate.Fields[0].UpdatedAt, originalDomainTemplate.Fields[0].UpdatedAt) + }) + + r.Run("should return error if encountered uncovered error", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + + r.repository.Create(&domainTemplate) + actualError := r.repository.Create(&domainTemplate) + + r.Error(actualError) + }) +} + +func (r *TemplateRepositoryTestSuite) TestRead() { + r.Run("should return nil and error if db client is nil", func() { + domainTemplate := r.getDomainTemplate() + repository := &postgres.TemplateRepository{} + + expectedErrorMsg := "db client is nil" + + actualTemplate, actualError := repository.Read(domainTemplate) + + r.Nil(actualTemplate) + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return empty and nil if no record found", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + + actualTemplate, actualError := r.repository.Read(domainTemplate) + + r.Empty(actualTemplate) + r.NoError(actualError) + }) + + r.Run("should return domain templates and nil if found any", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + if err := r.repository.Create(&domainTemplate); err != nil { + panic(err) + } + now := time.Now() + + expectedTemplate := []tag.Template{domainTemplate} + r.updateTimeForDomainTemplate(&expectedTemplate[0], now) + + actualTemplate, actualError := r.repository.Read(domainTemplate) + r.updateTimeForDomainTemplate(&actualTemplate[0], now) + + r.EqualValues(expectedTemplate, actualTemplate) + r.NoError(actualError) + }) +} + +func (r *TemplateRepositoryTestSuite) TestUpdate() { + r.Run("should return error if domain template is nil", func() { + r.Setup() + var domainTemplate *tag.Template = nil + + expectedErrorMsg := "domain template is nil" + + actualError := r.repository.Update(domainTemplate) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if db client is nil", func() { + domainTemplate := r.getDomainTemplate() + repository := &postgres.TemplateRepository{} + + expectedErrorMsg := "db client is nil" + + actualError := repository.Update(&domainTemplate) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if record not found", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + + actualError := r.repository.Update(&domainTemplate) + + r.Error(actualError) + }) + + r.Run("should return nil and updated domain template if update is success", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + err := r.repository.Create(&domainTemplate) + r.NoError(err) + + domainTemplate.DisplayName = "Random Display" + domainTemplate.Fields[0].DisplayName = "Another Random Display" + domainTemplate.Fields = append(domainTemplate.Fields, tag.Field{ + URN: "new_field", + DisplayName: "New Field", + Description: "This field is a new addition.", + DataType: "string", + }) + + actualError := r.repository.Update(&domainTemplate) + r.NoError(actualError) + + var recordModelTemplate postgres.Template + if err := r.dbClient.Preload("Fields").First(&recordModelTemplate).Error; err != nil { + panic(err) + } + r.Equal(domainTemplate.DisplayName, recordModelTemplate.DisplayName) + r.Equal(domainTemplate.Fields[0].DisplayName, recordModelTemplate.Fields[0].DisplayName) + r.Equal(domainTemplate.UpdatedAt, recordModelTemplate.UpdatedAt) + r.Equal(domainTemplate.Fields[0].UpdatedAt, recordModelTemplate.Fields[0].UpdatedAt) + }) + + r.Run("should return error if trying to update with duplicate template", func() { + r.Setup() + domainTemplate1 := r.getDomainTemplate() + domainTemplate1.URN = "hello1" + if err := r.repository.Create(&domainTemplate1); err != nil { + panic(err) + } + domainTemplate2 := r.getDomainTemplate() + domainTemplate2.URN = "hello2" + if err := r.repository.Create(&domainTemplate2); err != nil { + panic(err) + } + domainTemplate2.URN = "hello1" + + actualError := r.repository.Update(&domainTemplate2) + + r.Error(actualError) + }) + + r.Run("should return error if trying to update with unrelated field", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + if err := r.repository.Create(&domainTemplate); err != nil { + panic(err) + } + domainTemplate.Fields[0].ID = 2 + + actualError := r.repository.Update(&domainTemplate) + + r.Error(actualError) + }) + + r.Run("should return error if trying to update with duplicate field", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + domainTemplate.Fields = append(domainTemplate.Fields, tag.Field{ + URN: "second_field", + DisplayName: "Second Field", + Description: "Random description for the second field.", + DataType: "string", + Required: false, + }) + if err := r.repository.Create(&domainTemplate); err != nil { + panic(err) + } + domainTemplate.Fields[1].URN = domainTemplate.Fields[0].URN + + actualError := r.repository.Update(&domainTemplate) + + r.Error(actualError) + }) +} + +func (r *TemplateRepositoryTestSuite) TestDelete() { + r.Run("should return error if db client is nil", func() { + domainTemplate := r.getDomainTemplate() + repository := &postgres.TemplateRepository{} + + expectedErrorMsg := "db client is nil" + + actualError := repository.Delete(domainTemplate) + + r.EqualError(actualError, expectedErrorMsg) + }) + + r.Run("should return error if record not found", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + + err := r.repository.Delete(domainTemplate) + + r.Error(err) + r.ErrorAs(err, new(tag.TemplateNotFoundError)) + }) + + r.Run("should return nil if record is deleted", func() { + r.Setup() + domainTemplate := r.getDomainTemplate() + if err := r.repository.Create(&domainTemplate); err != nil { + panic(err) + } + + actualError := r.repository.Delete(domainTemplate) + var actualModelTemplate postgres.Template + templateResult := r.dbClient.First(&actualModelTemplate) + var actualModelField postgres.Field + fieldResult := r.dbClient.First(&actualModelField) + + r.NoError(actualError) + r.Zero(templateResult.RowsAffected) + r.Zero(fieldResult.RowsAffected) + }) +} + +func (r *TemplateRepositoryTestSuite) getDomainTemplate() tag.Template { + return tag.Template{ + URN: "governance_policy", + DisplayName: "Governance Policy", + Description: "Template that is mandatory to be used.", + Fields: []tag.Field{ + { + ID: 1, + URN: "team_owner", + DisplayName: "Team Owner", + Description: "Owner of the resource.", + DataType: "enumerated", + Required: true, + Options: []string{"PIC", "Escalated"}, + }, + }, + } +} + +func (r *TemplateRepositoryTestSuite) updateTimeForDomainTemplate(domainTemplate *tag.Template, t time.Time) { + domainTemplate.CreatedAt = t + domainTemplate.UpdatedAt = t + for i := 0; i < len(domainTemplate.Fields); i++ { + domainTemplate.Fields[i].CreatedAt = t + domainTemplate.Fields[i].UpdatedAt = t + } +} + +func TestTemplateRepository(t *testing.T) { + suite.Run(t, &TemplateRepositoryTestSuite{}) +} diff --git a/store/postgres/util_test.go b/store/postgres/util_test.go new file mode 100644 index 00000000..40d53e41 --- /dev/null +++ b/store/postgres/util_test.go @@ -0,0 +1,11 @@ +package postgres_test + +import ( + "gorm.io/driver/sqlite" + "gorm.io/gorm" +) + +// newTestClient initializes database connection +func newTestClient(dsn string) (*gorm.DB, error) { + return gorm.Open(sqlite.Open(dsn), &gorm.Config{}) +} diff --git a/swagger.yaml b/swagger.yaml index b5adacc4..21635b2f 100644 --- a/swagger.yaml +++ b/swagger.yaml @@ -1,118 +1,15 @@ swagger: '2.0' info: - title: "Universal Search" - description: "Universal Search API" + title: "Data Discovery and Lineage Service" + description: "Data Discovery and Lineage Service" version: 0.1.0 -host: localhost:3000 -basePath: "/v1" -schemes: - - "http" -definitions: - Classifications: &CLASSIFICATIONS - type: string - description: "defines the 'class' of the resource" - enum: - - resource - - dataset - - schema - Record: - type: object - properties: - name: - type: string - urn: - type: string - team: - type: string - environment: - type: string - Status: - type: object - properties: - status: - type: string - default: success - AdjacencyEntry: - type: object - properties: - urn: - type: string - type: - type: string - downstreams: - type: array - items: - type: string - upstreams: - type: array - items: - type: string - AdjacencyMap: - type: object - properties: - "": - $ref: '#/definitions/AdjacencyEntry' - Type: - type: object - properties: - name: - type: string - description: name of the type (for e.g. dagger, firehose) - classification: - <<: *CLASSIFICATIONS - record_attributes: - type: object - description: defines metadata for the documents that belong to this type. All properties under record_attributes define(s) a mapping of logical purpose, to the name of the key(s) in the documents that hold those information - properties: - id: - type: string - title: - type: string - description: - type: string - labels: - type: array - items: - type: string - Error: - type: object - properties: - reason: - type: string - description: "error message" - SearchResult: - type: object - properties: - id: - type: string - description: "URN of the resource" - title: - type: string - description: "describes the resource in a human readable form" - type: - type: string - description: "the individual type of the resource. For example: dagger, firehose" - description: - type: string - description: "optional description of the record" - classification: - <<: *CLASSIFICATIONS - labels: - type: object - description: "key value pairs describing the labels configured for the given type of resource. Example of labels: team, created, owner etc" - ValidationError: - allOf: - - $ref: '#/definitions/Error' - - type: object - properties: - details: - type: object - description: error details. the keys are integer indices for the records that failed validation, and the value is a string describing the reason why that record fails validation paths: - "/lineage": + "/v1/lineage": get: + tags: + - Lineage summary: lineage list api - description: "Returns the lineage graph, optionally filtered by type. Each entry in the graph describes a resource using it's urn and type, and has `downstreams` and `upstreams` fields that declare related resources. By default, the returned graph will only show immediate and directly related resources. For instance, say that according to the lineage configuration, there exist 3 resources R1, R2 and R3 where data flows from R1 -> R2 -> R3. If the graph is requested with the filter for R1 and R3 , the returned Graph will have a Node R1 that references a downstream R2, but since it was filtered out, it won't be available in the graph. Similarly, R3 will declare a phamtom upstream R2. This can be addressed via the `collapse` feature. If we make the same request with collapse set to true, R1 will declare R3 as its downstream (using trasitive property) and R3 will also have a corresponding upstream declaration of R1." + description: "Returns the lineage graph, optionally filtered by type. Each entry in the graph describes a record using it's urn and type, and has `downstreams` and `upstreams` fields that declare related records. By default, the returned graph will only show immediate and directly related records. For instance, say that according to the lineage configuration, there exist 3 records R1, R2 and R3 where data flows from R1 -> R2 -> R3. If the graph is requested with the filter for R1 and R3 , the returned Graph will have a Node R1 that references a downstream R2, but since it was filtered out, it won't be available in the graph. Similarly, R3 will declare a phamtom upstream R2. This can be addressed via the `collapse` feature. If we make the same request with collapse set to true, R1 will declare R3 as its downstream (using trasitive property) and R3 will also have a corresponding upstream declaration of R1." produces: - "application/json" parameters: @@ -128,13 +25,15 @@ paths: schema: $ref: '#/definitions/AdjacencyMap' 404: - description: resource not found + description: record not found schema: $ref: '#/definitions/Error' - "/lineage/{type}/{resource}": + "/v1/lineage/{type}/{record}": get: + tags: + - Lineage summary: lineage get api - description: "Returns lineage graph of a single resource. For BQTable to BQTable lineage, set collapse to true" + description: "Returns lineage graph of a single record. For BQTable to BQTable lineage, set collapse to true" produces: - "application/json" parameters: @@ -150,8 +49,10 @@ paths: description: invalid type requested schema: $ref: '#/definitions/Error' - "/types": + "/v1/types": get: + tags: + - Type summary: fetch all types description: used to fetch all types produces: @@ -164,8 +65,10 @@ paths: items: $ref: '#/definitions/Type' put: - summary: initialise a type - description: used for initialising/update a type. A type in columbus's nomenclature is a "collection" of documents that belong to a single named type. Type holds metadata about this collection, used when serving search requests + tags: + - Type + summary: upsert a type + description: used for upserting a type. A type in columbus's nomenclature is a "collection" of documents that belong to a single named type. Type holds metadata about this collection, used when serving search requests produces: - "application/json" parameters: @@ -182,8 +85,10 @@ paths: description: invalid type schema: $ref: '#/definitions/Error' - "/types/{name}": + "/v1/types/{name}": put: + tags: + - Record summary: upload documents for a given type. description: Use this API for adding records for a certain type. The document can have any number of fields, however; it must atleast have fields specified by 'title' and 'id' properties on type.record_attributes. The value of these properties must be string and they must be located at the object root. produces: @@ -209,6 +114,8 @@ paths: schema: $ref: '#/definitions/ValidationError' delete: + tags: + - Type summary: delete a type by its name. description: Use this API to delete a type along with all of its records. This is an idempotent operation. produces: @@ -228,8 +135,10 @@ paths: description: reserved type name error schema: $ref: '#/definitions/Error' - "/types/{name}/details": + "/v1/types/{name}/details": get: + tags: + - Type summary: fetch a type details description: used to fetch type details by its name produces: @@ -243,9 +152,11 @@ paths: description: type not found schema: $ref: '#/definitions/Error' - "/types/{name}/records": + "/v1/types/{name}/records": get: - summary: list documents for the type + tags: + - Record + summary: list records for the type produces: - "application/json" parameters: @@ -276,8 +187,10 @@ paths: description: not found schema: $ref: '#/definitions/Error' - "/types/{name}/records/{id}": + "/v1/types/{name}/records/{id}": delete: + tags: + - Record summary: delete a record in a type by its record ID produces: - "application/json" @@ -300,8 +213,10 @@ paths: description: type or record cannot be found schema: $ref: '#/definitions/Error' - "/types/{name}/{id}": + "/v1/types/{name}/{id}": get: + tags: + - Record summary: get a record by id parameters: - in: path @@ -323,9 +238,11 @@ paths: description: document or type does not exist schema: $ref: '#/definitions/Error' - "/search": + "/v1/search": get: - summary: search for resources + tags: + - Search + summary: search for records description: "API for querying documents. 'text' is fuzzy matched against all the available datasets, and matched results are returned. You can specify additional match criteria using 'filter.*' query parameters. You can specify each filter multiple times to specify a set of values for those filters. For instance, to specify two landscape 'vn' and 'th', the query could be `/search/?text=&filter.environment=integration&filter.landscape=vn&filter.landscape=th`" produces: - "application/json" @@ -366,3 +283,547 @@ paths: description: misconfigured request parameters schema: $ref: "#/definitions/Error" + "/v1/tags": + post: + tags: + - Tag + summary: Tag a record + description: Tag a record in a type with a tag template + produces: + - "application/json" + parameters: + - in: body + name: "" + required: true + schema: + allOf: + - $ref: "#/definitions/Tag" + - required: + - record_type + - record_urn + - template_urn + - tag_values + responses: + 201: + description: OK + schema: + $ref: '#/definitions/Tag' + 400: + description: validation error + schema: + $ref: '#/definitions/ValidationError' + 409: + description: duplicate tags + schema: + $ref: '#/definitions/Error' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' + "/v1/tags/templates": + get: + tags: + - Tag + summary: Get all tag templates + description: Get all available tag templates + produces: + - "application/json" + responses: + 200: + description: OK + schema: + type: array + items: + $ref: '#/definitions/TagTemplate' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' + post: + tags: + - Tag + summary: Create a template + description: Create a new tag template + produces: + - "application/json" + parameters: + - in: body + name: "" + schema: + allOf: + - $ref: "#/definitions/TagTemplate" + - required: + - urn + - display_name + - description + - fields + responses: + 201: + description: Created + schema: + $ref: '#/definitions/TagTemplate' + 400: + description: validation error + schema: + $ref: '#/definitions/ValidationError' + 409: + description: duplicate template + schema: + $ref: '#/definitions/Error' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' + "/v1/tags/templates/{template_urn}": + get: + tags: + - Tag + summary: Get a tag templates + description: Get a single tag templates + produces: + - "application/json" + parameters: + - in: path + name: template_urn + type: string + required: true + responses: + 200: + description: OK + schema: + $ref: '#/definitions/TagTemplate' + 404: + description: template not found + schema: + $ref: '#/definitions/Error' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' + put: + tags: + - Tag + summary: Update a template + description: Update an existing tag template + produces: + - "application/json" + parameters: + - in: path + name: template_urn + type: string + required: true + - in: body + name: "" + schema: + allOf: + - $ref: "#/definitions/TagTemplate" + - required: + - display_name + - description + - fields + responses: + 200: + description: OK + schema: + $ref: '#/definitions/TagTemplate' + 400: + description: validation error + schema: + $ref: '#/definitions/ValidationError' + 404: + description: template not found + schema: + $ref: '#/definitions/Error' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' + delete: + tags: + - Tag + summary: Delete a tag templates + description: Delete a single tag templates + produces: + - "application/json" + parameters: + - in: path + name: template_urn + type: string + required: true + responses: + 204: + description: Deleted + schema: + type: string + example: "Deleted" + 404: + description: template not found + schema: + $ref: '#/definitions/Error' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' + "/v1/tags/types/{type}/records/{record_urn}": + get: + tags: + - Tag + summary: Get a record's tags + description: Get all tags for a record in a type + produces: + - "application/json" + parameters: + - in: path + name: type + type: string + required: true + - in: path + name: record_urn + type: string + required: true + responses: + 200: + description: OK + schema: + type: array + items: + $ref: '#/definitions/Tag' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' + "/v1/tags/types/{type}/records/{record_urn}/templates/{template_urn}": + get: + tags: + - Tag + summary: Find a tag by record and template + description: Find a single tag using record urn and template urn + produces: + - "application/json" + parameters: + - in: path + name: type + type: string + required: true + - in: path + name: record_urn + type: string + required: true + - in: path + name: template_urn + type: string + required: true + responses: + 200: + description: OK + schema: + $ref: '#/definitions/Tag' + 404: + description: record is not found + schema: + $ref: '#/definitions/Error' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' + put: + tags: + - Tag + summary: Update a tag on a record + description: Update a tag on a record in a type + produces: + - "application/json" + parameters: + - in: path + name: type + type: string + required: true + - in: path + name: record_urn + type: string + required: true + - in: path + name: template_urn + type: string + required: true + - in: body + name: "" + required: true + schema: + allOf: + - $ref: "#/definitions/Tag" + - required: + - tag_values + responses: + 201: + description: OK + schema: + $ref: '#/definitions/Tag' + 400: + description: validation error + schema: + $ref: '#/definitions/ValidationError' + 404: + description: tag is not found + schema: + $ref: '#/definitions/Error' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' + delete: + tags: + - Tag + summary: Remove a tag on a record + description: Remove a tag on a record in a type + produces: + - "application/json" + parameters: + - in: path + name: type + type: string + required: true + - in: path + name: record_urn + type: string + required: true + - in: path + name: template_urn + type: number + required: true + responses: + 204: + description: Removed + 400: + description: template_urn is required + schema: + $ref: '#/definitions/ValidationError' + 404: + description: record is not found + schema: + $ref: '#/definitions/Error' + 500: + description: internal server error + schema: + $ref: '#/definitions/Error' +definitions: + Classifications: &CLASSIFICATIONS + type: string + description: "defines the 'class' of the record" + enum: + - record + - dataset + - schema + Record: + type: object + properties: + urn: + type: string + example: "sample-urn" + name: + type: string + example: "sample-name" + service: + type: string + example: "bigquery" + description: + type: string + example: "sample description" + data: + type: object + description: "dynamic object" + labels: + type: object + description: "map of string" + upstreams: + $ref: '#/definitions/LineageRecord' + downstreams: + $ref: '#/definitions/LineageRecord' + created_at: + type: string + updated_at: + type: string + Tag: + type: object + properties: + record_type: + type: string + record_urn: + type: string + template_urn: + type: string + tag_values: + type: array + items: + type: object + required: + - field_id + - field_value + properties: + field_id: + type: number + field_value: + type: object + field_urn: + type: string + field_display_name: + type: string + field_description: + type: string + field_data_type: + type: string + field_options: + type: array + items: + type: string + field_required: + type: boolean + created_at: + type: string + updated_at: + type: string + template_display_name: + type: string + template_description: + type: string + TagTemplate: + type: object + properties: + urn: + type: string + display_name: + type: string + description: + type: string + fields: + type: array + items: + type: object + required: + - urn + - display_name + - description + - data_type + properties: + id: + type: number + urn: + type: string + display_name: + type: string + description: + type: string + data_type: + type: string + enum: + - string + - double + - boolean + - enumerated + - datetime + options: + type: array + items: + type: string + required: + type: boolean + created_at: + type: string + updated_at: + type: string + created_at: + type: string + updated_at: + type: string + Status: + type: object + properties: + status: + type: string + default: success + LineageRecord: + type: object + properties: + urn: + type: string + example: "sample-urn" + type: + type: string + description: "Columbus registered type" + example: "table" + AdjacencyEntry: + type: object + properties: + urn: + type: string + type: + type: string + downstreams: + type: array + items: + type: string + upstreams: + type: array + items: + type: string + AdjacencyMap: + type: object + properties: + "": + $ref: '#/definitions/AdjacencyEntry' + Type: + type: object + properties: + name: + type: string + description: name of the type (for e.g. dagger, firehose) + classification: + <<: *CLASSIFICATIONS + record_attributes: + type: object + description: defines metadata for the documents that belong to this type. All properties under record_attributes define(s) a mapping of logical purpose, to the name of the key(s) in the documents that hold those information + properties: + id: + type: string + title: + type: string + description: + type: string + labels: + type: array + items: + type: string + Error: + type: object + properties: + reason: + type: string + description: "error message" + SearchResult: + type: object + properties: + id: + type: string + description: "URN of the record" + title: + type: string + description: "describes the record in a human readable form" + type: + type: string + description: "the individual type of the record. For example: dagger, firehose" + description: + type: string + description: "optional description of the record" + classification: + <<: *CLASSIFICATIONS + labels: + type: object + description: "key value pairs describing the labels configured for the given type of record. Example of labels: team, created, owner etc" + ValidationError: + allOf: + - $ref: '#/definitions/Error' + - type: object + properties: + details: + type: object + description: error details. the keys are integer indices for the records that failed validation, and the value is a string describing the reason why that record fails validation diff --git a/tag/errors.go b/tag/errors.go new file mode 100644 index 00000000..3da70c98 --- /dev/null +++ b/tag/errors.go @@ -0,0 +1,54 @@ +package tag + +import ( + "fmt" +) + +type NotFoundError struct { + URN string + Type string + Template string +} + +func (e NotFoundError) Error() string { + return fmt.Sprintf( + "could not find tag with record type: \"%s\", record: \"%s\", template: \"%s\"", + e.Type, + e.URN, + e.Template, + ) +} + +type TemplateNotFoundError struct { + URN string +} + +func (e TemplateNotFoundError) Error() string { + return fmt.Sprintf("could not find template \"%s\"", e.URN) +} + +type DuplicateError struct { + RecordURN string + RecordType string + TemplateURN string +} + +func (e DuplicateError) Error() string { + return fmt.Sprintf("tag of record URN \"%s\" with type \"%s\" and template URN \"%s\" already exists", e.RecordURN, e.RecordType, e.TemplateURN) +} + +type DuplicateTemplateError struct { + URN string +} + +func (e DuplicateTemplateError) Error() string { + return fmt.Sprintf("template \"%s\" already exists", e.URN) +} + +type ValidationError struct { + Err error +} + +func (e ValidationError) Error() string { + return e.Err.Error() +} diff --git a/tag/mocks/TagRepository.go b/tag/mocks/TagRepository.go new file mode 100644 index 00000000..62cba5a0 --- /dev/null +++ b/tag/mocks/TagRepository.go @@ -0,0 +1,78 @@ +// Code generated by mockery v1.0.0. DO NOT EDIT. + +package mocks + +import ( + tag "github.com/odpf/columbus/tag" + mock "github.com/stretchr/testify/mock" +) + +// TagRepository is an autogenerated mock type for the TagRepository type +type TagRepository struct { + mock.Mock +} + +// Create provides a mock function with given fields: tag +func (_m *TagRepository) Create(t *tag.Tag) error { + ret := _m.Called(t) + + var r0 error + if rf, ok := ret.Get(0).(func(*tag.Tag) error); ok { + r0 = rf(t) + } else { + r0 = ret.Error(0) + } + + return r0 +} + +// Delete provides a mock function with given fields: filter +func (_m *TagRepository) Delete(filter tag.Tag) error { + ret := _m.Called(filter) + + var r0 error + if rf, ok := ret.Get(0).(func(tag.Tag) error); ok { + r0 = rf(filter) + } else { + r0 = ret.Error(0) + } + + return r0 +} + +// Read provides a mock function with given fields: filter +func (_m *TagRepository) Read(filter tag.Tag) ([]tag.Tag, error) { + ret := _m.Called(filter) + + var r0 []tag.Tag + if rf, ok := ret.Get(0).(func(tag.Tag) []tag.Tag); ok { + r0 = rf(filter) + } else { + if ret.Get(0) != nil { + r0 = ret.Get(0).([]tag.Tag) + } + } + + var r1 error + if rf, ok := ret.Get(1).(func(tag.Tag) error); ok { + r1 = rf(filter) + } else { + r1 = ret.Error(1) + } + + return r0, r1 +} + +// Update provides a mock function with given fields: tag +func (_m *TagRepository) Update(t *tag.Tag) error { + ret := _m.Called(t) + + var r0 error + if rf, ok := ret.Get(0).(func(*tag.Tag) error); ok { + r0 = rf(t) + } else { + r0 = ret.Error(0) + } + + return r0 +} diff --git a/tag/mocks/TemplateRepository.go b/tag/mocks/TemplateRepository.go new file mode 100644 index 00000000..4a752e26 --- /dev/null +++ b/tag/mocks/TemplateRepository.go @@ -0,0 +1,78 @@ +// Code generated by mockery v1.0.0. DO NOT EDIT. + +package mocks + +import ( + tag "github.com/odpf/columbus/tag" + mock "github.com/stretchr/testify/mock" +) + +// TemplateRepository is an autogenerated mock type for the TemplateRepository type +type TemplateRepository struct { + mock.Mock +} + +// Create provides a mock function with given fields: template +func (_m *TemplateRepository) Create(template *tag.Template) error { + ret := _m.Called(template) + + var r0 error + if rf, ok := ret.Get(0).(func(*tag.Template) error); ok { + r0 = rf(template) + } else { + r0 = ret.Error(0) + } + + return r0 +} + +// Delete provides a mock function with given fields: filter +func (_m *TemplateRepository) Delete(filter tag.Template) error { + ret := _m.Called(filter) + + var r0 error + if rf, ok := ret.Get(0).(func(tag.Template) error); ok { + r0 = rf(filter) + } else { + r0 = ret.Error(0) + } + + return r0 +} + +// Read provides a mock function with given fields: filter +func (_m *TemplateRepository) Read(filter tag.Template) ([]tag.Template, error) { + ret := _m.Called(filter) + + var r0 []tag.Template + if rf, ok := ret.Get(0).(func(tag.Template) []tag.Template); ok { + r0 = rf(filter) + } else { + if ret.Get(0) != nil { + r0 = ret.Get(0).([]tag.Template) + } + } + + var r1 error + if rf, ok := ret.Get(1).(func(tag.Template) error); ok { + r1 = rf(filter) + } else { + r1 = ret.Error(1) + } + + return r0, r1 +} + +// Update provides a mock function with given fields: template +func (_m *TemplateRepository) Update(template *tag.Template) error { + ret := _m.Called(template) + + var r0 error + if rf, ok := ret.Get(0).(func(*tag.Template) error); ok { + r0 = rf(template) + } else { + r0 = ret.Error(0) + } + + return r0 +} diff --git a/tag/service.go b/tag/service.go new file mode 100644 index 00000000..a0fbd70b --- /dev/null +++ b/tag/service.go @@ -0,0 +1,192 @@ +package tag + +import ( + "fmt" + + "github.com/odpf/columbus/tag/validator" + "github.com/pkg/errors" +) + +// Service is a type that manages business process +type Service struct { + validator validator.Validator + repository TagRepository + templateService *TemplateService +} + +// Validate validates domain tag based on business requirement +func (s *Service) Validate(tag *Tag) error { + if tag == nil { + return errors.New("tag is nil") + } + + err := s.validator.Validate(*tag) + if err != nil { + err = ValidationError{err} + } + + return err +} + +// Create handles business process for create +func (s *Service) Create(tag *Tag) error { + if err := s.Validate(tag); err != nil { + return err + } + template, err := s.templateService.Find(tag.TemplateURN) + if err != nil { + return errors.Wrap(err, "error finding template") + } + if err := s.validateFieldIsMemberOfTemplate(*tag, template); err != nil { + return err + } + if err := s.validateRequiredFieldIsPassed(*tag, template); err != nil { + return err + } + if err := s.validateFieldValueIsValid(*tag, template); err != nil { + return err + } + if err := s.repository.Create(tag); err != nil { + return err + } + + return nil +} + +// GetByRecord handles business process to get tags by its resource urn +func (s *Service) GetByRecord(recordType, recordURN string) ([]Tag, error) { + tag := Tag{RecordType: recordType, RecordURN: recordURN} + return s.repository.Read(tag) +} + +// FindByRecordAndTemplate handles business process to get tags by its resource id and template id +func (s *Service) FindByRecordAndTemplate(recordType, recordURN, templateURN string) (Tag, error) { + _, err := s.templateService.Find(templateURN) + if err != nil { + return Tag{}, err + } + listOfTag, err := s.repository.Read(Tag{RecordType: recordType, RecordURN: recordURN, TemplateURN: templateURN}) + if err != nil { + return Tag{}, err + } + var output Tag + if len(listOfTag) == 0 { + return Tag{}, NotFoundError{Type: recordType, URN: recordURN, Template: templateURN} + } + + output = listOfTag[0] + return output, err +} + +// Delete handles business process to delete a tag +func (s *Service) Delete(recordType, recordURN, templateURN string) error { + _, err := s.templateService.Find(templateURN) + if err != nil { + return errors.Wrap(err, "error finding template") + } + if err := s.repository.Delete(Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: templateURN, + }); err != nil { + return errors.Wrap(err, "error deleting tag") + } + return nil +} + +// Update handles business process for update +func (s *Service) Update(tag *Tag) error { + if err := s.Validate(tag); err != nil { + return err + } + template, err := s.templateService.Find(tag.TemplateURN) + if err != nil { + return errors.Wrap(err, "error finding template") + } + existingTags, err := s.repository.Read(Tag{ + RecordType: tag.RecordType, + RecordURN: tag.RecordURN, + TemplateURN: tag.TemplateURN, + }) + if err != nil { + return errors.Wrap(err, "error finding existing tag") + } + if len(existingTags) == 0 { + return NotFoundError{URN: tag.RecordURN, Type: tag.RecordType, Template: tag.TemplateURN} + } + + if err = s.validateFieldIsMemberOfTemplate(*tag, template); err != nil { + return err + } + if err := s.validateFieldValueIsValid(*tag, template); err != nil { + return err + } + if err := s.repository.Update(tag); err != nil { + return errors.Wrap(err, "error updating tag") + } + return nil +} + +func (s *Service) validateFieldIsMemberOfTemplate(tag Tag, template Template) error { + fieldIsMemberOfTemplate := make(map[uint]bool) + for _, field := range template.Fields { + fieldIsMemberOfTemplate[field.ID] = true + } + for i, value := range tag.TagValues { + if !fieldIsMemberOfTemplate[value.FieldID] { + return buildFieldError( + fmt.Sprintf("fields[%d].id", i), + fmt.Sprintf("not part of template [%s]", + template.URN), + ) + } + } + return nil +} + +func (s *Service) validateRequiredFieldIsPassed(tag Tag, template Template) error { + passedFieldMap := make(map[uint]bool) + for _, value := range tag.TagValues { + if value.FieldValue != nil && value.FieldValue != "" { + passedFieldMap[value.FieldID] = true + } + } + for i, field := range template.Fields { + if field.Required && !passedFieldMap[field.ID] { + return buildFieldError( + fmt.Sprintf("fields[%d].id", i), fmt.Sprintf("required by template [%s]", template.URN), + ) + } + } + return nil +} + +func (s *Service) validateFieldValueIsValid(tag Tag, template Template) error { + domainFieldByID := make(map[uint]Field) + for _, field := range template.Fields { + domainFieldByID[field.ID] = field + } + for i, value := range tag.TagValues { + if value.FieldValue != nil && value.FieldValue != "" { + fieldValue := fmt.Sprintf("%v", value.FieldValue) + fieldID := value.FieldID + domainField := domainFieldByID[fieldID] + _, err := ParseTagValue(template.URN, domainField.ID, + domainField.DataType, fieldValue, domainField.Options, + ) + if err != nil { + return buildFieldError(fmt.Sprintf("fields[%d].value", i), err.Error()) + } + } + } + return nil +} + +// NewService initializes service tag +func NewService(repository TagRepository, templateService *TemplateService) *Service { + return &Service{ + validator: newValidator(), + repository: repository, + templateService: templateService, + } +} diff --git a/tag/service_test.go b/tag/service_test.go new file mode 100644 index 00000000..26f8c7ed --- /dev/null +++ b/tag/service_test.go @@ -0,0 +1,580 @@ +package tag_test + +import ( + "errors" + "fmt" + "testing" + + "github.com/odpf/columbus/tag" + "github.com/odpf/columbus/tag/mocks" + "github.com/odpf/columbus/tag/validator" + + "github.com/stretchr/testify/suite" +) + +type ServiceTestSuite struct { + suite.Suite + tagService *tag.Service + templateRepo *mocks.TemplateRepository + repository *mocks.TagRepository +} + +func (s *ServiceTestSuite) TestNewService() { + s.Run("should return service and nil if repository is not nil", func() { + repository := &mocks.TagRepository{} + templateService := tag.NewTemplateService(s.templateRepo) + actualService := tag.NewService(repository, templateService) + + s.NotNil(actualService) + }) +} + +func (s *ServiceTestSuite) Setup() { + s.repository = &mocks.TagRepository{} + s.templateRepo = &mocks.TemplateRepository{} + + templateService := tag.NewTemplateService(s.templateRepo) + s.tagService = tag.NewService(s.repository, templateService) +} + +func (s *ServiceTestSuite) TestValidate() { + repository := &mocks.TagRepository{} + templateService := tag.NewTemplateService(&mocks.TemplateRepository{}) + tagService := tag.NewService(repository, templateService) + + s.Run("should return error if record URN is empty", func() { + t := s.buildTag() + t.RecordURN = "" + + expectedErrorMsg := "error with [record_urn : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "record_urn": "cannot be empty", + }, + } + + actualError := tagService.Validate(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if record Type is empty", func() { + t := s.buildTag() + t.RecordType = "" + + expectedErrorMsg := "error with [record_type : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "record_type": "cannot be empty", + }, + } + + actualError := tagService.Validate(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if template URN is empty", func() { + t := s.buildTag() + t.TemplateURN = "" + + expectedErrorMsg := "error with [template_urn : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "template_urn": "cannot be empty", + }, + } + + actualError := tagService.Validate(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if tag values are nil", func() { + t := s.buildTag() + t.TemplateURN = "" + + expectedErrorMsg := "error with [template_urn : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "template_urn": "cannot be empty", + }, + } + + actualError := tagService.Validate(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if tag values contains zero element", func() { + t := s.buildTag() + t.TagValues = []tag.TagValue{} + + expectedErrorMsg := "error with [tag_values : must be at least 1]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "tag_values": "must be at least 1", + }, + } + + actualError := tagService.Validate(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if tag value field ID is zero", func() { + t := s.buildTag() + t.TagValues[1].FieldID = 0 + + expectedErrorMsg := "error with [tag_values[1].field_id : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "tag_values[1].field_id": "cannot be empty", + }, + } + + actualError := tagService.Validate(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if tag value field value is nil", func() { + t := s.buildTag() + t.TagValues[1].FieldValue = nil + + expectedErrorMsg := "error with [tag_values[1].field_value : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "tag_values[1].field_value": "cannot be empty", + }, + } + + actualError := tagService.Validate(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) +} + +func (s *ServiceTestSuite) TestCreate() { + s.Run("should return error if value validations return error", func() { + s.Setup() + t := s.buildTag() + t.RecordURN = "" + + expectedErrorMsg := "error with [record_urn : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "record_urn": "cannot be empty", + }, + } + + actualError := s.tagService.Create(&t) + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if error retrieving template", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return(nil, errors.New("random error")) + + err := s.tagService.Create(&t) + s.Error(err) + }) + + s.Run("should return error if specified field is not part of the template", func() { + s.Setup() + t := s.buildTag() + t.TagValues[0].FieldID = 5 + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + + expectedErrorMsg := "error with [fields[0].id : not part of template [governance_policy]]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[0].id": fmt.Sprintf("not part of template [%s]", t.TemplateURN), + }, + } + + actualError := s.tagService.Create(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if required field is not passed", func() { + s.Setup() + t := s.buildTag() + t.TagValues = t.TagValues[:1] + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + + expectedErrorMsg := "error with [fields[1].id : required by template [governance_policy]]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[1].id": fmt.Sprintf("required by template [%s]", t.TemplateURN), + }, + } + + actualError := s.tagService.Create(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + + }) + + s.Run("should return error if passed value is not parsable", func() { + t := s.buildTag() + t.TagValues[1].FieldValue = "hello" + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + + expectedErrorMsg := "error with [fields[1].value : template [governance_policy] on field [2] should be boolean]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[1].value": fmt.Sprintf("template [%s] on field [%d] should be boolean", t.TemplateURN, 2), + }, + } + + actualError := s.tagService.Create(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return repository error if repository met error", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Create", &t).Return(errors.New("random error")) + + err := s.tagService.Create(&t) + s.Error(err) + }) + + s.Run("should return repository nil if repository not error", func() { + s.Setup() + t := s.buildTag() + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Create", &t).Return(nil) + + actualError := s.tagService.Create(&t) + + s.NoError(actualError) + }) +} + +func (s *ServiceTestSuite) TestGetByRecord() { + s.Run("should return tags and error based on the repository", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + expectedTag := []tag.Tag{t} + + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + }).Return(expectedTag, nil) + + actualTag, actualError := s.tagService.GetByRecord(t.RecordType, t.RecordURN) + + s.EqualValues(expectedTag, actualTag) + s.NoError(actualError) + }) +} + +func (s *ServiceTestSuite) TestFindByRecordAndTemplate() { + s.Run("should return error if error retrieving template", func() { + s.Setup() + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return(nil, errors.New("random error")) + + _, err := s.tagService.FindByRecordAndTemplate("record-type", "record-urn", template.URN) + s.Error(err) + }) + + s.Run("should return nil and error if tag is not found", func() { + s.Setup() + var recordType string = "record-type" + var urn string = "record-urn" + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Read", tag.Tag{ + RecordType: recordType, + RecordURN: urn, + TemplateURN: template.URN, + }).Return([]tag.Tag{}, nil) + + _, err := s.tagService.FindByRecordAndTemplate(recordType, urn, template.URN) + s.ErrorIs(err, tag.NotFoundError{ + Type: recordType, + URN: urn, + Template: template.URN, + }) + }) + + s.Run("should return tag and nil if tag is found", func() { + s.Setup() + t := s.buildTag() + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + TemplateURN: t.TemplateURN, + }).Return([]tag.Tag{t}, nil) + + expectedTag := t + + actualTag, actualError := s.tagService.FindByRecordAndTemplate(t.RecordType, t.RecordURN, template.URN) + + s.EqualValues(expectedTag, actualTag) + s.NoError(actualError) + }) +} + +func (s *ServiceTestSuite) TestUpdate() { + s.Run("should return error if value validations return error", func() { + s.Setup() + t := s.buildTag() + t.RecordURN = "" + + expectedErrorMsg := "error with [record_urn : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "record_urn": "cannot be empty", + }, + } + actualError := s.tagService.Update(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if error retrieving template", func() { + s.Setup() + t := s.buildTag() + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return(nil, errors.New("random error")) + + err := s.tagService.Update(&t) + s.Error(err) + }) + + s.Run("should return not found error if tag could not be found", func() { + s.Setup() + t := s.buildTag() + template := s.buildTemplate() + + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + TemplateURN: t.TemplateURN, + }).Return([]tag.Tag{}, nil) + + err := s.tagService.Update(&t) + + s.Error(err) + s.ErrorIs(err, tag.NotFoundError{URN: t.RecordURN, Type: t.RecordType, Template: t.TemplateURN}) + }) + + s.Run("should return error if specified field is not part of the template", func() { + s.Setup() + t := s.buildTag() + t.TagValues[0].FieldID = 5 + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + TemplateURN: t.TemplateURN, + }).Return([]tag.Tag{t}, nil) + + expectedErrorMsg := "error with [fields[0].id : not part of template [governance_policy]]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[0].id": fmt.Sprintf("not part of template [%s]", t.TemplateURN), + }, + } + + actualError := s.tagService.Update(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if passed value is not parsable", func() { + t := s.buildTag() + t.TagValues[1].FieldValue = "hello" + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + TemplateURN: t.TemplateURN, + }).Return([]tag.Tag{t}, nil) + + expectedErrorMsg := "error with [fields[1].value : template [governance_policy] on field [2] should be boolean]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[1].value": fmt.Sprintf("template [%s] on field [%d] should be boolean", t.TemplateURN, 2), + }, + } + + actualError := s.tagService.Update(&t) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return repository error if repository met error", func() { + s.Setup() + t := s.buildTag() + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + TemplateURN: t.TemplateURN, + }).Return([]tag.Tag{t}, nil) + s.repository.On("Update", &t).Return(errors.New("random error")) + + err := s.tagService.Update(&t) + s.Error(err) + }) + + s.Run("should return repository nil if repository not error", func() { + s.Setup() + t := s.buildTag() + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Read", tag.Tag{ + RecordType: t.RecordType, + RecordURN: t.RecordURN, + TemplateURN: t.TemplateURN, + }).Return([]tag.Tag{t}, nil) + s.repository.On("Update", &t).Return(nil) + + actualError := s.tagService.Update(&t) + + s.NoError(actualError) + }) +} + +func (s *ServiceTestSuite) TestDelete() { + s.Run("should return error if error retrieving template", func() { + s.Setup() + + templateURN := "template-urn" + s.templateRepo.On("Read", s.templateQuery(templateURN)).Return(nil, errors.New("random error")) + + err := s.tagService.Delete("record-type", "record-urn", templateURN) + s.Error(err) + }) + + s.Run("should return error if repository error", func() { + s.Setup() + recordType := "sample-type" + recordURN := "sample-urn" + + template := s.buildTemplate() + s.templateRepo.On("Read", s.templateQuery(template.URN)).Return([]tag.Template{template}, nil) + s.repository.On("Delete", tag.Tag{ + RecordType: recordType, + RecordURN: recordURN, + TemplateURN: template.URN, + }).Return(errors.New("random error")) + + err := s.tagService.Delete(recordType, recordURN, template.URN) + s.Error(err) + }) +} + +func (s *ServiceTestSuite) buildTemplate() tag.Template { + return tag.Template{ + URN: "governance_policy", + DisplayName: "Governance Policy", + Description: "Template that is mandatory to be used.", + Fields: []tag.Field{ + { + ID: 1, + URN: "classification", + DisplayName: "classification", + Description: "The classification of this record", + DataType: "enumerated", + Required: true, + Options: []string{"Public", "Restricted"}, + }, + { + ID: 2, + URN: "is_encrypted", + DisplayName: "Is Encrypted?", + Description: "Specify whether this record is encrypted or not.", + DataType: "boolean", + Required: true, + }, + }, + } +} + +func (s *ServiceTestSuite) buildTag() tag.Tag { + return tag.Tag{ + RecordURN: "record-urn", + RecordType: "sample-record-type", + TemplateURN: "governance_policy", + TemplateDisplayName: "Governance Policy", + TemplateDescription: "Template that is mandatory to be used.", + TagValues: []tag.TagValue{ + { + FieldID: 1, + FieldValue: "Public", + FieldURN: "classification", + FieldDisplayName: "classification", + FieldDescription: "The classification of this record", + FieldDataType: "enumerated", + FieldRequired: true, + FieldOptions: []string{"Public", "Restricted"}, + }, + { + FieldID: 2, + FieldValue: true, + FieldURN: "is_encrypted", + FieldDisplayName: "Is Encrypted?", + FieldDescription: "Specify whether this record is encrypted or not.", + FieldDataType: "boolean", + FieldRequired: true, + }, + }, + } +} + +func (s *ServiceTestSuite) templateQuery(urn string) tag.Template { + return tag.Template{URN: urn} +} + +func TestService(t *testing.T) { + suite.Run(t, &ServiceTestSuite{}) +} diff --git a/tag/tag.go b/tag/tag.go new file mode 100644 index 00000000..282fd310 --- /dev/null +++ b/tag/tag.go @@ -0,0 +1,37 @@ +package tag + +import ( + "time" +) + +// Tag is the tag to be managed +type Tag struct { + RecordType string `json:"record_type" validate:"required"` + RecordURN string `json:"record_urn" validate:"required"` + TemplateURN string `json:"template_urn" validate:"required"` + TagValues []TagValue `json:"tag_values" validate:"required,min=1,dive"` + TemplateDisplayName string `json:"template_display_name"` + TemplateDescription string `json:"template_description"` +} + +// TagValue is one of the value for a tag +type TagValue struct { + FieldID uint `json:"field_id" validate:"required"` + FieldValue interface{} `json:"field_value" validate:"required"` + FieldURN string `json:"field_urn"` + FieldDisplayName string `json:"field_display_name"` + FieldDescription string `json:"field_description"` + FieldDataType string `json:"field_data_type"` + FieldOptions []string `json:"field_options"` + FieldRequired bool `json:"field_required"` + CreatedAt time.Time `json:"created_at"` + UpdatedAt time.Time `json:"updated_at"` +} + +// TagRepository is a contract to communicate with the primary store +type TagRepository interface { + Create(tag *Tag) error + Read(filter Tag) ([]Tag, error) + Update(tag *Tag) error + Delete(filter Tag) error +} diff --git a/tag/template.go b/tag/template.go new file mode 100644 index 00000000..ee75940c --- /dev/null +++ b/tag/template.go @@ -0,0 +1,36 @@ +package tag + +import ( + "time" +) + +// Template is a template of a tag for a resource +type Template struct { + URN string `json:"urn" validate:"required"` + DisplayName string `json:"display_name" validate:"required"` + Description string `json:"description" validate:"required"` + Fields []Field `json:"fields" validate:"required,min=1,dive"` + CreatedAt time.Time `json:"created_at"` + UpdatedAt time.Time `json:"updated_at"` +} + +// Field is a field for a single template +type Field struct { + ID uint `json:"id"` + URN string `json:"urn" validate:"required"` + DisplayName string `json:"display_name" validate:"required"` + Description string `json:"description" validate:"required"` + DataType string `json:"data_type" validate:"oneof=string double boolean enumerated datetime"` + Options []string `json:"options"` + Required bool `json:"required"` + CreatedAt time.Time `json:"created_at"` + UpdatedAt time.Time `json:"updated_at"` +} + +// TemplateRepository is a contract to communicate with the primary store +type TemplateRepository interface { + Create(template *Template) error + Read(filter Template) ([]Template, error) + Update(template *Template) error + Delete(filter Template) error +} diff --git a/tag/template_service.go b/tag/template_service.go new file mode 100644 index 00000000..c4744bbd --- /dev/null +++ b/tag/template_service.go @@ -0,0 +1,155 @@ +package tag + +import ( + "fmt" + + "github.com/odpf/columbus/tag/validator" + "github.com/pkg/errors" +) + +var validDomainFieldDataType = []string{ + "string", + "double", + "boolean", + "enumerated", + "datetime", +} + +// Service is a type of service that manages business process +type TemplateService struct { + validator validator.Validator + repository TemplateRepository +} + +// Validate validates domain template based on the business rule +func (s *TemplateService) Validate(template Template) error { + err := s.validator.Validate(template) + if err != nil { + err = ValidationError{err} + } + + return err +} + +// Create handles create business operation for template +func (s *TemplateService) Create(template *Template) error { + if template == nil { + return errors.New("template is nil") + } + err := s.Validate(*template) + if err != nil { + return err + } + + filterForExistence := Template{ + URN: template.URN, + } + templateRecords, err := s.repository.Read(filterForExistence) + if err != nil { + return errors.Wrap(err, "error checking template existence") + } + if len(templateRecords) > 0 { + return DuplicateTemplateError{URN: template.URN} + } + + err = s.repository.Create(template) + if err != nil { + return errors.Wrap(err, "error creating template") + } + + return nil +} + +// Index handles read business operation for template +func (s *TemplateService) Index(template Template) ([]Template, error) { + output, err := s.repository.Read(template) + if err != nil { + return nil, errors.Wrap(err, "error fetching templates") + } + return output, nil +} + +// Update handles update business operation for template +func (s *TemplateService) Update(template *Template) error { + if template == nil { + return errors.New("template is nil") + } + err := s.Validate(*template) + if err != nil { + return err + } + filterForExistence := Template{ + URN: template.URN, + } + templateRecords, err := s.repository.Read(filterForExistence) + if err != nil { + return errors.Wrap(err, "error checking template existence") + } + if len(templateRecords) == 0 { + return TemplateNotFoundError{URN: template.URN} + } + + // check for duplication + templateFromDB := templateRecords[0] + isFieldIDPartOfTemplateMap := make(map[uint]bool) + fieldURNToIDMap := make(map[string]uint) + for _, f := range templateFromDB.Fields { + isFieldIDPartOfTemplateMap[f.ID] = true + fieldURNToIDMap[f.URN] = f.ID + } + for i, f := range template.Fields { + if !isFieldIDPartOfTemplateMap[f.ID] { + return buildFieldError( + fmt.Sprintf("fields.[%d].id", i), + fmt.Sprintf("[%d] is not part of the template", f.ID), + ) + } + if fieldURNToIDMap[f.URN] != f.ID { + return buildFieldError( + fmt.Sprintf("fields.[%d].urn", i), + fmt.Sprintf("[%s] already exists within the template", f.URN), + ) + } + } + + err = s.repository.Update(template) + if err != nil { + return errors.Wrap(err, "error updating template") + } + return nil +} + +// Find handles request to get template by urn +func (s *TemplateService) Find(urn string) (Template, error) { + queryDomainTemplate := Template{ + URN: urn, + } + listOfDomainTemplate, err := s.repository.Read(queryDomainTemplate) + if err != nil { + return Template{}, errors.Wrap(err, "error reading repository") + } + if len(listOfDomainTemplate) == 0 { + return Template{}, TemplateNotFoundError{URN: urn} + } + return listOfDomainTemplate[0], nil +} + +// Delete handles request to delete template by urn +func (s *TemplateService) Delete(urn string) error { + template := Template{ + URN: urn, + } + err := s.repository.Delete(template) + if err != nil { + return errors.Wrap(err, "error deleting template") + } + return nil +} + +// NewTemplateService initializes service template service +func NewTemplateService(r TemplateRepository) *TemplateService { + return &TemplateService{ + validator: newTemplateValidator(), + repository: r, + } +} diff --git a/tag/template_service_test.go b/tag/template_service_test.go new file mode 100644 index 00000000..96debec2 --- /dev/null +++ b/tag/template_service_test.go @@ -0,0 +1,586 @@ +package tag_test + +import ( + "errors" + "fmt" + "testing" + "time" + + "github.com/odpf/columbus/tag" + "github.com/odpf/columbus/tag/mocks" + "github.com/odpf/columbus/tag/validator" + + "github.com/stretchr/testify/mock" + "github.com/stretchr/testify/suite" +) + +type TemplateServiceTestSuite struct { + suite.Suite + service *tag.TemplateService + repository *mocks.TemplateRepository +} + +func (s *TemplateServiceTestSuite) TestNewTemplateService() { + s.Run("should return service and nil no error found", func() { + r := &mocks.TemplateRepository{} + + actualService := tag.NewTemplateService(r) + s.NotNil(actualService) + }) +} + +func (s *TemplateServiceTestSuite) Setup() { + s.repository = &mocks.TemplateRepository{} + var err error + s.service = tag.NewTemplateService(s.repository) + s.Require().NoError(err) +} + +func (s *TemplateServiceTestSuite) TestValidate() { + r := &mocks.TemplateRepository{} + service := tag.NewTemplateService(r) + + s.Run("should return error if urn is empty", func() { + template := s.buildTemplate() + template.URN = "" + + expectedErrorMsg := "error with [urn : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "urn": "cannot be empty", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if display name is empty", func() { + template := s.buildTemplate() + template.DisplayName = "" + + expectedErrorMsg := "error with [display_name : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "display_name": "cannot be empty", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if description is empty", func() { + template := s.buildTemplate() + template.Description = "" + + expectedErrorMsg := "error with [description : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "description": "cannot be empty", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if fields is nil", func() { + template := s.buildTemplate() + template.Fields = nil + + expectedErrorMsg := "error with [fields : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields": "cannot be empty", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if fields is empty", func() { + template := s.buildTemplate() + template.Fields = []tag.Field{} + + expectedErrorMsg := "error with [fields : must be at least 1]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields": "must be at least 1", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if fields urn is empty", func() { + template := s.buildTemplate() + template.Fields[0].URN = "" + + expectedErrorMsg := "error with [fields[0].urn : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[0].urn": "cannot be empty", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if fields display name is empty", func() { + template := s.buildTemplate() + template.Fields[0].DisplayName = "" + + expectedErrorMsg := "error with [fields[0].display_name : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[0].display_name": "cannot be empty", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if fields description is empty", func() { + template := s.buildTemplate() + template.Fields[0].Description = "" + + expectedErrorMsg := "error with [fields[0].description : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[0].description": "cannot be empty", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if fields data type is invalid", func() { + template := s.buildTemplate() + template.Fields[0].DataType = "Random_Type" + + expectedErrorMsg := "error with [fields[0].data_type : data_type must be one of [string double boolean enumerated datetime]]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[0].data_type": "data_type must be one of [string double boolean enumerated datetime]", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if fields data type enumerated but options nil", func() { + template := s.buildTemplate() + template.Fields[0].Options = nil + + expectedErrorMsg := "error with [fields[0].options : cannot be empty with data_type [enumerated]]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[0].options": "cannot be empty with data_type [enumerated]", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if fields data type enumerated but options empty", func() { + template := s.buildTemplate() + template.Fields[0].Options = []string{} + + expectedErrorMsg := "error with [fields[0].options : cannot be empty with data_type [enumerated]]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[0].options": "cannot be empty with data_type [enumerated]", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if fields data type enumerated but options contains empty", func() { + template := s.buildTemplate() + template.Fields[0].Options = []string{ + "Team Owner", "", "Governor Email", + } + + expectedErrorMsg := "error with [fields[0].options : cannot contain empty element]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields[0].options": "cannot contain empty element", + }, + } + + actualError := service.Validate(template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return nil if fields data type not enumerated and options empty", func() { + template := s.buildTemplate() + template.Fields[0].Options = nil + template.Fields[0].DataType = "string" + + actualError := service.Validate(template) + + s.NoError(actualError) + }) +} + +func (s *TemplateServiceTestSuite) TestCreate() { + s.Run("should return error if domain template is nil", func() { + s.Setup() + + err := s.service.Create(nil) + s.Error(err) + }) + + s.Run("should return error if error encountered during validation", func() { + s.Setup() + template := s.buildTemplate() + template.Description = "" + + expectedErrorMsg := "error with [description : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "description": "cannot be empty", + }, + } + + actualError := s.service.Create(&template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if error encountered when checking for duplication", func() { + s.Setup() + template := s.buildTemplate() + filterForExistence := tag.Template{ + URN: template.URN, + } + s.repository.On("Read", filterForExistence).Return(nil, errors.New("unexpected error")) + + err := s.service.Create(&template) + s.Error(err) + }) + + s.Run("should return error if template specified by the urn already exists", func() { + s.Setup() + template := s.buildTemplate() + filterForExistence := tag.Template{ + URN: template.URN, + } + s.repository.On("Read", filterForExistence).Return([]tag.Template{{}}, nil) + + err := s.service.Create(&template) + s.Equal(tag.DuplicateTemplateError{URN: template.URN}, err) + }) + + s.Run("should return error if found error during create", func() { + s.Setup() + now := time.Now() + originalDomainTemplate := s.buildTemplate() + referenceDomainTemplate := s.buildTemplate() + referenceDomainTemplate.CreatedAt = now + filterForExistence := tag.Template{ + URN: originalDomainTemplate.URN, + } + s.repository.On("Read", filterForExistence).Return([]tag.Template{}, nil) + s.repository.On("Create", &originalDomainTemplate).Return(errors.New("unexpected error")) + + err := s.service.Create(&originalDomainTemplate) + s.Error(err) + }) + + s.Run("should return nil if success in create", func() { + s.Setup() + now := time.Now() + originalDomainTemplate := s.buildTemplate() + referenceDomainTemplate := s.buildTemplate() + referenceDomainTemplate.CreatedAt = now + filterForExistence := tag.Template{ + URN: originalDomainTemplate.URN, + } + s.repository.On("Read", filterForExistence).Return([]tag.Template{}, nil) + s.repository.On("Create", &originalDomainTemplate).Run(func(args mock.Arguments) { + tmplt := args.Get(0).(*tag.Template) + tmplt.CreatedAt = now + }).Return(nil) + + actualError := s.service.Create(&originalDomainTemplate) + + s.NoError(actualError) + s.EqualValues(referenceDomainTemplate, originalDomainTemplate) + }) +} + +func (s *TemplateServiceTestSuite) TestIndex() { + s.Run("should return nil and error if encountered unexpected error during read", func() { + s.Setup() + template := s.buildTemplate() + s.repository.On("Read", template).Return(nil, errors.New("unexpected error")) + + _, err := s.service.Index(template) + s.Error(err) + }) + + s.Run("should return domain templates and nil if no error found", func() { + s.Setup() + template := s.buildTemplate() + s.repository.On("Read", template).Return([]tag.Template{template}, nil) + + expectedTemplate := []tag.Template{template} + + actualTemplate, actualError := s.service.Index(template) + + s.EqualValues(expectedTemplate, actualTemplate) + s.NoError(actualError) + }) +} + +func (s *TemplateServiceTestSuite) TestUpdate() { + s.Run("should return error if domain template is nil", func() { + s.Setup() + var template *tag.Template = nil + + err := s.service.Update(template) + s.EqualError(err, "template is nil") + }) + + s.Run("should return error if error encountered during validation", func() { + s.Setup() + template := s.buildTemplate() + template.Description = "" + + expectedErrorMsg := "error with [description : cannot be empty]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "description": "cannot be empty", + }, + } + + actualError := s.service.Update(&template) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if encountered unexpected error during read for existence", func() { + s.Setup() + template := s.buildTemplate() + filterForExistence := tag.Template{ + URN: template.URN, + } + s.repository.On("Read", filterForExistence).Return(nil, errors.New("unexpected error")) + + err := s.service.Update(&template) + s.Error(err) + }) + + s.Run("should return error if field is not part of template", func() { + s.Setup() + template := s.buildTemplate() + newTemplate := s.buildTemplate() + newTemplate.Fields[0].ID = 99 + + filterForExistence := tag.Template{ + URN: newTemplate.URN, + } + s.repository.On("Read", filterForExistence).Return([]tag.Template{template}, nil) + + expectedErrorMsg := "error with [fields.[0].id : [99] is not part of the template]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields.[0].id": fmt.Sprintf("[%d] is not part of the template", + newTemplate.Fields[0].ID, + ), + }, + } + + actualError := s.service.Update(&newTemplate) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if trying to update field urn that already exist", func() { + s.Setup() + template := s.buildTemplate() + newTemplate := s.buildTemplate() + newTemplate.Fields[0].URN = template.Fields[1].URN + + filterForExistence := tag.Template{ + URN: newTemplate.URN, + } + s.repository.On("Read", filterForExistence).Return([]tag.Template{template}, nil) + + expectedErrorMsg := "error with [fields.[0].urn : [team_custodianr] already exists within the template]" + expectedFieldError := tag.ValidationError{ + validator.FieldError{ + "fields.[0].urn": fmt.Sprintf("[%s] already exists within the template", + newTemplate.Fields[0].URN, + ), + }, + } + + actualError := s.service.Update(&newTemplate) + + s.EqualError(actualError, expectedErrorMsg) + s.EqualValues(expectedFieldError, actualError.(tag.ValidationError)) + }) + + s.Run("should return error if found error during update", func() { + s.Setup() + template := s.buildTemplate() + newTemplate := s.buildTemplate() + + filterForExistence := tag.Template{ + URN: newTemplate.URN, + } + s.repository.On("Read", filterForExistence).Return([]tag.Template{template}, nil) + s.repository.On("Update", &newTemplate).Return(errors.New("unexpected error")) + + err := s.service.Update(&newTemplate) + s.Error(err) + }) + + s.Run("should return nil if repository update is success", func() { + s.Setup() + template := s.buildTemplate() + newTemplate := s.buildTemplate() + + filterForExistence := tag.Template{ + URN: template.URN, + } + s.repository.On("Read", filterForExistence).Return([]tag.Template{template}, nil) + s.repository.On("Update", &newTemplate).Run(func(args mock.Arguments) { + newTemplate.UpdatedAt = time.Now() + }).Return(nil) + + actualError := s.service.Update(&newTemplate) + s.NoError(actualError) + }) +} + +func (s *TemplateServiceTestSuite) TestFind() { + s.Run("should return empty and error if found unexpected error", func() { + s.Setup() + var urn string = "sample-urn" + s.repository.On("Read", mock.Anything).Return(nil, errors.New("unexpected error")) + + _, err := s.service.Find(urn) + s.Error(err) + }) + + s.Run("should return not found error if template is not found", func() { + s.Setup() + var urn string = "sample-urn" + s.repository.On("Read", mock.Anything).Return([]tag.Template{}, nil) + + _, err := s.service.Find(urn) + s.Error(err) + s.ErrorIs(err, tag.TemplateNotFoundError{URN: urn}) + }) + + s.Run("should return domain template and nil if record is found", func() { + s.Setup() + var urn string = "sample-urn" + template := s.buildTemplate() + s.repository.On("Read", mock.Anything).Return([]tag.Template{template}, nil) + + expectedTemplate := template + + actualTemplate, actualError := s.service.Find(urn) + + s.EqualValues(expectedTemplate, actualTemplate) + s.NoError(actualError) + }) +} + +func (s *TemplateServiceTestSuite) TestDelete() { + s.Run("should return error if encountered unexpected error during delete", func() { + s.Setup() + var urn string = "sample-urn" + s.repository.On("Delete", mock.Anything).Return(errors.New("unexpected error")) + + actualError := s.service.Delete(urn) + + s.Error(actualError) + s.EqualValues("error deleting template: unexpected error", actualError.Error()) + }) + + s.Run("should return delete result from repository", func() { + s.Setup() + var urn string = "sample-urn" + s.repository.On("Delete", mock.Anything).Return(nil).Once() + s.repository.On("Delete", mock.Anything).Return(errors.New("unexpected error")).Once() + + actualError1 := s.service.Delete(urn) + actualError2 := s.service.Delete(urn) + + s.NoError(actualError1) + s.Error(actualError2) + }) +} + +func (s *TemplateServiceTestSuite) buildTemplate() tag.Template { + return tag.Template{ + URN: "governance_policy", + DisplayName: "Governance Policy", + Description: "Template that is mandatory to be used.", + Fields: []tag.Field{ + { + ID: 1, + URN: "team_owner", + DisplayName: "Team Owner", + Description: "Owner of the resource.", + DataType: "enumerated", + Required: true, + Options: []string{"PIC", "Escalated"}, + }, + { + ID: 2, + URN: "team_custodianr", + DisplayName: "Team Custodian", + Description: "Custodian of the resource.", + DataType: "string", + Required: false, + }, + }, + } +} + +func TestTemplateService(t *testing.T) { + suite.Run(t, &TemplateServiceTestSuite{}) +} diff --git a/tag/utils.go b/tag/utils.go new file mode 100644 index 00000000..f9ccd171 --- /dev/null +++ b/tag/utils.go @@ -0,0 +1,64 @@ +package tag + +import ( + "fmt" + "strconv" + "strings" + "time" + + "github.com/odpf/columbus/tag/validator" +) + +func buildFieldError(key string, message string) error { + return ValidationError{ + validator.FieldError{ + key: message, + }, + } +} + +func ParseTagValue(templateURN string, fieldID uint, + dataType string, tagValue string, options []string) (interface{}, error, +) { + if tagValue == "" { + return nil, nil + } + var output interface{} + var err error + switch dataType { + case "double": + output, err = strconv.ParseFloat(tagValue, 64) + if err != nil { + err = fmt.Errorf("template [%s] on field [%d] should be double", templateURN, fieldID) + } + case "boolean": + output, err = strconv.ParseBool(tagValue) + if err != nil { + err = fmt.Errorf("template [%s] on field [%d] should be boolean", templateURN, fieldID) + } + case "enumerated": + isValueValid := false + for _, opt := range options { + if tagValue == opt { + isValueValid = true + output = opt + break + } + } + if !isValueValid { + err = fmt.Errorf("template [%s] on field [%d] should be one of (%s)", + templateURN, fieldID, strings.Join(options, ", "), + ) + } + case "datetime": + output, err = time.Parse(time.RFC3339, tagValue) + if err != nil { + err = fmt.Errorf("template [%s] on field [%d] should follow RFC3339", + templateURN, fieldID, + ) + } + case "string": + output = tagValue + } + return output, err +} diff --git a/tag/validator.go b/tag/validator.go new file mode 100644 index 00000000..4977ffe1 --- /dev/null +++ b/tag/validator.go @@ -0,0 +1,107 @@ +package tag + +import ( + "fmt" + + ut "github.com/go-playground/universal-translator" + v "github.com/go-playground/validator/v10" + "github.com/odpf/columbus/tag/validator" +) + +// newValidator initializes validator for tag +func newValidator() validator.Validator { + v, err := validator.NewBuilder(). + WithTranslations([]validator.Translation{ + { + Tag: "required", + Message: "cannot be empty", + Override: true, + }, + { + Tag: "min", + Message: "must be at least {0}", + Override: true, + TranslationFunc: func(t ut.Translator, fe v.FieldError) string { + output, _ := t.T(fe.Tag(), fe.Param()) + return output + }, + }, + }). + Build() + if err != nil { + panic(err) + } + + return v +} + +// newTemplateValidator initializes validator for tag template +func newTemplateValidator() validator.Validator { + v, err := validator.NewBuilder(). + WithStructValidations([]validator.StructValidation{ + { + Type: Template{}, + Func: func(sl v.StructLevel) { + template, ok := sl.Current().Interface().(Template) + if !ok { + sl.ReportError(nil, "struct", "", "is_not_a_template", "") + } + + for i, field := range template.Fields { + if field.DataType == "enumerated" { + if len(field.Options) == 0 { + sl.ReportError( + nil, fmt.Sprintf("fields[%d].options", i), "", "enumerated_restricted", "", + ) + } + for _, opt := range field.Options { + if opt == "" { + sl.ReportError( + nil, fmt.Sprintf("fields[%d].options", i), "", "element_not_empty", "", + ) + } + } + } + } + }, + }, + }). + WithTranslations([]validator.Translation{ + { + Tag: "required", + Message: "cannot be empty", + Override: true, + }, + { + Tag: "min", + Message: "must be at least {0}", + Override: true, + TranslationFunc: func(t ut.Translator, fe v.FieldError) string { + output, _ := t.T(fe.Tag(), fe.Param()) + return output + }, + }, + { + Tag: "enumerated_restricted", + Message: "cannot be empty with data_type [enumerated]", + TranslationFunc: func(t ut.Translator, fe v.FieldError) string { + output, _ := t.T(fe.Tag()) + return output + }, + }, + { + Tag: "element_not_empty", + Message: "cannot contain empty element", + TranslationFunc: func(t ut.Translator, fe v.FieldError) string { + output, _ := t.T(fe.Tag()) + return output + }, + }, + }). + Build() + if err != nil { + panic(err) + } + + return v +} diff --git a/tag/validator/builder.go b/tag/validator/builder.go new file mode 100644 index 00000000..61bca469 --- /dev/null +++ b/tag/validator/builder.go @@ -0,0 +1,169 @@ +package validator + +import ( + "reflect" + "strings" + + "github.com/go-playground/locales/en" + ut "github.com/go-playground/universal-translator" + "github.com/go-playground/validator/v10" + en_translation "github.com/go-playground/validator/v10/translations/en" +) + +const defaultLocale = "en" + +// Builder is type to build validator +type Builder struct { + fieldValidations []FieldValidation + structValidations []StructValidation + translations []Translation + + validate *validator.Validate + translator ut.Translator +} + +// WithTranslations tells builder to include custom translation +func (b *Builder) WithTranslations(translations []Translation) *Builder { + output := *b + output.translations = translations + return &output +} + +// WithStructValidations tells builder to include custom struct validation +func (b *Builder) WithStructValidations(structValidations []StructValidation) *Builder { + output := *b + output.structValidations = structValidations + return &output +} + +// WithFieldValidations tells builder to include custom field validation +func (b *Builder) WithFieldValidations(fieldValidations []FieldValidation) *Builder { + output := *b + output.fieldValidations = fieldValidations + return &output +} + +// Build builds the validator +func (b *Builder) Build() (Validator, error) { + b.translator = b.initializeTranslator() + validate, err := b.initializeValidate(b.translator) + if err != nil { + return nil, err + } + b.validate = validate + + if b.fieldValidations != nil { + err = b.registerFieldValidations(b.validate, b.fieldValidations) + if err != nil { + return nil, err + } + } + if b.structValidations != nil { + b.registerStructValidations(b.validate, b.structValidations) + } + if b.translations != nil { + err = b.registerTranslations(b.validate, b.translator, b.translations) + if err != nil { + return nil, err + } + } + return b, nil +} + +// Validate validates the type for any violation +func (b *Builder) Validate(s interface{}) error { + err := b.validate.Struct(s) + if err == nil { + return nil + } + validationErrors, ok := err.(validator.ValidationErrors) + if !ok { + return err + } + fieldErrors := make(FieldError) + for _, f := range validationErrors { + var field string + splitNamespace := strings.Split(f.Namespace(), ".") + if len(splitNamespace) > 0 { + if len(splitNamespace) > 1 { + field = strings.Join(splitNamespace[1:], ".") + } else { + field = splitNamespace[0] + } + } + + errMsg := f.Translate(b.translator) + fieldErrors[field] = errMsg + } + return fieldErrors +} + +func (b *Builder) initializeTranslator() ut.Translator { + universalTranslator := ut.New(en.New(), en.New()) + translator, _ := universalTranslator.GetTranslator(defaultLocale) + return translator +} + +func (b *Builder) initializeValidate(translator ut.Translator) (*validator.Validate, error) { + validate := validator.New() + validate.RegisterTagNameFunc(b.tagNameFunc) + if err := en_translation.RegisterDefaultTranslations(validate, translator); err != nil { + return nil, err + } + return validate, nil +} + +func (b *Builder) registerFieldValidations(validate *validator.Validate, fieldValidations []FieldValidation) error { + for _, f := range fieldValidations { + err := validate.RegisterValidation(f.Tag, f.Func) + if err != nil { + return err + } + } + return nil +} + +func (b *Builder) registerStructValidations(validate *validator.Validate, structValidations []StructValidation) { + for _, s := range structValidations { + validate.RegisterStructValidation(s.Func, s.Type) + } +} + +func (b *Builder) registerTranslations(validate *validator.Validate, translator ut.Translator, translations []Translation) error { + for _, t := range translations { + registerFn := b.getRegisterFn(t.Tag, t.Message, t.Override) + transFunc := t.TranslationFunc + if transFunc == nil { + transFunc = b.transFunc + } + err := validate.RegisterTranslation(t.Tag, translator, registerFn, transFunc) + if err != nil { + return err + } + } + return nil +} + +func (b *Builder) tagNameFunc(fld reflect.StructField) string { + name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0] + if name == "-" { + return "" + } + return name +} + +func (b *Builder) getRegisterFn(tag string, translation string, override bool) validator.RegisterTranslationsFunc { + return func(ut ut.Translator) error { + return ut.Add(tag, translation, override) + } +} + +func (b *Builder) transFunc(ut ut.Translator, fe validator.FieldError) string { + t, _ := ut.T(fe.Tag()) + return t +} + +// NewBuilder initializes builder +func NewBuilder() *Builder { + return &Builder{} +} diff --git a/tag/validator/error.go b/tag/validator/error.go new file mode 100644 index 00000000..af84eebf --- /dev/null +++ b/tag/validator/error.go @@ -0,0 +1,29 @@ +package validator + +import ( + "encoding/json" + "fmt" + "strings" +) + +// FieldError is error with key is field name and value is all errors for that field +type FieldError map[string]string + +// Error returns error that represent the field error +func (d FieldError) Error() string { + var errFields []string + for field, value := range d { + errFields = append(errFields, fmt.Sprintf("%s : %s", field, value)) + } + output := fmt.Sprintf("error with [%s]", strings.Join(errFields, ", ")) + return output +} + +// JSON converts field error into its JSON representation +func (d FieldError) JSON() []byte { + output, err := json.Marshal(d) + if err != nil { + return []byte(err.Error()) + } + return output +} diff --git a/tag/validator/error_test.go b/tag/validator/error_test.go new file mode 100644 index 00000000..f6c183a9 --- /dev/null +++ b/tag/validator/error_test.go @@ -0,0 +1,24 @@ +package validator + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestFieldErrorAsString(t *testing.T) { + key1 := "key1 error" + message1 := "message1 error" + + key2 := "key2 error" + message2 := "message2 error" + + err := FieldError{ + key1: message1, + key2: message2, + } + + expectedString := "error with [key1 error : message1 error, key2 error : message2 error]" + + assert.Equal(t, expectedString, err.Error()) +} diff --git a/tag/validator/validator.go b/tag/validator/validator.go new file mode 100644 index 00000000..43340d01 --- /dev/null +++ b/tag/validator/validator.go @@ -0,0 +1,31 @@ +package validator + +import ( + ut "github.com/go-playground/universal-translator" + "github.com/go-playground/validator/v10" +) + +// Validator is contract to do validation +type Validator interface { + Validate(interface{}) error +} + +// Translation is a type to describe how to translate +type Translation struct { + Tag string + Message string + Override bool + TranslationFunc func(ut.Translator, validator.FieldError) string +} + +// StructValidation is a type to describe how to validate a struct +type StructValidation struct { + Type interface{} + Func validator.StructLevelFunc +} + +// FieldValidation is a type to describe how to validate a field +type FieldValidation struct { + Tag string + Func validator.Func +}