-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for DBS API parameters checks via parameters.json file
- Loading branch information
Showing
11 changed files
with
400 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| package dbs | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "io/ioutil" | ||
| "log" | ||
| "net/http" | ||
|
|
||
| "github.com/dmwm/dbs2go/utils" | ||
| ) | ||
|
|
||
| // ApiParameterFile represents API parameter file | ||
| var ApiParametersFile string | ||
|
|
||
| // ApiParameters rerepresents a API parameters record | ||
| type ApiParameters struct { | ||
| Api string | ||
| Parameters []string | ||
| } | ||
|
|
||
| // ApiParametersMap represents data type of api parameters | ||
| type ApiParametersMap map[string][]string | ||
|
|
||
| // ApiParamMap an object which holds API parameter records | ||
| var ApiParamMap ApiParametersMap | ||
|
|
||
| // LoadApiParameters loads Api parameters and constructs ApiParameters map | ||
| func LoadApiParameters(fname string) (ApiParametersMap, error) { | ||
| data, err := ioutil.ReadFile(fname) | ||
| if err != nil { | ||
| log.Printf("Unable to read, file '%s', error: %v\n", fname, err) | ||
| return nil, Error(err, ReaderErrorCode, "", "dbs.parameters.LoadParameters") | ||
| } | ||
| var records []ApiParameters | ||
| err = json.Unmarshal(data, &records) | ||
| if err != nil { | ||
| log.Printf("Unable to parse, file '%s', error: %v\n", fname, err) | ||
| return nil, Error(err, UnmarshalErrorCode, "", "dbs.parameters.LoadParameters") | ||
| } | ||
| pmap := make(ApiParametersMap) | ||
| for _, rec := range records { | ||
| pmap[rec.Api] = rec.Parameters | ||
| } | ||
| return pmap, nil | ||
| } | ||
|
|
||
| // CheckQueryParameters checks query parameters against API parameters map | ||
| func CheckQueryParameters(r *http.Request, api string) error { | ||
| var err error | ||
| if ApiParamMap == nil { | ||
| log.Println("loading", ApiParametersFile) | ||
| ApiParamMap, err = LoadApiParameters(ApiParametersFile) | ||
| if err != nil { | ||
| return Error(GenericErr, LoadErrorCode, "", "dbs.parameters.CheckQueryParameters") | ||
| } | ||
| } | ||
| for k, _ := range r.URL.Query() { | ||
| if params, ok := ApiParamMap[api]; ok { | ||
| if !utils.InList(k, params) { | ||
| msg := fmt.Sprintf("parameter '%s' is not accepted by '%s' API", k, api) | ||
| return Error( | ||
| InvalidParamErr, | ||
| ParametersErrorCode, | ||
| msg, | ||
| "dbs.parameters.CheckQueryParameters") | ||
| } | ||
| } else { | ||
| log.Printf("DBS %s API is not presented in ApiParamMap", api) | ||
| } | ||
| } | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,186 @@ | ||
| [ | ||
| { | ||
| "api": "datasets", | ||
| "parameters": [ | ||
| "dataset", "parent_dataset", "release_version", "pset_hash", "app_name", | ||
| "output_module_label", "global_tag", "processing_version", "acquisition_era_name", | ||
| "run_num", "physics_group_name", "logical_file_name", "primary_ds_name", | ||
| "primary_ds_type", "processed_ds_name", "data_tier_name", "dataset_access_type", | ||
| "prep_id", "create_by", "last_modified_by", "min_cdate", "max_cdate", "min_ldate", | ||
| "max_ldate", "cdate", "ldate", "detail", "dataset_id", "is_dataset_valid" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "datatiers", | ||
| "parameters": [ | ||
| "data_tier_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "blocks", | ||
| "parameters": [ | ||
| "dataset", "block_name", "data_tier_name", "origin_site_name", | ||
| "logical_file_name", "run_num", "min_cdate", "max_cdate", "min_ldate", "max_ldate", | ||
| "cdate", "ldate", "open_for_writing", "detail" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "blockTrio", | ||
| "parameters": [ | ||
| "block_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "files", | ||
| "parameters": [ | ||
| "dataset", "block_name", "logical_file_name", "release_version", | ||
| "pset_hash", "app_name", "output_module_label", "run_num", "origin_site_name", | ||
| "lumi_list", "detail", "validFileOnly", "sumOverLumi" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "primarydatasets", | ||
| "parameters": [ | ||
| "primary_ds_name", "primary_ds_type" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "parentDSTrio", | ||
| "parameters": [ | ||
| "dataset" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "acquisitioneras", | ||
| "parameters": [ | ||
| "acquisition_era_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "acquisitioneras_ci", | ||
| "parameters": [ | ||
| "acquisition_era_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "releaseversions", | ||
| "parameters": [ | ||
| "release_version", "dataset", "logical_file_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "physicsgroups", | ||
| "parameters": [ | ||
| "physics_group_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "primarydstypes", | ||
| "parameters": [ | ||
| "primary_ds_type", "dataset" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "datatypes", | ||
| "parameters": [ | ||
| "datatype", "dataset" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "processingeras", | ||
| "parameters": [ | ||
| "processing_version" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "outputconfigs", | ||
| "parameters": [ | ||
| "dataset", "logical_file_name", "release_version", "pset_hash", | ||
| "app_name", "output_module_label", "block_id", "global_tag" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "datasetaccesstypes", | ||
| "parameters": [ | ||
| "dataset_access_type" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "runs", | ||
| "parameters": [ | ||
| "run_num", "logical_file_name", "block_name", "dataset" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "runsummaries", | ||
| "parameters": [ | ||
| "dataset", "run_num" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "blockorigin", | ||
| "parameters": [ | ||
| "origin_site_name", "dataset", "block_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "blockdump", | ||
| "parameters": [ | ||
| "block_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "blockchildren", | ||
| "parameters": [ | ||
| "block_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "blockparents", | ||
| "parameters": [ | ||
| "block_name" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "blocksummaries", | ||
| "parameters": [ | ||
| "block_name", "dataset", "detail" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "filechildren", | ||
| "parameters": [ | ||
| "logical_file_name", "block_name", "block_id" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "fileparents", | ||
| "parameters": [ | ||
| "logical_file_name", "block_name", "block_id" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "filesummaries", | ||
| "parameters": [ | ||
| "block_name", "dataset", "run_num", "validFileOnly", "sumOverLumi" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "filelumis", | ||
| "parameters": [ | ||
| "logical_file_name", "block_name", "run_num", "validFileOnly" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "datasetchildren", | ||
| "parameters": [ | ||
| "dataset" | ||
| ] | ||
| }, | ||
| { | ||
| "api": "datasetparents", | ||
| "parameters": [ | ||
| "dataset" | ||
| ] | ||
| } | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.