MT#5299 API: add first tests for billing profiles.

lib/NGCP/Panel/Role/API.pm

@@ -109,6 +109,7 @@ sub validate_form {
     if($run) {
         # check keys/vals
         my $result = $form->run(params => $resource);
+        use Data::Printer; p $result; p $result->error_results;
         if ($result->error_results->size) {
             my $f = $result->error_results->[0];
             my $e = $result->error_results->map(sub {

lib/NGCP/Panel/Role/API/BillingProfiles.pm

@@ -16,6 +16,10 @@ sub hal_from_profile {
 
     my %resource = $profile->get_inflated_columns;
 
+    # TODO: we should return the fees in an embedded field,
+    # if the structure is returned for one single item
+    # (make it a method flag)
+
     my $hal = Data::HAL->new(
         links => [
             Data::HAL::Link->new(

t/api-billingprofiles.t

@@ -0,0 +1,306 @@
+use Sipwise::Base;
+use Net::Domain qw(hostfqdn);
+use LWP::UserAgent;
+use JSON qw();
+use Test::More;
+
+my $uri = $ENV{CATALYST_SERVER} || ('https://'.hostfqdn.':4443');
+
+my $valid_ssl_client_cert = $ENV{API_SSL_CLIENT_CERT} || 
+    "/etc/ssl/ngcp/api/NGCP-API-client-certificate.pem";
+my $valid_ssl_client_key = $ENV{API_SSL_CLIENT_KEY} ||
+    $valid_ssl_client_cert;
+my $ssl_ca_cert = $ENV{API_SSL_CA_CERT} || "/etc/ssl/ngcp/api/ca-cert.pem";
+
+my ($ua, $req, $res);
+$ua = LWP::UserAgent->new;
+
+$ua->ssl_opts(
+    SSL_cert_file => $valid_ssl_client_cert,
+    SSL_key_file  => $valid_ssl_client_key,
+    SSL_ca_file   => $ssl_ca_cert,
+);
+
+# OPTIONS tests
+{
+    $req = HTTP::Request->new('OPTIONS', $uri.'/api/billingprofiles/');
+    $res = $ua->request($req);
+    ok($res->code == 200, "check options request");
+    ok($res->header('Accept-Post') eq "application/hal+json; profile=http://purl.org/sipwise/ngcp-api/#rel-billingprofiles", "check Accept-Post header in options response");
+    my $opts = JSON::from_json($res->decoded_content);
+    my @hopts = split /\s*,\s*/, $res->header('Allow');
+    ok(exists $opts->{methods} && ref $opts->{methods} eq "ARRAY", "check for valid 'methods' in body");
+    foreach my $opt(qw( GET HEAD OPTIONS POST )) {
+        ok(grep(/^$opt$/, @hopts), "check for existence of '$opt' in Allow header");
+        ok(grep(/^$opt$/, @{ $opts->{methods} }), "check for existence of '$opt' in body");
+    }
+}
+
+my $reseller_id = 1;
+
+# collection test
+my $firstprofile = undef;
+my @allprofiles = ();
+{
+    # create 6 new billing profiles
+    my %profiles = ();
+    for(my $i = 1; $i <= 6; ++$i) {
+        $req = HTTP::Request->new('POST', $uri.'/api/billingprofiles/');
+        $req->header('Content-Type' => 'application/json');
+        $req->content(JSON::to_json({
+            reseller_id => $reseller_id,
+            handle => "testapihandle$i",
+            name => "test api name $i",
+        }));
+        $res = $ua->request($req);
+        ok($res->code == 201, "create test billing profile $i");
+        $profiles{$res->header('Location')} = 1;
+        push @allprofiles, $res->header('Location');
+        $firstprofile = $res->header('Location') unless $firstprofile;
+    }
+
+    # try to create profile without reseller_id
+    $req = HTTP::Request->new('POST', $uri.'/api/billingprofiles/');
+    $req->header('Content-Type' => 'application/json');
+    $req->content(JSON::to_json({
+        handle => "testapihandle",
+        name => "test api name",
+    }));
+    $res = $ua->request($req);
+    ok($res->code == 422, "create profile without reseller_id");
+    my $err = JSON::from_json($res->decoded_content);
+    ok($err->{code} eq "422", "check error code in body");
+    ok($err->{message} =~ /field='reseller_id'/, "check error message in body");
+
+    # try to create profile with empty reseller_id
+    $req->content(JSON::to_json({
+        handle => "testapihandle",
+        name => "test api name",
+        reseller_id => undef,
+    }));
+    $res = $ua->request($req);
+    ok($res->code == 422, "create profile with empty reseller_id");
+    $err = JSON::from_json($res->decoded_content);
+    ok($err->{code} eq "422", "check error code in body");
+    ok($err->{message} =~ /field='reseller_id'/, "check error message in body");
+
+    # try to create profile with invalid reseller_id
+    $req->content(JSON::to_json({
+        handle => "testapihandle",
+        name => "test api name",
+        reseller_id => 99999,
+    }));
+    $res = $ua->request($req);
+    ok($res->code == 422, "create profile with invalid reseller_id");
+    $err = JSON::from_json($res->decoded_content);
+    ok($err->{code} eq "422", "check error code in body");
+    ok($err->{message} =~ /Invalid 'reseller_id'/, "check error message in body");
+
+=pod
+    # try to create invalid contract with wrong billing profile
+    $req->content(JSON::to_json({
+        status => "active",
+        contact_id => $syscontact->{id},
+        type => "reseller",
+        billing_profile_id => 999999,
+    }));
+    $res = $ua->request($req);
+    ok($res->code == 422, "create contract with invalid billing profile");
+    $err = JSON::from_json($res->decoded_content);
+    ok($err->{code} eq "422", "check error code in body");
+    ok($err->{message} =~ /Invalid 'billing_profile_id'/, "check error message in body");
+
+    # try to create invalid contract with customercontact
+    $req->content(JSON::to_json({
+        status => "active",
+        type => "reseller",
+        billing_profile_id => $billing_profile_id,
+        contact_id => $customer_contact_id,
+    }));
+    $res = $ua->request($req);
+    ok($res->code == 422, "create contract with invalid contact");
+    $err = JSON::from_json($res->decoded_content);
+    ok($err->{code} eq "422", "check error code in body");
+    ok($err->{message} =~ /The contact_id is not a valid ngcp:systemcontacts item/, "check error message in body");
+
+    # try to create invalid contract with invalid status
+    $req->content(JSON::to_json({
+        type => "reseller",
+        billing_profile_id => $billing_profile_id,
+        contact_id => $syscontact->{id},
+        status => "invalid",
+    }));
+    $res = $ua->request($req);
+    ok($res->code == 422, "create contract with invalid status");
+    $err = JSON::from_json($res->decoded_content);
+    ok($err->{code} eq "422", "check error code in body");
+    ok($err->{message} =~ /field='status'/, "check error message in body");
+=cut
+
+    # iterate over contracts collection to check next/prev links and status
+    my $nexturi = $uri.'/api/billingprofiles/?page=1&rows=5';
+    do {
+        $res = $ua->get($nexturi);
+        ok($res->code == 200, "fetch contacts page");
+        my $collection = JSON::from_json($res->decoded_content);
+        my $selfuri = $uri . $collection->{_links}->{self}->{href};
+        ok($selfuri eq $nexturi, "check _links.self.href of collection");
+        my $colluri = URI->new($selfuri);
+
+        ok($collection->{total_count} > 0, "check 'total_count' of collection");
+
+        my %q = $colluri->query_form;
+        ok(exists $q{page} && exists $q{rows}, "check existence of 'page' and 'row' in 'self'");
+        my $page = int($q{page});
+        my $rows = int($q{rows});
+        if($page == 1) {
+            ok(!exists $collection->{_links}->{prev}->{href}, "check absence of 'prev' on first page");
+        } else {
+            ok(exists $collection->{_links}->{prev}->{href}, "check existence of 'prev'");
+        }
+        if(($collection->{total_count} / $rows) <= $page) {
+            ok(!exists $collection->{_links}->{next}->{href}, "check absence of 'next' on last page");
+        } else {
+            ok(exists $collection->{_links}->{next}->{href}, "check existence of 'next'");
+        }
+
+        if($collection->{_links}->{next}->{href}) {
+            $nexturi = $uri . $collection->{_links}->{next}->{href};
+        } else {
+            $nexturi = undef;
+        }
+
+        # TODO: I'd expect that to be an array ref in any case!
+        ok((ref $collection->{_links}->{'ngcp:billingprofiles'} eq "ARRAY" ||
+            ref $collection->{_links}->{'ngcp:billingprofiles'} eq "HASH"), "check if 'ngcp:billingprofiles' is array/hash-ref");
+
+        # remove any entry we find in the collection for later check
+        if(ref $collection->{_links}->{'ngcp:billingprofiles'} eq "HASH") {
+            # TODO: check any refs we might have
+            #ok(exists $collection->{_embedded}->{'ngcp:contracts'}->{_links}->{'ngcp:contractbalances'}, "check presence of ngcp:contractbalances relation");
+            delete $profiles{$collection->{_links}->{'ngcp:billingprofiles'}->{href}};
+        } else {
+            foreach my $c(@{ $collection->{_links}->{'ngcp:billingprofiles'} }) {
+                delete $profiles{$c->{href}};
+            }
+            foreach my $c(@{ $collection->{_embedded}->{'ngcp:billingprofiles'} }) {
+            # TODO: check any refs we might have
+                #ok(exists $c->{_links}->{'ngcp:contractbalances'}, "check presence of ngcp:contractbalances relation");
+
+                delete $profiles{$c->{_links}->{self}->{href}};
+            }
+        }
+             
+    } while($nexturi);
+
+    ok(keys %profiles == 0, "check if all test billing profiles have been found");
+}
+
+# test profile item
+{
+    $req = HTTP::Request->new('OPTIONS', $uri.'/'.$firstprofile);
+    $res = $ua->request($req);
+    ok($res->code == 200, "check options on item");
+    my @hopts = split /\s*,\s*/, $res->header('Allow');
+    my $opts = JSON::from_json($res->decoded_content);
+    ok(exists $opts->{methods} && ref $opts->{methods} eq "ARRAY", "check for valid 'methods' in body");
+    foreach my $opt(qw( GET HEAD OPTIONS PUT PATCH )) {
+        ok(grep(/^$opt$/, @hopts), "check for existence of '$opt' in Allow header");
+        ok(grep(/^$opt$/, @{ $opts->{methods} }), "check for existence of '$opt' in body");
+    }
+    foreach my $opt(qw( POST DELETE )) {
+        ok(!grep(/^$opt$/, @hopts), "check for absence of '$opt' in Allow header");
+        ok(!grep(/^$opt$/, @{ $opts->{methods} }), "check for absence of '$opt' in body");
+    }
+
+    $req = HTTP::Request->new('GET', $uri.'/'.$firstprofile);
+    $res = $ua->request($req);
+    ok($res->code == 200, "fetch one contract item");
+    my $profile = JSON::from_json($res->decoded_content);
+    ok(exists $profile->{reseller_id} && $profile->{reseller_id}->is_int, "check existence of reseller_id");
+    ok(exists $profile->{handle}, "check existence of handle");
+    ok(exists $profile->{name}, "check existence of name");
+    
+    # PUT same result again
+    my $old_profile = { %$profile };
+    delete $profile->{_links};
+    delete $profile->{_embedded};
+    $req = HTTP::Request->new('PUT', $uri.'/'.$firstprofile);
+    
+    # check if it fails without content type
+    $req->remove_header('Content-Type');
+    $req->header('Prefer' => "return=minimal");
+    $res = $ua->request($req);
+    ok($res->code == 415, "check put missing content type");
+
+    # check if it fails with unsupported content type
+    $req->header('Content-Type' => 'application/xxx');
+    $res = $ua->request($req);
+    ok($res->code == 415, "check put invalid content type");
+
+    $req->remove_header('Content-Type');
+    $req->header('Content-Type' => 'application/json');
+
+    # check if it fails with missing Prefer
+    $req->remove_header('Prefer');
+    $res = $ua->request($req);
+    ok($res->code == 400, "check put missing prefer");
+
+    # check if it fails with invalid Prefer
+    $req->header('Prefer' => "return=invalid");
+    $res = $ua->request($req);
+    ok($res->code == 400, "check put invalid prefer");
+
+
+    $req->remove_header('Prefer');
+    $req->header('Prefer' => "return=representation");
+
+    # check if it fails with missing body
+    $res = $ua->request($req);
+    ok($res->code == 400, "check put no body");
+
+    # check if put is ok
+    $req->content(JSON::to_json($profile));
+    $res = $ua->request($req);
+    ok($res->code == 200, "check put successful");
+
+    my $new_profile = JSON::from_json($res->decoded_content);
+    is_deeply($old_profile, $new_profile, "check put if unmodified put returns the same");
+
+    # check if we have the proper links
+    # TODO: fees, reseller links
+    #ok(exists $new_contract->{_links}->{'ngcp:resellers'}, "check put presence of ngcp:resellers relation");
+
+    $req = HTTP::Request->new('PATCH', $uri.'/'.$firstprofile);
+    $req->header('Prefer' => 'return=representation');
+    $req->header('Content-Type' => 'application/json-patch+json');
+
+    $req->content(JSON::to_json(
+        [ { op => 'replace', path => '/name', value => 'patched name' } ]
+    ));
+    $res = $ua->request($req);
+    ok($res->code == 200, "check patched profile item");
+    my $mod_profile = JSON::from_json($res->decoded_content);
+    ok($mod_profile->{name} eq "patched name", "check patched replace op");
+    ok($mod_profile->{_links}->{self}->{href} eq $firstprofile, "check patched self link");
+    ok($mod_profile->{_links}->{collection}->{href} eq '/api/billingprofiles/', "check patched collection link");
+    
+
+    $req->content(JSON::to_json(
+        [ { op => 'replace', path => '/reseller_id', value => undef } ]
+    ));
+    $res = $ua->request($req);
+    ok($res->code == 422, "check patched undef reseller");
+
+    $req->content(JSON::to_json(
+        [ { op => 'replace', path => '/reseller_id', value => 99999 } ]
+    ));
+    $res = $ua->request($req);
+    ok($res->code == 422, "check patched invalid reseller");
+
+    # TODO: invalid handle etc
+}
+
+done_testing;
+
+# vim: set tabstop=4 expandtab:

t/api-contracts.t

@@ -122,6 +122,15 @@ my @allcontracts = ();
     $err = JSON::from_json($res->decoded_content);
     ok($err->{code} eq "422", "check error code in body");
     ok($err->{message} =~ /The contact_id is not a valid ngcp:systemcontacts item/, "check error message in body");
+    
+    # try to create invalid contract without contact
+    $req->content(JSON::to_json({
+        status => "active",
+        type => "reseller",
+        billing_profile_id => $billing_profile_id,
+    }));
+    $res = $ua->request($req);
+    ok($res->code == 422, "create contract without contact");
 
     # try to create invalid contract with invalid status
     $req->content(JSON::to_json({