Skip to content

Commit

Permalink
Use reflaction to simplify function
Browse files Browse the repository at this point in the history
  • Loading branch information
@dionisislolas
dionisislolas committed Dec 19, 2024
1 parent 5724927 commit 1e7b704
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 100 deletions.
148 changes: 58 additions & 90 deletions api/dataset.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"encoding/json"
"fmt"
"net/http"
"reflect"
"strings"
"time"

Expand Down Expand Up @@ -267,35 +268,7 @@ func (api *DatasetAPI) addDatasetNew(w http.ResponseWriter, r *http.Request) {

datasetID := dataset.ID

if err = validateDatasetID(ctx, datasetID, w); err != nil {
return
}

if err = validateDatasetType(ctx, dataset.Type, w); err != nil {
return
}

if err = validateDatasetTitle(ctx, dataset.Title, w); err != nil {
return
}

if err = validateDatasetDescription(ctx, dataset.Description, w); err != nil {
return
}

if err = validateDatasetNextRelease(ctx, dataset.NextRelease, w); err != nil {
return
}

if err = validateDatasetKeywords(ctx, dataset.Keywords, w); err != nil {
return
}

if err = validateDatasetThemes(ctx, dataset.Themes, dataset.Type, w); err != nil {
return
}

if err = validateDatasetContacts(ctx, dataset.Contacts, w); err != nil {
if err = validateDatasetMandatoryFields(ctx, *dataset, w); err != nil {
return
}

Expand Down Expand Up @@ -378,79 +351,74 @@ func (api *DatasetAPI) addDatasetNew(w http.ResponseWriter, r *http.Request) {
log.Info(ctx, "addDatasetNew endpoint: request completed successfully", logData)
}

func validateDatasetID(ctx context.Context, datasetID string, w http.ResponseWriter) error {
if datasetID == "" {
log.Error(ctx, "addDatasetNew endpoint: dataset ID is empty", nil)
handleDatasetAPIErr(ctx, errs.ErrMissingDatasetID, w, nil)
return errs.ErrMissingDatasetID
func validateDatasetMandatoryFields(ctx context.Context, dataset interface{}, w http.ResponseWriter) error {
v := reflect.ValueOf(dataset)
typeOfDataset := v.Type()

// find dataset type
var datasetType string
for i := 0; i < v.NumField(); i++ {
field := v.Field(i)
fieldName := typeOfDataset.Field(i).Name
if fieldName == "Type" {
datasetType = field.String()
}
}
return nil
}

func validateDatasetType(ctx context.Context, datasetType string, w http.ResponseWriter) error {
if datasetType == "" {
log.Error(ctx, "addDatasetNew endpoint: dataset type is empty", nil)
handleDatasetAPIErr(ctx, errs.ErrMissingDatasetType, w, nil)
return errs.ErrMissingDatasetType
}
return nil
}
for i := 0; i < v.NumField(); i++ {
field := v.Field(i)
fieldName := typeOfDataset.Field(i).Name

func validateDatasetTitle(ctx context.Context, datasetTitle string, w http.ResponseWriter) error {
if datasetTitle == "" {
log.Error(ctx, "addDatasetNew endpoint: dataset title is empty", nil)
handleDatasetAPIErr(ctx, errs.ErrMissingDatasetTitle, w, nil)
return errs.ErrMissingDatasetTitle
switch fieldName {
case "ID", "Type", "Title", "Description", "NextRelease":
if field.String() == "" {
err := getFieldError(fieldName)
log.Error(ctx, "addDatasetNew endpoint: dataset "+fieldName+" is empty", nil)
handleDatasetAPIErr(ctx, err, w, nil)
return err
}
case "Keywords", "Contacts":
if field.Len() == 0 {
err := getFieldError(fieldName)
log.Error(ctx, "addDatasetNew endpoint: dataset "+fieldName+" is empty", nil)
handleDatasetAPIErr(ctx, err, w, nil)
return err
}
case "Themes":
if datasetType == models.Static.String() {
if field.Len() == 0 {
err := getFieldError(fieldName)
log.Error(ctx, "addDatasetNew endpoint: dataset "+fieldName+" is empty", nil)
handleDatasetAPIErr(ctx, err, w, nil)
return err
}
}
}
}
return nil
}

func validateDatasetDescription(ctx context.Context, datasetDescription string, w http.ResponseWriter) error {
if datasetDescription == "" {
log.Error(ctx, "addDatasetNew endpoint: dataset description is empty", nil)
handleDatasetAPIErr(ctx, errs.ErrMissingDatasetDescription, w, nil)
func getFieldError(fieldName string) error {
switch fieldName {
case "ID":
return errs.ErrMissingDatasetID
case "Type":
return errs.ErrMissingDatasetType
case "Title":
return errs.ErrMissingDatasetTitle
case "Description":
return errs.ErrMissingDatasetDescription
}
return nil
}

func validateDatasetNextRelease(ctx context.Context, datasetNextRelease string, w http.ResponseWriter) error {
if datasetNextRelease == "" {
log.Error(ctx, "addDatasetNew endpoint: dataset next release is empty", nil)
handleDatasetAPIErr(ctx, errs.ErrMissingDatasetNextRelease, w, nil)
case "NextRelease":
return errs.ErrMissingDatasetNextRelease
}
return nil
}

func validateDatasetKeywords(ctx context.Context, datasetKeywords []string, w http.ResponseWriter) error {
if datasetKeywords == nil || len(datasetKeywords) == 0 {
log.Error(ctx, "addDatasetNew endpoint: dataset keywords is empty", nil)
handleDatasetAPIErr(ctx, errs.ErrMissingDatasetKeywords, w, nil)
case "Keywords":
return errs.ErrMissingDatasetKeywords
}
return nil
}

func validateDatasetThemes(ctx context.Context, datasetThemes []string, datasetType string, w http.ResponseWriter) error {
if datasetType == models.Static.String() {
if datasetThemes == nil || len(datasetThemes) == 0 {
log.Error(ctx, "addDatasetNew endpoint: dataset themes is empty", nil)
handleDatasetAPIErr(ctx, errs.ErrMissingDatasetThemes, w, nil)
return errs.ErrMissingDatasetThemes
}
return nil
}
return nil
}

func validateDatasetContacts(ctx context.Context, datasetContacts []models.ContactDetails, w http.ResponseWriter) error {
if datasetContacts == nil || len(datasetContacts) == 0 {
log.Error(ctx, "addDatasetNew endpoint: dataset contacts is empty", nil)
handleDatasetAPIErr(ctx, errs.ErrMissingDatasetContacts, w, nil)
case "Themes":
return errs.ErrMissingDatasetThemes
case "Contacts":
return errs.ErrMissingDatasetContacts
default:
return errs.ErrInternalServer
}
return nil
}

func (api *DatasetAPI) putDataset(w http.ResponseWriter, r *http.Request) {
Expand Down
43 changes: 33 additions & 10 deletions features/private_datasets.feature
View file
Original file line number Diff line number Diff line change
Expand Up @@ -276,9 +276,14 @@ Feature: Private Dataset API
When I POST "/datasets"
"""
{
"title": "",
"title": "title",
"type": "filterable",
"state": "anything",
"type": "filterable"
"next_release":"2016-04-04",
"description": "census",
"keywords":["keyword"],
"themes": ["theme"],
"contacts":[{"email":"[email protected]","name":"John Cox","telephone":"01623 456789"}]
}
"""
Then the HTTP status code should be "400"
Expand All @@ -293,7 +298,12 @@ Feature: Private Dataset API
{
"id": "ageing-population-estimates",
"title": "title",
"state": "anything"
"state": "anything",
"next_release":"2016-04-04",
"description": "census",
"keywords":["keyword"],
"themes": ["theme"],
"contacts":[{"email":"[email protected]","name":"John Cox","telephone":"01623 456789"}]
}
"""
Then the HTTP status code should be "400"
Expand All @@ -308,7 +318,12 @@ Feature: Private Dataset API
{
"id": "ageing-population-estimates",
"type": "filterable",
"state": "anything"
"state": "anything",
"next_release":"2016-04-04",
"description": "census",
"keywords":["keyword"],
"themes": ["theme"],
"contacts":[{"email":"[email protected]","name":"John Cox","telephone":"01623 456789"}]
}
"""
Then the HTTP status code should be "400"
Expand All @@ -325,7 +340,10 @@ Feature: Private Dataset API
"title": "title",
"type": "filterable",
"state": "anything",
"next_release":"2016-04-04"
"next_release":"2016-04-04",
"keywords":["keyword"],
"themes": ["theme"],
"contacts":[{"email":"[email protected]","name":"John Cox","telephone":"01623 456789"}]
}
"""
Then the HTTP status code should be "400"
Expand All @@ -342,8 +360,10 @@ Feature: Private Dataset API
"title": "title",
"type": "filterable",
"state": "anything",
"next_release":"2016-04-04",
"description": "census",
"next_release":"2016-04-04"
"themes": ["theme"],
"contacts":[{"email":"[email protected]","name":"John Cox","telephone":"01623 456789"}]
}
"""
Then the HTTP status code should be "400"
Expand All @@ -361,7 +381,9 @@ Feature: Private Dataset API
"type": "filterable",
"state": "anything",
"description": "census",
"keywords":["keyword"]
"keywords":["keyword"],
"themes": ["theme"],
"contacts":[{"email":"[email protected]","name":"John Cox","telephone":"01623 456789"}]
}
"""
Then the HTTP status code should be "400"
Expand All @@ -378,9 +400,10 @@ Feature: Private Dataset API
"title": "title",
"type": "static",
"state": "anything",
"next_release":"2016-04-04",
"description": "census",
"keywords":["keyword"],
"next_release":"2016-04-04"
"contacts":[{"email":"[email protected]","name":"John Cox","telephone":"01623 456789"}]
}
"""
Then the HTTP status code should be "400"
Expand All @@ -395,11 +418,11 @@ Feature: Private Dataset API
{
"id": "ageing-population-estimates",
"title": "title",
"type": "static",
"type": "filterable",
"state": "anything",
"next_release":"2016-04-04",
"description": "census",
"keywords":["keyword"],
"next_release":"2016-04-04",
"themes": ["theme"]
}
"""
Expand Down

0 comments on commit 1e7b704

Please sign in to comment.