From daa2528eaf2b45f7f9cc1c6f4fba7dfdcc0a23cd Mon Sep 17 00:00:00 2001 From: bitbashing Date: Tue, 19 Feb 2019 12:15:27 -0800 Subject: [PATCH] KAZOO-6051: fix ips assignments (#5526) --- applications/crossbar/doc/ips.md | 42 +- applications/crossbar/doc/ref/ips.md | 14 +- applications/crossbar/priv/api/swagger.json | 59 ++- .../crossbar/priv/couchdb/schemas/ip.json | 35 ++ .../crossbar/priv/couchdb/schemas/ips.json | 11 +- applications/crossbar/src/cb_context.erl | 1 - applications/crossbar/src/modules/cb_ips.erl | 444 ++++++++++-------- core/kazoo_documents/src/kzd_ip.erl | 59 +++ core/kazoo_documents/src/kzd_ip.erl.src | 59 +++ core/kazoo_documents/src/kzd_ips.erl.src | 6 +- core/kazoo_ips/src/kz_ip.erl | 27 +- core/kazoo_schemas/src/kz_json_schema.erl | 2 + 12 files changed, 547 insertions(+), 212 deletions(-) create mode 100644 applications/crossbar/priv/couchdb/schemas/ip.json create mode 100644 core/kazoo_documents/src/kzd_ip.erl create mode 100644 core/kazoo_documents/src/kzd_ip.erl.src diff --git a/applications/crossbar/doc/ips.md b/applications/crossbar/doc/ips.md index d0e5ffe313d..72d7f014dda 100644 --- a/applications/crossbar/doc/ips.md +++ b/applications/crossbar/doc/ips.md @@ -14,8 +14,8 @@ IP addresses assigned to the account Key | Description | Type | Default | Required | Support Level --- | ----------- | ---- | ------- | -------- | ------------- -`ips.[]` | | `string()` | | `false` | -`ips` | List of IP addresses | `array(string())` | | `false` | +`ips.[]` | | `string()|string()` | | | +`ips` | List of IP addresses | `array()` | | `false` | @@ -53,24 +53,38 @@ curl -v -X GET \ ```shell curl -v -X POST \ -H "X-Auth-Token: {AUTH_TOKEN}" \ - -d '{"data":["1.2.3.4"]}' \ + -d '{"data": {"ips" :["1.2.3.4", "5.6.7.8"]}}' \ http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/ips ``` ```json { "auth_token": "{AUTH_TOKEN}", - "data": [ - { - "assigned_to": "{ACCOUNT_ID}", - "host": "proxy1.us-east.myswitch.com", - "id": "1.2.3.4", - "ip": "1.2.3.4", - "status": "assigned", - "type": "dedicated_ip", - "zone": "us-east" - } - ], + "data": { + "ips": ["1.2.3.4", "5.6.7.8"] + }, + "request_id": "{REQUEST_ID}", + "revision": "{REVISION}", + "status": "success" +} +``` + +## Remove IPs from Account + +> DELETE /v2/accounts/{ACCOUNT_ID}/ips + +```shell +curl -v -X DELETE \ + -H "X-Auth-Token: {AUTH_TOKEN}" \ + http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/ips +``` + +```json +{ + "auth_token": "{AUTH_TOKEN}", + "data": { + "ips": ["1.2.3.4", "5.6.7.8"] + }, "request_id": "{REQUEST_ID}", "revision": "{REVISION}", "status": "success" diff --git a/applications/crossbar/doc/ref/ips.md b/applications/crossbar/doc/ref/ips.md index f3d75dfaf32..e6580b49986 100644 --- a/applications/crossbar/doc/ref/ips.md +++ b/applications/crossbar/doc/ref/ips.md @@ -10,8 +10,8 @@ IP addresses assigned to the account Key | Description | Type | Default | Required | Support Level --- | ----------- | ---- | ------- | -------- | ------------- -`ips.[]` | | `string()` | | `false` | -`ips` | List of IP addresses | `array(string())` | | `false` | +`ips.[]` | | `string()|string()` | | | +`ips` | List of IP addresses | `array()` | | `false` | @@ -45,6 +45,16 @@ curl -v -X POST \ http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/ips ``` +## Remove + +> DELETE /v2/accounts/{ACCOUNT_ID}/ips + +```shell +curl -v -X DELETE \ + -H "X-Auth-Token: {AUTH_TOKEN}" \ + http://{SERVER}:8000/v2/accounts/{ACCOUNT_ID}/ips +``` + ## Fetch > GET /v2/accounts/{ACCOUNT_ID}/ips/{IP_ADDRESS} diff --git a/applications/crossbar/priv/api/swagger.json b/applications/crossbar/priv/api/swagger.json index c1c9512cc69..4d0e211f6e4 100644 --- a/applications/crossbar/priv/api/swagger.json +++ b/applications/crossbar/priv/api/swagger.json @@ -6178,6 +6178,39 @@ ], "type": "object" }, + "ip": { + "description": "IP address assigned to the cluster", + "properties": { + "host": { + "description": "The hostname the IP belongs to", + "minLength": 1, + "type": "string" + }, + "ip": { + "description": "The IP addresses", + "oneOf": [ + { + "format": "ipv4", + "type": "string" + }, + { + "format": "ipv6", + "type": "string" + } + ] + }, + "zone": { + "description": "The zone name the IP belongs to", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ip", + "zone", + "host" + ] + }, "ips": { "description": "IP addresses assigned to the account", "properties": { @@ -6185,7 +6218,16 @@ "description": "List of IP addresses", "items": { "description": "IP address", - "type": "string" + "oneOf": [ + { + "format": "ipv4", + "type": "string" + }, + { + "format": "ipv6", + "type": "string" + } + ] }, "minItems": 1, "type": "array" @@ -39628,6 +39670,21 @@ } }, "/accounts/{ACCOUNT_ID}/ips": { + "delete": { + "parameters": [ + { + "$ref": "#/parameters/auth_token_header" + }, + { + "$ref": "#/parameters/ACCOUNT_ID" + } + ], + "responses": { + "200": { + "description": "request succeeded" + } + } + }, "get": { "parameters": [ { diff --git a/applications/crossbar/priv/couchdb/schemas/ip.json b/applications/crossbar/priv/couchdb/schemas/ip.json new file mode 100644 index 00000000000..b6b06384f6d --- /dev/null +++ b/applications/crossbar/priv/couchdb/schemas/ip.json @@ -0,0 +1,35 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "_id": "ip", + "description": "IP address assigned to the cluster", + "properties": { + "host": { + "description": "The hostname the IP belongs to", + "minLength": 1, + "type": "string" + }, + "ip": { + "description": "The IP addresses", + "oneOf": [ + { + "format": "ipv4", + "type": "string" + }, + { + "format": "ipv6", + "type": "string" + } + ] + }, + "zone": { + "description": "The zone name the IP belongs to", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "ip", + "zone", + "host" + ] +} diff --git a/applications/crossbar/priv/couchdb/schemas/ips.json b/applications/crossbar/priv/couchdb/schemas/ips.json index 8e60d769220..892358a69d2 100644 --- a/applications/crossbar/priv/couchdb/schemas/ips.json +++ b/applications/crossbar/priv/couchdb/schemas/ips.json @@ -7,7 +7,16 @@ "description": "List of IP addresses", "items": { "description": "IP address", - "type": "string" + "oneOf": [ + { + "format": "ipv4", + "type": "string" + }, + { + "format": "ipv6", + "type": "string" + } + ] }, "minItems": 1, "type": "array" diff --git a/applications/crossbar/src/cb_context.erl b/applications/crossbar/src/cb_context.erl index 1ccd4360162..f6c76a13787 100644 --- a/applications/crossbar/src/cb_context.erl +++ b/applications/crossbar/src/cb_context.erl @@ -1102,7 +1102,6 @@ add_validation_error(Property, Code, Message, Context) -> ) ), ErrorsJObj = validation_errors(Context), - Context#cb_context{validation_errors=kz_json:merge_jobjs(ErrorJObj, ErrorsJObj) ,resp_status='error' ,resp_error_code=ErrorCode diff --git a/applications/crossbar/src/modules/cb_ips.erl b/applications/crossbar/src/modules/cb_ips.erl index 67b4ade8872..0b84659fa56 100644 --- a/applications/crossbar/src/modules/cb_ips.erl +++ b/applications/crossbar/src/modules/cb_ips.erl @@ -13,7 +13,7 @@ ,validate/1, validate/2 ,post/1 ,post/2 ,put/1 - ,delete/2 + ,delete/1, delete/2 ]). -include("crossbar.hrl"). @@ -57,7 +57,7 @@ authorize(_Context, _Nouns) -> 'false'. -spec allowed_methods() -> http_methods(). allowed_methods() -> - [?HTTP_GET, ?HTTP_PUT, ?HTTP_POST]. + [?HTTP_GET, ?HTTP_PUT, ?HTTP_POST, ?HTTP_DELETE]. -spec allowed_methods(path_token()) -> http_methods(). allowed_methods(?ASSIGNED) -> @@ -101,18 +101,20 @@ validate(Context) -> _ = cb_context:put_reqid(Context), validate_ips(Context, cb_context:req_verb(Context)). --spec validate(cb_context:context(), path_token()) -> cb_context:context(). -validate(Context, PathToken) -> - _ = cb_context:put_reqid(Context), - validate_ips(Context, PathToken, cb_context:req_verb(Context)). - -spec validate_ips(cb_context:context(), kz_term:ne_binary()) -> cb_context:context(). validate_ips(Context, ?HTTP_GET) -> load_available(Context); validate_ips(Context, ?HTTP_PUT) -> maybe_create_ip(Context); validate_ips(Context, ?HTTP_POST) -> - maybe_assign_ips(Context). + validate_assign_ips(Context); +validate_ips(Context, ?HTTP_DELETE) -> + validate_release_ips(Context). + +-spec validate(cb_context:context(), path_token()) -> cb_context:context(). +validate(Context, PathToken) -> + _ = cb_context:put_reqid(Context), + validate_ips(Context, PathToken, cb_context:req_verb(Context)). -spec validate_ips(cb_context:context(), path_token(), kz_term:ne_binary()) -> cb_context:context(). validate_ips(Context, ?ASSIGNED, ?HTTP_GET) -> @@ -124,40 +126,31 @@ validate_ips(Context, ?HOSTS, ?HTTP_GET) -> validate_ips(Context, IP, ?HTTP_GET) -> load_ip(Context, IP); validate_ips(Context, IP, ?HTTP_POST) -> - validate_ip_not_in_use(Context, IP); + validate_assign_ip(Context, IP); validate_ips(Context, IP, ?HTTP_DELETE) -> - case kz_ip:fetch(IP) of - {'ok', _} -> cb_context:set_resp_status(Context, 'success'); - {'error', Error} -> crossbar_doc:handle_datamgr_errors(Error, IP, Context) - end. + validate_release_ip(Context, IP). -spec post(cb_context:context()) -> cb_context:context(). post(Context) -> - Callback = - fun() -> - case cb_context:resp_status(Context) of - 'success' -> assign_ips(Context); - _ -> Context - end - end, - ReqData = cb_context:req_data(Context), - IPs = kz_json:get_value(<<"ips">>, ReqData, []), - maybe_dry_run(Context, IPs, Callback). + assign_ips(Context). -spec post(cb_context:context(), path_token()) -> cb_context:context(). -post(Context, IP) -> - Callback = - fun() -> - case cb_context:resp_status(Context) of - 'success' -> assign_ip(Context, IP); - _ -> Context - end - end, - maybe_dry_run(Context, [IP], Callback). +post(Context, _IP) -> + assign_ips(Context). + +-spec delete(cb_context:context()) -> cb_context:context(). +delete(Context) -> + release_ips(Context). -spec delete(cb_context:context(), path_token()) -> cb_context:context(). delete(Context, IP) -> - release_or_delete_ip(Context, IP, cb_context:req_nouns(Context)). + delete(Context, IP, cb_context:req_nouns(Context)). + +-spec delete(cb_context:context(), path_token(), req_nouns()) -> cb_context:context(). +delete(Context, IP, [{<<"ips">>, [IP]}]) -> + delete_ip(Context, IP); +delete(Context, IP, [{<<"ips">>, [IP]}, {<<"accounts">>, [_]}]) -> + release_ips(Context). -spec put(cb_context:context()) -> cb_context:context(). put(Context) -> @@ -197,6 +190,11 @@ load_available(Context) -> cb_context:set_resp_data(cb_context:set_resp_status(Context, 'success') ,JObjs ); + {'error', 'not_found'} -> + cb_context:add_system_error('not_found' + ,kz_json:from_list([{<<"cause">>, Zone}]) + ,Context + ); {'error', Reason} -> cb_context:add_system_error('datastore_fault' ,kz_json:from_list([{<<"cause">>, Reason}]) @@ -216,6 +214,11 @@ load_assigned(Context) -> cb_context:set_resp_data(cb_context:set_resp_status(Context, 'success') ,JObjs ); + {'error', 'not_found'} -> + cb_context:add_system_error('not_found' + ,kz_json:from_list([{<<"cause">>, AccountId}]) + ,Context + ); {'error', Reason} -> cb_context:add_system_error('datastore_fault' ,kz_json:from_list([{<<"cause">>, Reason}]) @@ -235,7 +238,7 @@ load_zones(Context) -> ,Zones ); {'error', Reason} -> - cb_context:add_system_error('datastore_fault' + cb_context:add_system_error('not_found' ,kz_json:from_list([{<<"cause">>, Reason}]) ,Context ) @@ -271,6 +274,11 @@ load_ip(Context, Id) -> cb_context:set_resp_data(cb_context:set_resp_status(Context, 'success') ,clean_ip(IPJSON) ); + {'error', 'not_found'} -> + cb_context:add_system_error('not_found' + ,kz_json:from_list([{<<"cause">>, Id}]) + ,Context + ); {'error', Reason} -> cb_context:add_system_error('datastore_fault' ,kz_json:from_list([{<<"cause">>, Reason}]) @@ -278,74 +286,113 @@ load_ip(Context, Id) -> ) end. --define(IP_SCHEMA, kz_json:from_list([{<<"type">>, <<"string">>}])). --define(HOST_SCHEMA, kz_json:from_list([{<<"type">>, <<"string">>}])). --define(ZONE_SCHEMA, kz_json:from_list([{<<"type">>, <<"string">>}])). - --define(CREATE_IP_SCHEMA - ,kz_json:from_list([{<<"ip">>, ?IP_SCHEMA} - ,{<<"host">>, ?HOST_SCHEMA} - ,{<<"zone">>, ?ZONE_SCHEMA} - ]) - ). - +%%------------------------------------------------------------------------------ +%% @doc +%% @end +%%------------------------------------------------------------------------------ -spec maybe_create_ip(cb_context:context()) -> cb_context:context(). maybe_create_ip(Context) -> - cb_context:validate_request_data(?CREATE_IP_SCHEMA, Context). + maybe_create_ip(Context, cb_context:req_nouns(Context)). +-spec maybe_create_ip(cb_context:context(), req_nouns()) -> cb_context:context(). +maybe_create_ip(Context, [{<<"ips">>, _}]) -> + cb_context:validate_request_data(<<"ip">>, Context); +maybe_create_ip(Context, _Nouns) -> + cb_context:add_system_error('forbidden', Context). %%------------------------------------------------------------------------------ %% @doc %% @end %%------------------------------------------------------------------------------ --spec maybe_assign_ips(cb_context:context()) -> cb_context:context(). -maybe_assign_ips(Context) -> - OnSuccess = fun validate_ips_not_in_use/1, - cb_context:validate_request_data(<<"ips">>, Context, OnSuccess). - --spec validate_ips_not_in_use(cb_context:context()) -> cb_context:context(). -validate_ips_not_in_use(Context) -> - validate_ips_not_in_use(Context, cb_context:req_value(Context, <<"ips">>)). - --spec validate_ips_not_in_use(cb_context:context(), kz_term:ne_binaries()) -> cb_context:context(). -validate_ips_not_in_use(Context, IPs) -> - lists:foldl(fun validate_ip_not_in_use/2, Context, IPs). - --spec validate_ip_not_in_use(kz_term:ne_binary() | cb_context:context(), kz_term:ne_binary() | cb_context:context()) -> - cb_context:context(). -validate_ip_not_in_use(<<_/binary>> = IP, Context) -> - validate_ip_not_in_use(Context, IP); -validate_ip_not_in_use(Context, <<_/binary>> = IP) -> - validate_ip_not_in_use(Context, IP, cb_context:resp_status(Context)). - --spec validate_ip_not_in_use(cb_context:context(), kz_term:ne_binary(), crossbar_status()) -> - cb_context:context(). -validate_ip_not_in_use(Context, IP, 'error') -> - case kz_ip:is_available(IP) of - 'true' -> Context; - 'false' -> error_ip_assigned(Context, IP); - {'error', Reason} -> - cb_context:add_system_error('datastore_fault' - ,kz_json:from_list([{<<"cause">>, Reason}]) - ,Context - ) +-spec validate_assign_ips(cb_context:context()) -> cb_context:context(). +validate_assign_ips(Context) -> + Resp = kz_json:from_list( + [{<<"success">>, kz_json:new()} + ,{<<"error">>, kz_json:new()} + ] + ), + Setters = [{fun cb_context:set_resp_status/2, 'success'} + ,{fun cb_context:set_resp_data/2, Resp} + ], + Context1 = cb_context:setters(Context, Setters), + cb_context:validate_request_data(<<"ips">>, Context1, fun additional_assignment_validations/1). + +-spec validate_assign_ip(cb_context:context(), path_token()) -> cb_context:context(). +validate_assign_ip(Context, IP) -> + ReqData = kz_json:from_list([{<<"ips">>, [IP]}]), + validate_assign_ips(cb_context:set_req_data(Context, ReqData)). + +-spec additional_assignment_validations(cb_context:context()) -> cb_context:context(). +additional_assignment_validations(Context) -> + IPs = [{IP, kz_ip:fetch(IP)} + || IP <- cb_context:req_value(Context, <<"ips">>, []) + ], + additional_assignment_validations(Context, IPs, [], 0). + +-spec additional_assignment_validations(cb_context:context(), kz_term:proplist(), kz_term:objects(), non_neg_integer()) -> + cb_context:context(). +additional_assignment_validations(Context, [], Assign, _Index) -> + case cb_context:resp_status(Context) =:= 'success' of + 'false' -> Context; + 'true' -> + maybe_dry_run_assignment( + cb_context:store(Context, 'assign_ips', Assign) + ) end; -validate_ip_not_in_use(Context, IP, _Status) -> - case kz_ip:is_available(IP) of - 'true' -> cb_context:set_resp_status(Context, 'success'); - 'false' -> error_ip_assigned(Context, IP); - {'error', Reason} -> - cb_context:add_system_error('datastore_fault' - ,kz_json:from_list([{<<"cause">>, Reason}]) - ,Context - ) - end. - --spec error_ip_assigned(cb_context:context(), kz_term:ne_binary()) -> cb_context:context(). -error_ip_assigned(Context, IP) -> - Msg = kz_json:from_list([{<<"cause">>, IP} - ,{<<"message">>, <<"ip already assigned">>} - ]), - cb_context:add_validation_error(<<"ip">>, <<"forbidden">>, Msg, Context). +additional_assignment_validations(Context, [{Address, {'ok', JObj}}=IP|IPs], Assign, Index) -> + AccountId = cb_context:account_id(Context), + case kz_ip:assigned_to(JObj) of + 'undefined' -> + additional_assignment_validations(Context, IPs, [JObj|Assign], Index + 1); + AccountId -> + Context1 = validate_error_already_assigned(Context, Address, Index), + additional_assignment_validations(Context1, IPs, Assign, Index + 1); + _Else -> + Context1 = validate_error_assigned(Context, IP, Index), + additional_assignment_validations(Context1, IPs, Assign, Index + 1) + end; +additional_assignment_validations(Context, [{Address, {'error', 'not_found'}}|IPs], Assign, Index) -> + Context1 = validate_error_not_found(Context, Address, Index), + additional_assignment_validations(Context1, IPs, Assign, Index + 1); +additional_assignment_validations(Context, [{_Address, {'error', Reason}}|_IPs], _Assign, _Index) -> + cb_context:add_system_error('datastore_fault' + ,kz_json:from_list([{<<"cause">>, Reason}]) + ,Context + ). + +-spec validate_error_already_assigned(cb_context:context(), kz_term:ne_binary(), non_neg_integer()) -> + cb_context:context(). +validate_error_already_assigned(Context, IP, Index) -> + Key = <<"ips.", (kz_term:to_binary(Index))/binary>>, + Message = kz_json:from_list( + [{<<"message">>, <<"ip already assigned">>} + ,{<<"value">>, IP} + ]), + cb_context:add_validation_error(Key, <<"superfluous">>, Message, Context). + +-spec validate_error_assigned(cb_context:context(), kz_term:ne_binary(), non_neg_integer()) -> + cb_context:context(). +validate_error_assigned(Context, IP, Index) -> + Key = <<"ips.", (kz_term:to_binary(Index))/binary>>, + Message = kz_json:from_list( + [{<<"message">>, <<"ip assigned to another account">>} + ,{<<"value">>, IP} + ]), + cb_context:add_validation_error(Key, <<"forbidden">>, Message, Context). + +-spec validate_error_not_found(cb_context:context(), kz_term:ne_binary(), non_neg_integer()) -> + cb_context:context(). +validate_error_not_found(Context, IP, Index) -> + Key = <<"ips.", (kz_term:to_binary(Index))/binary>>, + Message = kz_json:from_list( + [{<<"message">>, <<"ip not found">>} + ,{<<"value">>, IP} + ]), + cb_context:add_validation_error(Key, <<"not_found">>, Message, Context). + +-spec maybe_dry_run_assignment(cb_context:context()) -> cb_context:context(). +maybe_dry_run_assignment(Context) -> + ProposedJObjs = cb_context:fetch(Context, 'assign_ips', []), + crossbar_services:maybe_dry_run(Context, [], ProposedJObjs). %%------------------------------------------------------------------------------ %% @doc @@ -353,99 +400,139 @@ error_ip_assigned(Context, IP) -> %%------------------------------------------------------------------------------ -spec assign_ips(cb_context:context()) -> cb_context:context(). assign_ips(Context) -> - ReqData = cb_context:req_data(Context), - {Context1, RespData, AccountIds} = - lists:foldl(fun maybe_assign_ip/2 - ,{Context, [], []} - ,kz_json:get_list_value(<<"ips">>, ReqData, [cb_context:account_id(Context)]) - ), - case cb_context:resp_status(Context1) of - 'success' -> - reconcile_services(lists:usort(AccountIds)), - crossbar_doc:handle_json_success(RespData, Context1); - _ -> Context1 - end. - --spec reconcile_services([kz_term:api_ne_binary()]) -> 'ok'. -reconcile_services(AccountIds) -> - _ = [crossbar_services:reconcile(AccountId) - || AccountId <- AccountIds, - 'undefined' =/= AccountId - ], - 'ok'. - --type assign_acc() :: {cb_context:context(), kz_json:objects(), [kz_term:ne_binary() | 'undefined']}. --spec maybe_assign_ip(kz_term:ne_binary(), assign_acc()) -> assign_acc(). -maybe_assign_ip(IP, {Context, RespData, AccountIds}) -> - AccountId = cb_context:account_id(Context), - case kz_ip:fetch(IP) of - {'ok', JObj} -> maybe_assign_ip(Context, AccountId, JObj, RespData, AccountIds); - {'error', Reason} -> - {crossbar_doc:handle_datamgr_errors(Reason, IP, Context), RespData} - end. - --spec maybe_assign_ip(cb_context:context(), kz_term:ne_binary(), kz_json:object(), kz_json:objects(), [kz_term:ne_binary() | 'undefined']) -> assign_acc(). -maybe_assign_ip(Context, AccountId, IPJObj, RespData, AccountIds) -> - case kz_ip:assign(AccountId, IPJObj) of - {'ok', AssignedIP} -> - {Context - ,[clean_ip(kz_ip:to_json(AssignedIP)) | RespData] - ,[kz_json:get_ne_binary_value(<<"pvt_assigned_to">>, IPJObj) | AccountIds] - }; - {'error', Reason} -> - {cb_context:add_system_error('datastore_fault' - ,kz_json:from_list([{<<"cause">>, Reason}]) - ,Context - ) - ,RespData - ,AccountIds - } - end. + JObjs = cb_context:fetch(Context, 'assign_ips', []), + assign_ips(Context, JObjs). + +-spec assign_ips(cb_context:context(), kz_json:objects()) -> cb_context:context(). +assign_ips(Context, []) -> + _ = crossbar_services:reconcile(cb_context:account_id(Context)), + Context; +assign_ips(Context, [JObj|JObjs]) -> + Context1 = + case kz_ip:assign(cb_context:account_id(Context), JObj) of + {'ok', AssignedJObj} -> + Resp = kz_json:set_value([<<"success">>, kz_doc:id(JObj)] + ,clean_ip(kz_ip:to_json(AssignedJObj)) + ,cb_context:resp_data(Context) + ), + cb_context:set_resp_data(Context, Resp); + {'error', Reason} -> + Message = kz_json:from_list( + [{<<"message">>, Reason}] + ), + Resp = kz_json:set_value([<<"error">>, kz_doc:id(JObj)] + ,Message + ,cb_context:resp_data(Context) + ), + cb_context:set_resp_data(Context, Resp) + end, + assign_ips(Context1, JObjs). %%------------------------------------------------------------------------------ %% @doc %% @end %%------------------------------------------------------------------------------ --spec assign_ip(cb_context:context(), kz_term:ne_binary()) -> cb_context:context(). -assign_ip(Context, IP) -> +-spec validate_release_ips(cb_context:context()) -> cb_context:context(). +validate_release_ips(Context) -> + Resp = kz_json:from_list( + [{<<"success">>, kz_json:new()} + ,{<<"error">>, kz_json:new()} + ] + ), + Setters = [{fun cb_context:set_resp_status/2, 'success'} + ,{fun cb_context:set_resp_data/2, Resp} + ], + Context1 = cb_context:setters(Context, Setters), + cb_context:validate_request_data(<<"ips">>, Context1, fun additional_release_validations/1). + +-spec validate_release_ip(cb_context:context(), path_token()) -> cb_context:context(). +validate_release_ip(Context, IP) -> + ReqData = kz_json:from_list([{<<"ips">>, [IP]}]), + validate_release_ips(cb_context:set_req_data(Context, ReqData)). + +-spec additional_release_validations(cb_context:context()) -> cb_context:context(). +additional_release_validations(Context) -> + IPs = [{IP, kz_ip:fetch(IP)} + || IP <- cb_context:req_value(Context, <<"ips">>, []) + ], + additional_release_validations(Context, IPs, [], 0). + +-spec additional_release_validations(cb_context:context(), kz_term:proplist(), kz_json:objects(), non_neg_integer()) -> + cb_context:context(). +additional_release_validations(Context, [], Release, _Index) -> + cb_context:store(Context, 'release_ips', Release); +additional_release_validations(Context, [{Address, {'ok', JObj}}=IP|IPs], Release, Index) -> AccountId = cb_context:account_id(Context), - case kz_ip:assign(AccountId, IP) of - {'ok', AssignedIP} -> - IPJSON = kz_ip:to_json(AssignedIP), - cb_context:set_resp_data(cb_context:set_resp_status(Context, 'success') - ,clean_ip(IPJSON) - ); - {'error', Reason} -> - cb_context:add_system_error('datastore_fault' - ,kz_json:from_list([{<<"cause">>, Reason}]) - ,Context - ) - end. + case kz_ip:assigned_to(JObj) of + 'undefined' -> + Context1 = validate_error_not_assigned(Context, Address, Index), + additional_release_validations(Context1, IPs, Release, Index + 1); + AccountId -> + additional_release_validations(Context, IPs, [JObj|Release], Index + 1); + _Else -> + Context1 = validate_error_assigned(Context, IP, Index), + additional_assignment_validations(Context1, IPs, Release, Index + 1) + end; +additional_release_validations(Context, [{Address, {'error', 'not_found'}}|IPs], Release, Index) -> + Context1 = validate_error_not_found(Context, Address, Index), + additional_release_validations(Context1, IPs, Release, Index + 1); +additional_release_validations(Context, [{_Address, {'error', Reason}}|_IPs], _Release, _Index) -> + cb_context:add_system_error('datastore_fault' + ,kz_json:from_list([{<<"cause">>, Reason}]) + ,Context + ). + +-spec validate_error_not_assigned(cb_context:context(), kz_term:ne_binary(), non_neg_integer()) -> + cb_context:context(). +validate_error_not_assigned(Context, IP, Index) -> + Key = <<"ips.", (kz_term:to_binary(Index))/binary>>, + Message = kz_json:from_list( + [{<<"message">>, <<"ip not assigned">>} + ,{<<"value">>, IP} + ]), + cb_context:add_validation_error(Key, <<"superfluous">>, Message, Context). %%------------------------------------------------------------------------------ %% @doc %% @end %%------------------------------------------------------------------------------ --spec release_or_delete_ip(cb_context:context(), kz_term:ne_binary(), req_nouns()) -> cb_context:context(). -release_or_delete_ip(Context, IP, [{<<"ips">>, [IP]}]) -> - delete_ip(Context, IP); -release_or_delete_ip(Context, IP, [{<<"ips">>, [IP]}, {<<"accounts">>, [_]}]) -> - release_ip(Context, IP). - --spec release_ip(cb_context:context(), kz_term:ne_binary()) -> cb_context:context(). -release_ip(Context, Id) -> - case kz_ip:release(Id) of - {'ok', IP} -> - IPJSON = kz_ip:to_json(IP), - cb_context:set_resp_data(cb_context:set_resp_status(Context, 'success') - ,clean_ip(IPJSON) - ); - {'error', Reason} -> - crossbar_doc:handle_datamgr_errors(Reason, Id, Context) - end. +-spec release_ips(cb_context:context()) -> cb_context:context(). +release_ips(Context) -> + JObjs = cb_context:fetch(Context, 'release_ips', []), + release_ips(Context, JObjs). + +-spec release_ips(cb_context:context(), kz_json:objects()) -> cb_context:context(). +release_ips(Context, []) -> + _ = crossbar_services:reconcile(cb_context:account_id(Context)), + Context; +release_ips(Context, [JObj|JObjs]) -> + Context1 = + case kz_ip:release(kz_doc:id(JObj)) of + {'ok', ReleasedJObj} -> + Resp = kz_json:set_value([<<"success">>, kz_doc:id(JObj)] + ,clean_ip(kz_ip:to_json(ReleasedJObj)) + ,cb_context:resp_data(Context) + ), + cb_context:set_resp_data(Context, Resp); + {'error', Reason} -> + Message = kz_json:from_list( + [{<<"message">>, Reason}] + ), + Resp = kz_json:set_value([<<"error">>, kz_doc:id(JObj)] + ,Message + ,cb_context:resp_data(Context) + ), + cb_context:set_resp_data(Context, Resp) + end, + release_ips(Context1, JObjs). +%%------------------------------------------------------------------------------ +%% @doc +%% @end +%%------------------------------------------------------------------------------ -spec delete_ip(cb_context:context(), kz_term:ne_binary()) -> cb_context:context(). delete_ip(Context, IP) -> + %% _ = crossbar_services:reconcile(cb_context:account_id(Context)), case kz_ip:delete(IP) of {'ok', Deleted} -> crossbar_doc:handle_json_success(Deleted, Context); {'error', Error} -> crossbar_doc:handle_datamgr_errors(Error, IP, Context) @@ -466,14 +553,3 @@ clean_ip(JObj) -> ,{<<"type">>, kz_doc:type(JObj)} ,{<<"assigned_to">>, kz_json:get_value(<<"pvt_assigned_to">>, JObj)} ]). - --type callback() :: fun(() -> cb_context:context()). --spec maybe_dry_run(cb_context:context(), kz_term:ne_binaries(), callback()) -> cb_context:context(). -maybe_dry_run(Context, IPs, _Callback) -> - ProposedJObjs = [kz_json:from_list([{<<"_id">>, IP} - ,{<<"pvt_type">>, <<"dedicated_ip">>} - ] - ) - || IP <- IPs - ], - crossbar_services:maybe_dry_run(Context, [], ProposedJObjs). diff --git a/core/kazoo_documents/src/kzd_ip.erl b/core/kazoo_documents/src/kzd_ip.erl new file mode 100644 index 00000000000..49817bc5b99 --- /dev/null +++ b/core/kazoo_documents/src/kzd_ip.erl @@ -0,0 +1,59 @@ +%%%----------------------------------------------------------------------------- +%%% @copyright (C) 2010-2019, 2600Hz +%%% @doc Accessors for `ip' document. +%%% @end +%%%----------------------------------------------------------------------------- +-module(kzd_ip). + +-export([new/0]). +-export([host/1, host/2, set_host/2]). +-export([ip/1, ip/2, set_ip/2]). +-export([zone/1, zone/2, set_zone/2]). + + +-include("kz_documents.hrl"). + +-type doc() :: kz_json:object(). +-export_type([doc/0]). + +-define(SCHEMA, <<"ip">>). + +-spec new() -> doc(). +new() -> + kz_json_schema:default_object(?SCHEMA). + +-spec host(doc()) -> kz_term:api_ne_binary(). +host(Doc) -> + host(Doc, 'undefined'). + +-spec host(doc(), Default) -> kz_term:ne_binary() | Default. +host(Doc, Default) -> + kz_json:get_ne_binary_value([<<"host">>], Doc, Default). + +-spec set_host(doc(), kz_term:ne_binary()) -> doc(). +set_host(Doc, Host) -> + kz_json:set_value([<<"host">>], Host, Doc). + +-spec ip(doc()) -> any(). +ip(Doc) -> + ip(Doc, 'undefined'). + +-spec ip(doc(), Default) -> any() | Default. +ip(Doc, Default) -> + kz_json:get_value([<<"ip">>], Doc, Default). + +-spec set_ip(doc(), any()) -> doc(). +set_ip(Doc, Ip) -> + kz_json:set_value([<<"ip">>], Ip, Doc). + +-spec zone(doc()) -> kz_term:api_ne_binary(). +zone(Doc) -> + zone(Doc, 'undefined'). + +-spec zone(doc(), Default) -> kz_term:ne_binary() | Default. +zone(Doc, Default) -> + kz_json:get_ne_binary_value([<<"zone">>], Doc, Default). + +-spec set_zone(doc(), kz_term:ne_binary()) -> doc(). +set_zone(Doc, Zone) -> + kz_json:set_value([<<"zone">>], Zone, Doc). diff --git a/core/kazoo_documents/src/kzd_ip.erl.src b/core/kazoo_documents/src/kzd_ip.erl.src new file mode 100644 index 00000000000..49817bc5b99 --- /dev/null +++ b/core/kazoo_documents/src/kzd_ip.erl.src @@ -0,0 +1,59 @@ +%%%----------------------------------------------------------------------------- +%%% @copyright (C) 2010-2019, 2600Hz +%%% @doc Accessors for `ip' document. +%%% @end +%%%----------------------------------------------------------------------------- +-module(kzd_ip). + +-export([new/0]). +-export([host/1, host/2, set_host/2]). +-export([ip/1, ip/2, set_ip/2]). +-export([zone/1, zone/2, set_zone/2]). + + +-include("kz_documents.hrl"). + +-type doc() :: kz_json:object(). +-export_type([doc/0]). + +-define(SCHEMA, <<"ip">>). + +-spec new() -> doc(). +new() -> + kz_json_schema:default_object(?SCHEMA). + +-spec host(doc()) -> kz_term:api_ne_binary(). +host(Doc) -> + host(Doc, 'undefined'). + +-spec host(doc(), Default) -> kz_term:ne_binary() | Default. +host(Doc, Default) -> + kz_json:get_ne_binary_value([<<"host">>], Doc, Default). + +-spec set_host(doc(), kz_term:ne_binary()) -> doc(). +set_host(Doc, Host) -> + kz_json:set_value([<<"host">>], Host, Doc). + +-spec ip(doc()) -> any(). +ip(Doc) -> + ip(Doc, 'undefined'). + +-spec ip(doc(), Default) -> any() | Default. +ip(Doc, Default) -> + kz_json:get_value([<<"ip">>], Doc, Default). + +-spec set_ip(doc(), any()) -> doc(). +set_ip(Doc, Ip) -> + kz_json:set_value([<<"ip">>], Ip, Doc). + +-spec zone(doc()) -> kz_term:api_ne_binary(). +zone(Doc) -> + zone(Doc, 'undefined'). + +-spec zone(doc(), Default) -> kz_term:ne_binary() | Default. +zone(Doc, Default) -> + kz_json:get_ne_binary_value([<<"zone">>], Doc, Default). + +-spec set_zone(doc(), kz_term:ne_binary()) -> doc(). +set_zone(Doc, Zone) -> + kz_json:set_value([<<"zone">>], Zone, Doc). diff --git a/core/kazoo_documents/src/kzd_ips.erl.src b/core/kazoo_documents/src/kzd_ips.erl.src index 2853b754f02..a26244ac9d1 100644 --- a/core/kazoo_documents/src/kzd_ips.erl.src +++ b/core/kazoo_documents/src/kzd_ips.erl.src @@ -20,14 +20,14 @@ new() -> kz_json_schema:default_object(?SCHEMA). --spec ips(doc()) -> kz_term:api_ne_binaries(). +-spec ips(doc()) -> kz_term:api_list(). ips(Doc) -> ips(Doc, 'undefined'). --spec ips(doc(), Default) -> kz_term:ne_binaries() | Default. +-spec ips(doc(), Default) -> list() | Default. ips(Doc, Default) -> kz_json:get_list_value([<<"ips">>], Doc, Default). --spec set_ips(doc(), kz_term:ne_binaries()) -> doc(). +-spec set_ips(doc(), list()) -> doc(). set_ips(Doc, Ips) -> kz_json:set_value([<<"ips">>], Ips, Doc). diff --git a/core/kazoo_ips/src/kz_ip.erl b/core/kazoo_ips/src/kz_ip.erl index 294cc0fbd1b..d210328cdc4 100644 --- a/core/kazoo_ips/src/kz_ip.erl +++ b/core/kazoo_ips/src/kz_ip.erl @@ -115,15 +115,30 @@ assign(Account, IPDoc) -> ,{<<"pvt_status">>, ?ASSIGNED} ], JObj = kz_json:set_values(Props, IPJObj), - maybe_save_in_account(AccountId, JObj, save(JObj)) + maybe_save_in_account(AccountId, save(JObj)) end. --spec maybe_save_in_account(kz_term:ne_binary(), kz_json:object(), std_return()) -> std_return(). -maybe_save_in_account(AccountId, JObj, {'ok', _}=Ok) -> +-spec maybe_save_in_account(kz_term:ne_binary(), std_return()) -> std_return(). +maybe_save_in_account(AccountId, {'ok', JObj}=Ok) -> AccountDb = kz_util:format_account_db(AccountId), - _ = kz_datamgr:ensure_saved(AccountDb, JObj), - Ok; -maybe_save_in_account(_, _, Return) -> Return. + case kz_datamgr:open_doc(AccountDb, kz_doc:id(JObj)) of + {'error', 'not_found'} -> + _ = kz_datamgr:save_doc(AccountDb, kz_doc:delete_revision(JObj)), + Ok; + {'error', _R}=E -> + lager:info("failed to save ip doc to accounts: ~p", [_R]), + E; + {'ok', CurrentJObj} -> + Update = [{kz_doc:path_revision(), kz_doc:revision(CurrentJObj)} + | kz_json:to_proplist(JObj) + ], + UpdateOptions = [{'update', Update} + ,{'ensure_saved', 'true'} + ], + _ = kz_datamgr:update_doc(AccountDb, kz_doc:id(JObj), UpdateOptions), + Ok + end; +maybe_save_in_account(_, Return) -> Return. %%------------------------------------------------------------------------------ %% @doc diff --git a/core/kazoo_schemas/src/kz_json_schema.erl b/core/kazoo_schemas/src/kz_json_schema.erl index 1afebbcb581..6aa783bfc0f 100644 --- a/core/kazoo_schemas/src/kz_json_schema.erl +++ b/core/kazoo_schemas/src/kz_json_schema.erl @@ -853,6 +853,8 @@ validation_error(Property, <<"disabled">> = C, Message, Options) -> validation_error(Property, <<"expired">> = C, Message, Options) -> depreciated_validation_error(Property, C, Message, Options); %% Generic +validation_error(Property, <<"superfluous">> = C, Message, Options) -> + depreciated_validation_error(Property, C, Message, Options); validation_error(Property, <<"invalid">> = C, Message, Options) -> depreciated_validation_error(Property, C, Message, Options); validation_error(Property, <<"schema">> = C, Message, Options) ->