254 lines
7.8 KiB
Perl
254 lines
7.8 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::Build;
|
|
|
|
use strict;
|
|
|
|
use base qw(Bugzilla::WebService);
|
|
|
|
use Bugzilla::Constants;
|
|
use Bugzilla::Testopia::Build;
|
|
|
|
sub get {
|
|
my $self = shift;
|
|
my ($build_id) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
# Result is a build object hash
|
|
my $build = new Bugzilla::Testopia::Build($build_id);
|
|
|
|
ThrowUserError('invalid-test-id-non-existent', {type => 'Build', id => $build_id}) unless $build;
|
|
ThrowUserError('testopia-read-only', {'object' => $build->product}) unless $build->product->canedit;
|
|
|
|
$build->run_count();
|
|
|
|
return $build;
|
|
}
|
|
|
|
sub check_build {
|
|
my ($name, $product) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
if (ref $product){
|
|
$product = $product;
|
|
}
|
|
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::Build->new(Bugzilla::Testopia::Build::check_build($name, $product));
|
|
}
|
|
|
|
sub create{
|
|
my $self = shift;
|
|
my ($new_values) = @_; # Required: name, product_id
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
my $product = Bugzilla::Testopia::Product->new($new_values->{'product_id'});
|
|
ThrowUserError('testopia-read-only', {'object' => $product}) unless $product->canedit;
|
|
|
|
$new_values->{'milestone'} ||= '---';
|
|
|
|
my $build = Bugzilla::Testopia::Build->create($new_values);
|
|
|
|
# Result is new build
|
|
return $build;
|
|
}
|
|
|
|
sub update{
|
|
my $self = shift;
|
|
my ($ids, $new_values) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
my @ids;
|
|
if (ref $ids eq 'ARRAY'){
|
|
@ids = @$ids;
|
|
}
|
|
elsif ($ids =~ /,/){
|
|
@ids = split(/[\s,]+/, $ids);
|
|
}
|
|
else {
|
|
push @ids, $ids;
|
|
}
|
|
|
|
my @builds;
|
|
foreach my $id (@ids){
|
|
my $build = new Bugzilla::Testopia::Build($id);
|
|
unless ($build){
|
|
ThrowUserError("invalid-test-id-non-existent", {'id' => $id, 'type' => 'Build'}) if scalar @ids == 1;
|
|
push @builds, {FAILED => 1, message => "Build $id does not exist"};
|
|
next;
|
|
}
|
|
unless ($build->product->canedit){
|
|
ThrowUserError('testopia-read-only', {'object' => $product}) if scalar @ids == 1;
|
|
push @builds, {FAILED => 1, message => "You do not have rights to view this product"};
|
|
next;
|
|
}
|
|
if (exists $new_values->{'name'}){
|
|
check_build($new_values->{'name'}, $build->product) if scalar @ids == 1;
|
|
eval {check_build($new_values->{'name'}, $build->product)};
|
|
if ($@){
|
|
push @builds, {FAILED => 1, message => "A Build named " . $new_values->{'name'} . " already exists in the selected product."};
|
|
next;
|
|
}
|
|
}
|
|
if (exists $new_values->{'milestone'}){
|
|
Bugzilla::Milestone::check_milestone($build->product, $new_values->{'milestone'}) if scalar @ids == 1;
|
|
eval {Bugzilla::Milestone::check_milestone($build->product, $new_values->{'milestone'})};
|
|
if ($@){
|
|
push @builds, {FAILED => 1, message => "Invalid milestone"};
|
|
next;
|
|
}
|
|
}
|
|
|
|
$build->set_name($new_values->{'name'}) if $new_values->{'name'};
|
|
$build->set_description($new_values->{'description'}) if exists $new_values->{'description'};
|
|
$build->set_milestone($new_values->{'milestone'}) if $new_values->{'milestone'};
|
|
$build->set_isactive($new_values->{'isactive'} =~ /(true|1|yes)/i ? 1 : 0) if exists $new_values->{'isactive'};
|
|
|
|
$build->update;
|
|
return $build if scalar @ids == 1;
|
|
}
|
|
|
|
return @builds;
|
|
}
|
|
|
|
# DEPRECATED use Build::get instead
|
|
sub lookup_name_by_id {
|
|
my $self = shift;
|
|
my ($build_id) = @_;
|
|
|
|
Bugzilla->login(LOGIN_REQUIRED);
|
|
|
|
die "Invalid Build ID"
|
|
unless defined $build_id && length($build_id) > 0 && $build_id > 0;
|
|
|
|
my $build = new Bugzilla::Testopia::Build($build_id);
|
|
ThrowUserError('testopia-read-only', {'object' => $build->product}) unless $build->product->canedit;
|
|
|
|
my $result = defined $build ? $build->name : '';
|
|
|
|
# Result is build name string or empty string if failed
|
|
return $result;
|
|
}
|
|
|
|
# DEPRECATED use Build::check_build($name, $product) instead
|
|
sub lookup_id_by_name {
|
|
return { FAILED => 1, message => 'This method is considered harmful and has been depricated. Please use Build::check_build instead'};
|
|
}
|
|
|
|
1;
|
|
|
|
__END__
|
|
|
|
=head1 NAME
|
|
|
|
Bugzilla::Testopia::Webservice::Build
|
|
|
|
=head1 EXTENDS
|
|
|
|
Bugzilla::Webservice
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Provides methods for automated scripts to manipulate Testopia Builds
|
|
|
|
=head1 METHODS
|
|
|
|
=over
|
|
|
|
=item C<get($id)>
|
|
|
|
Description: Used to load an existing build from the database.
|
|
|
|
Params: $id - An integer representing the ID in the database
|
|
|
|
Returns: A blessed Bugzilla::Testopia::Build object hash
|
|
|
|
=item C<check_build($name, $product)>
|
|
|
|
Description: Looks up and returns a build by name.
|
|
|
|
Params: $name - String: name of the build.
|
|
$product - Integer/String/Object
|
|
Integer: product_id of the product in the Database
|
|
String: Product name
|
|
Object: Blessed Bugzilla::Product object
|
|
|
|
Returns: Hash: Matching Build object hash or error if not found.
|
|
|
|
=item C<update($ids, $values)>
|
|
|
|
Description: Updates the fields of the selected build or builds.
|
|
|
|
Params: $ids - Integer/String/Array
|
|
Integer: A single build ID.
|
|
String: A comma separates string of Build IDs for batch
|
|
processing.
|
|
Array: An array of build IDs for batch mode processing
|
|
|
|
$values - Hash of keys matching Build fields and the new values
|
|
to set each field to.
|
|
|
|
Returns: Hash/Array: In the case of a single build it is returned. If a
|
|
list was passed, it returns an array of build hashes. If the
|
|
update on any particular build failed, the hash will contain a
|
|
FAILED key and the message as to why it failed.
|
|
|
|
=item C<create($values)>
|
|
|
|
Description: Creates a new build object and stores it in the database
|
|
|
|
Params: $values - Hash: A reference to a hash with keys and values
|
|
matching the fields of the build to be created.
|
|
See Bugzilla::Testopia::Build for a list of required fields.
|
|
|
|
Returns: The newly created object hash.
|
|
|
|
=item C<lookup_name_by_id> B<DEPRICATED> Use Build::get instead
|
|
|
|
=item C<lookup_id_by_name> B<DEPRICATED - CONSIDERED HARMFUL> Use Build::check_build instead
|
|
|
|
=back
|
|
|
|
=head1 SEE ALSO
|
|
|
|
=over
|
|
|
|
L<Bugzilla::Testopia::Build>
|
|
L<Bugzilla::Webservice>
|
|
|
|
=back
|
|
|
|
=head1 AUTHOR
|
|
|
|
Greg Hendricks <ghendricks@novell.com> |