7745de1825
Fix lookup by product (object) in the webservice git-svn-id: svn://10.0.0.236/trunk@250995 18797224-902f-48f8-a5cc-f745e15eee43
278 lines
8.7 KiB
Perl
278 lines
8.7 KiB
Perl
# -*- Mode: perl; indent-tabs-mode: nil -*-
|
|
#
|
|
# The contents of this file are subject to the Mozilla Public
|
|
# License Version 1.1 (the "License"); you may not use this file
|
|
# except in compliance with the License. You may obtain a copy of
|
|
# the License at http://www.mozilla.org/MPL/
|
|
#
|
|
# Software distributed under the License is distributed on an "AS
|
|
# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
# implied. See the License for the specific language governing
|
|
# rights and limitations under the License.
|
|
#
|
|
# The Original Code is the Bugzilla Testopia System.
|
|
#
|
|
# The Initial Developer of the Original Code is Greg Hendricks.
|
|
# Portions created by Greg Hendricks are Copyright (C) 2006
|
|
# Novell. All Rights Reserved.
|
|
#
|
|
# Contributor(s): Dallas Harken <dharken@novell.com>
|
|
# Greg Hendricks <ghendricks@novell.com>
|
|
|
|
package Bugzilla::WebService::Testopia::Environment;
|
|
|
|
use strict;
|
|
|
|
use base qw(Bugzilla::WebService);
|
|
|
|
use Bugzilla::Constants;
|
|
use Bugzilla::Error;
|
|
use Bugzilla::Testopia::Environment;
|
|
use Bugzilla::Testopia::Search;
|
|
use Bugzilla::Testopia::Table;
|
|
|
|
sub get {
|
|
my $self = shift;
|
|
my ($environment_id) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
my $environment = new Bugzilla::Testopia::Environment($environment_id);
|
|
|
|
ThrowUserError('invalid-test-id-non-existent', {type => 'Environment', id => $environment_id}) unless $environment;
|
|
ThrowUserError('testopia-read-only', {'object' => $environment}) unless $environment->canview;
|
|
|
|
#Result is a environment hash map
|
|
return $environment;
|
|
}
|
|
|
|
sub check_environment {
|
|
my $self = shift;
|
|
my ($name, $product) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
if (ref $product){
|
|
$product = Bugzilla::Testopia::Product->new($product->{id});
|
|
}
|
|
elsif ($product =~ /^\d+$/){
|
|
$product = Bugzilla::Testopia::Product->new($product);
|
|
}
|
|
else {
|
|
$product = Bugzilla::Product::check_product($product);
|
|
$product = Bugzilla::Testopia::Product->new($product->id);
|
|
}
|
|
|
|
ThrowUserError('testopia-read-only', {'object' => $product}) unless $product->canedit;
|
|
|
|
return Bugzilla::Testopia::Environment::check_environment($name, $product);
|
|
}
|
|
|
|
sub list {
|
|
my $self = shift;
|
|
my ($query) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
my $cgi = Bugzilla->cgi;
|
|
$cgi->param("current_tab", "environment");
|
|
foreach (keys(%$query)){
|
|
$cgi->param($_, $query->{$_});
|
|
}
|
|
|
|
my $search = Bugzilla::Testopia::Search->new($cgi);
|
|
|
|
# Result is an array of environment hash maps
|
|
return Bugzilla::Testopia::Table->new('environment', 'tr_xmlrpc.cgi',$cgi,undef, $search->query())->list();
|
|
|
|
}
|
|
|
|
sub create {
|
|
my $self = shift;
|
|
my ($new_values) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
# Setup field name aliasing
|
|
$new_values->{'product_id'} ||= $new_values->{'product'};
|
|
delete $new_values->{'product'};
|
|
|
|
my $product = Bugzilla::Testopia::Product->new($new_values->{'product_id'});
|
|
ThrowUserError('testopia-read-only', {'object' => $product}) unless $product->canedit;
|
|
|
|
if (! defined $new_values->{'isactive'}){
|
|
$new_values->{'isactive'} = 1;
|
|
}
|
|
|
|
my $environment = Bugzilla::Testopia::Environment->create($new_values);
|
|
|
|
# Result is new environment
|
|
return $environment;
|
|
}
|
|
|
|
sub update {
|
|
my $self = shift;
|
|
my ($environment_id, $new_values) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
my $environment = new Bugzilla::Testopia::Environment($environment_id);
|
|
|
|
ThrowUserError('invalid-test-id-non-existent', {type => 'Environment', id => $environment_id}) unless $environment;
|
|
ThrowUserError('testopia-read-only', {'object' => $environment}) unless $environment->canedit;
|
|
|
|
$environment->set_name($new_values->{'name'}) if $new_values->{'name'};
|
|
$environment->set_isactive($new_values->{'isactive'} =~ /(true|1|yes)/i ? 1 : 0) if defined $new_values->{'isactive'};
|
|
|
|
$environment->update();
|
|
|
|
# Result is modified environment, otherwise an exception will be thrown
|
|
return $environment;
|
|
}
|
|
|
|
sub get_runs {
|
|
my $self = shift;
|
|
my ($environment_id) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
my $environment = new Bugzilla::Testopia::Environment($environment_id);
|
|
|
|
ThrowUserError('invalid-test-id-non-existent', {type => 'Environment', id => $environment_id}) unless $environment;
|
|
ThrowUserError('testopia-read-only', {'object' => $environment}) unless $environment->canview;
|
|
|
|
# Result is list of test runs for the given environment
|
|
return $environment->runs();
|
|
}
|
|
|
|
sub get_caseruns {
|
|
my $self = shift;
|
|
my ($environment_id) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
my $environment = new Bugzilla::Testopia::Environment($environment_id);
|
|
|
|
ThrowUserError('invalid-test-id-non-existent', {type => 'Environment', id => $environment_id}) unless $environment;
|
|
ThrowUserError('testopia-read-only', {'object' => $environment}) unless $environment->canview;
|
|
|
|
# Result is list of test runs for the given environment
|
|
return $environment->caseruns();
|
|
}
|
|
|
|
1;
|
|
__END__
|
|
|
|
=head1 NAME
|
|
|
|
Bugzilla::Testopia::Webservice::Environment
|
|
|
|
=head1 EXTENDS
|
|
|
|
Bugzilla::Webservice
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Provides methods for automated scripts to manipulate Testopia Environments
|
|
|
|
=head1 METHODS
|
|
|
|
=over
|
|
|
|
=item C<check_environment($name, $product)>
|
|
|
|
Description: Looks up and returns an environment by name.
|
|
|
|
Params: $name - String: name of the environment.
|
|
$product - Integer/String/Object
|
|
Integer: product_id of the product in the Database
|
|
String: Product name
|
|
Object: Blessed Bugzilla::Product object
|
|
|
|
Returns: Hash: Matching Environment object hash or error if not found.
|
|
|
|
=item C<create($values)>
|
|
|
|
Description: Creates a new environment object and stores it in the database
|
|
|
|
Params: $values - Hash: A reference to a hash with keys and values
|
|
matching the fields of the environment to be created.
|
|
+-------------+----------------+-----------+------------------------------------+
|
|
| Field | Type | Null | Description |
|
|
+-------------+----------------+-----------+------------------------------------+
|
|
| product_id | Integer/String | Required | ID or Name of product |
|
|
| name | String | Required | |
|
|
| isactive | Boolean | Optional | Defaults to True (1) |
|
|
+-------------+----------------+-----------+------------------------------------+
|
|
|
|
Returns: The newly created object hash.
|
|
|
|
=item C<get($id)>
|
|
|
|
Description: Used to load an existing Environment from the database.
|
|
|
|
Params: $id - An integer representing the ID in the database
|
|
|
|
Returns: A blessed Bugzilla::Testopia::Environment object hash
|
|
|
|
=item C<get_caseruns($id)>
|
|
|
|
Description: Returns the list of case-runs that this Environment is used in.
|
|
|
|
Params: $id - Integer: Environment ID.
|
|
|
|
Returns: Array: List of case-run object hashes.
|
|
|
|
=item C<get_runs($id)>
|
|
|
|
Description: Returns the list of runs that this Environment is used in.
|
|
|
|
Params: $id - Integer: Environment ID.
|
|
|
|
Returns: Array: List of run object hashes.
|
|
|
|
=item C<list($query)>
|
|
|
|
Description: Performs a search and returns the resulting list of Environments
|
|
|
|
Params: $query - Hash: keys must match valid search fields.
|
|
|
|
+--------------------------+
|
|
| classification |
|
|
| env_products |
|
|
| env_categories |
|
|
| env_elements |
|
|
| env_properties |
|
|
| env_expressions |
|
|
| name |
|
|
| env_value_selected_type |
|
|
+--------------------------+
|
|
|
|
Returns: Array: Matching Environments are retuned in a list of hashes.
|
|
|
|
=item C<update($ids, $values)>
|
|
|
|
Description: Updates the fields of the selected environment or environments.
|
|
|
|
Params: $ids - Integer A single environment ID.
|
|
|
|
$values - Hash of keys matching Environment fields and the new values
|
|
to set each field to.
|
|
+-------------+----------------+
|
|
| Field | Type |
|
|
+-------------+----------------+
|
|
| name | String |
|
|
| isactive | Boolean |
|
|
+-------------+----------------+
|
|
|
|
Returns: Hash: The updated environment object hash.
|
|
|
|
=back
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<Bugzilla::Testopia::Environment>
|
|
L<Bugzilla::Webservice>
|
|
|
|
=head1 AUTHOR
|
|
|
|
Greg Hendricks <ghendricks@novell.com> |