Bommels05/Mozilla
Bommels05/Mozilla
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Write pod for build and category.

Browse Source 
git-svn-id: svn://10.0.0.236/trunk@233250 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
ghendricks%novell.com 2007-08-28 22:49:16 +00:00
parent d5f6986605
commit 22ae87f685
5 changed files with 538 additions and 266 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

394
mozilla/webtools/testopia/Bugzilla/Testopia/Build.pm
View File

@ -18,22 +18,6 @@
#
# Contributor(s): Greg Hendricks <ghendricks@novell.com>
=head1 NAME
Bugzilla::Testopia::Build - An object representing a Testopia build number
=head1 DESCRIPTION
Builds are used to classify test runs. A build represents the results of
a period of work.
=head1 SYNOPSIS
$build = Bugzilla::Testopia::Build->new($build_id);
$build = Bugzilla::Testopia::Build->new(\%build_hash);
=cut
package Bugzilla::Testopia::Build;
use strict;
@ -44,22 +28,11 @@ use Bugzilla::Testopia::TestPlan;
use Bugzilla::Testopia::TestCase;
use base qw(Exporter Bugzilla::Object);
@Bugzilla::Bug::EXPORT = qw(check_build);
@Bugzilla::Bug::EXPORT = qw(check_build check_build_by_name);
###############################
#### Initialization ####
###############################
=head1 FIELDS
build_id
product_id
name
description
milestone
isactive
=cut
use constant DB_TABLE => "test_builds";
use constant NAME_FIELD => "name";
use constant ID_FIELD => "build_id";
@ -142,7 +115,7 @@ sub _check_isactive {
return $isactive;
}
##############################
###############################
#### Mutators ####
###############################
sub set_description { $_[0]->set('description', $_[1]); }
@ -167,12 +140,10 @@ sub new {
# lists etc. This is much cleaner than exporting a bunch of subroutines and
# adding them to $vars one by one. Probably just Laziness shining through.
if (ref $param eq 'HASH'){
if (keys %$param){
if (!keys %$param || $param->{PREVALIDATED}){
bless($param, $class);
return $param;
}
bless($param, $class);
return $param;
}
unshift @_, $param;
@ -218,23 +189,19 @@ sub check_build {
return $is;
}
sub check_build_by_name {
my ($name) = @_;
my $dbh = Bugzilla->dbh;
my $id = $dbh->selectrow_array(
"SELECT build_id FROM test_builds
WHERE name = ?", undef, $name);
return $id;
}
###############################
#### Methods ####
###############################
=head1 METHODS
=head2 new
Instantiates a new Build object
=cut
=head2 store
Serializes this build to the database
=cut
sub store {
my $self = shift;
my $dbh = Bugzilla->dbh;
@ -248,37 +215,6 @@ sub store {
return $key;
}
=head2 check_name
Returns true if a build of the specified name exists in the database
for a product.
=cut
=head2 check_build_by_name
Returns id of a build of the specified name
=cut
sub check_build_by_name {
my $self = shift;
my ($name) = @_;
my $dbh = Bugzilla->dbh;
my $id = $dbh->selectrow_array(
"SELECT build_id FROM test_builds
WHERE name = ?", undef, $name);
return $id;
}
=head2 toggle_hidden
Toggles the archive bit on the build.
=cut
sub toggle_hidden {
my $self = shift;
my $dbh = Bugzilla->dbh;
@ -290,29 +226,6 @@ sub toggle_hidden {
###############################
#### Accessors ####
###############################
=head2 id
Returns the ID of this object
=head2 product_id
Returns the product_id of this object
=head2 name
Returns the name of this object
=head2 description
Returns the description of this object
=head2 milestone
Returns the Bugzilla target milestone associated with this build
=cut
sub id { return $_[0]->{'build_id'}; }
sub product_id { return $_[0]->{'product_id'}; }
sub name { return $_[0]->{'name'}; }
@ -329,12 +242,6 @@ sub product {
return $self->{'product'};
}
=head2 run_count
Returns the number of test runs using this build
=cut
sub run_count {
my ($self) = @_;
my $dbh = Bugzilla->dbh;
@ -347,12 +254,6 @@ sub run_count {
return $self->{'run_count'};
}
=head2 case_run_count
Returns the number of test case runs against this build
=cut
sub case_run_count {
my ($self,$status_id) = @_;
my $dbh = Bugzilla->dbh;
@ -372,14 +273,271 @@ sub case_run_count {
return $count;
}
1;
__END__
=head1 NAME
Bugzilla::Testopia::Build
=head1 EXTENDS
Bugzilla::Object
=head1 DESCRIPTION
Builds are used to classify test runs. They correspond to the results of
a period of work in software development. Builds are product level attributes
and are associated with a milestone if targetmilestones are used in Bugzilla.
=head1 SYNOPSIS
=head2 Creating
$build = Bugzilla::Testopia::Build->new($build_id);
$build = Bugzilla::Testopia::Build->new({name => $name});
$new_build = Bugzilla::Testopia::Build->create({name => $name,
description => $desc
... });
=head3 Deprecated
$build = Bugzilla::Testopia::Build->new({name => $name,
description => $desc,
...
PREVALIDATED => 1});
my $id = $build->store();
=head2 Updating
$build->set_name($name);
$build->set_description($name);
$build->set_milestone($milestone);
$build->set_isactive($isactive);
$build->update();
=head2 Accessors
my $id = $build->id;
my $name = $build->name;
my $desc = $build->description;
my $pid = $build->product_id;
my $milestone = $build->milestone;
my $crc = $build->case_run_count;
my $active = $build->isactive;
=head1 FIELDS
=over
=item C<build_id>
The unique id of this build in the database.
=item C<name>
A unique name for this build.
=item C<product_id>
The id of the Bugzilla product this build is attached to.
=item C<milestone>
The value from the Bugzilla product milestone table this build is associated with.
=item C<isactive>
Boolean - determines whether to show this build in lists for selection.
=back
=head1 FUNCTIONS
=over
=item C<check_build($name, $product_id)>
Description: Checks if a build of a given name exists for a given product.
Params: name - string representing the name to check for.
product_id - the product to lookup the build in.
Returns: The id of the build if one matches.
undef if it does not match any build.
=item C<check_build_by_name($name)> DEPRECATED
Description: Checks if a build of a given name exists. DEPRECATED please use
check_build($name, $product_id) instead.
Params: name - string representing the name to check for.
Returns: The id of the build if one matches.
undef if it does not match any build.
=back
=head1 METHODS
=over
=item C<new($param)>
Description: Used to load an existing build from the database.
Params: $param - An integer representing the ID in the database
or a hash with the "name" key representing the named
build in the database.
Returns: A blessed Bugzilla::Testopia::Build object
=back
=over
=item C<create()>
Description: Creates a new build object and stores it in the database
Params: A hash with keys and values matching the fields of the build to
be created.
Returns: The newly created object.
=back
=over
=item C<set_description()>
Description: Replaces the current build's description. Must call update to
store the change in the database.
Params: text - the new description.
Returns: nothing.
=back
=over
=item C<set_isactive()>
Description: Sets the isactive field.
Params: boolean - 1 for active 0 for inactive.
Returns: nothing.
=back
=over
=item C<set_milestone()>
Description: Assigns this build to a different milestone
Params: string - the new milestone value
Returns: nothing.
=back
=over
=item C<set_name()>
Description: Renames the current build. If the new name is already in use
by another build in this product, an error will be thrown.
The update method must be called to make the change in the database.
Params: string - the new name
Returns: nothing.
=back
=over
=item C<store()> DEPRECATED
Description: Similar to create except validation is not performed during store.
Params: none.
Returns: The id of the newly stored build.
=item C<toggle_hidden()>
Description: Flips the bit in the isactive field. If it is currently 0 it sets
it to 1 and vice versa.
Params: none.
Returns: nothing.
=back
=head1 ACCESSORS
=over
=item C<case_run_count()>
Params: case_run_status_id - optional;
Returns: The number of case-runs in this build. Optionally for a given status.
=item C<description()>
Returns the description of this build.
=item C<id()>
Returns the id of the build
=item C<isactive()>
Returns 1 if this build is visible in pick lists for runs and caserund and 0 if not.
=item C<milestone()>
Returns the milestone value that this build is associated with.
=item C<name()>
Returns the name of this build
=item C<product()>
Returns a Bugzilla::Testopia::Product object of the product this build is of.
=item C<product_id()>
Returns the product id of the build.
=item C<run_count()>
Returns an integer representing the number of runs this build is associated to.
=back
=head1 SEE ALSO
TestPlan TestRun TestCaseRun
=over
L<Bugzilla::Testopia::Product>
L<Bugzilla::Testopia::TestRun>
L<Bugzilla::Object>
=back
=head1 AUTHOR
Greg Hendricks <ghendricks@novell.com>
=cut
1;
Greg Hendricks <ghendricks@novell.com>

394
mozilla/webtools/testopia/Bugzilla/Testopia/Category.pm
View File

@ -18,22 +18,6 @@
#
# Contributor(s): Greg Hendricks <ghendricks@novell.com>
=head1 NAME
Bugzilla::Testopia::Category - An object representing a test case category
=head1 DESCRIPTION
Categories are used to classify test cases. Each test case must
belong to one category.
=head1 SYNOPSIS
$category = Bugzilla::Testopia::Category->new($category_id);
$category = Bugzilla::Testopia::Category->new(\%category_hash);
=cut
package Bugzilla::Testopia::Category;
use strict;
@ -42,6 +26,7 @@ use Bugzilla::Util;
use Bugzilla::Error;
use Bugzilla::Testopia::TestPlan;
use Bugzilla::Testopia::TestCase;
use Bugzilla::Testopia::Product;
use base qw(Exporter Bugzilla::Object);
@Bugzilla::Bug::EXPORT = qw(check_case_category);
@ -49,15 +34,6 @@ use base qw(Exporter Bugzilla::Object);
###############################
#### Initialization ####
###############################
=head1 FILEDS
category_id
product_id
name
description
=cut
use constant DB_TABLE => "test_case_categories";
use constant NAME_FIELD => "name";
use constant ID_FIELD => "category_id";
@ -139,12 +115,10 @@ sub new {
# lists etc. This is much cleaner than exporting a bunch of subroutines and
# adding them to $vars one by one. Probably just Laziness shining through.
if (ref $param eq 'HASH'){
if (keys %$param){
if (!keys %$param || $param->{PREVALIDATED}){
bless($param, $class);
return $param;
}
bless($param, $class);
return $param;
}
unshift @_, $param;
@ -192,66 +166,6 @@ sub check_case_category {
###############################
#### Methods ####
###############################
=head1 METHODS
=head2 new
Instantiates a new Category object
=cut
sub new {
my $invocant = shift;
my $class = ref($invocant) || $invocant;
my $self = {};
bless($self, $class);
return $self->_init(@_);
}
=head2 _init
Private constructor for category class
=cut
sub _init {
my $self = shift;
my ($param) = (@_);
my $dbh = Bugzilla->dbh;
my $columns = join(", ", DB_COLUMNS);
my $id = $param unless (ref $param eq 'HASH');
my $obj;
if (defined $id && detaint_natural($id)) {
$obj = $dbh->selectrow_hashref(qq{
SELECT $columns FROM test_case_categories
WHERE category_id = ?}, undef, $id);
} elsif (ref $param eq 'HASH'){
$obj = $param;
} else {
ThrowCodeError('bad_arg',
{argument => 'param',
function => 'Testopia::Category::_init'});
}
return undef unless (defined $obj);
foreach my $field (keys %$obj) {
$self->{$field} = $obj->{$field};
}
return $self;
}
=head2 store
Serializes this category to the database
=cut
sub store {
my $self = shift;
my $dbh = Bugzilla->dbh;
@ -264,12 +178,6 @@ sub store {
return $key;
}
=head2 remove
Removes this category from the specified product
=cut
sub remove {
my $self = shift;
my $dbh = Bugzilla->dbh;
@ -278,22 +186,6 @@ sub remove {
$self->{'category_id'});
}
=head2 check_name
Returns the category id if the specified name exists in the
database for the product.
=cut
=head2 update
Updates an existing category object in the database.
Takes the new name, and description.
=cut
sub candelete {
my $self = shift;
return 0 unless Bugzilla->user->in_group('Testers');
@ -304,36 +196,11 @@ sub candelete {
###############################
#### Accessors ####
###############################
=head2 id
Returns the ID of this object
=head2 product_id
Returns the product_id of this object
=head2 name
Returns the name of this object
=head2 description
Returns the description of this object
=cut
sub id { return $_[0]->{'category_id'}; }
sub product_id { return $_[0]->{'product_id'}; }
sub name { return $_[0]->{'name'}; }
sub description { return $_[0]->{'description'}; }
=head2 case_count
Returns the number of test cases in this category
=cut
sub case_count {
my ($self) = @_;
my $dbh = Bugzilla->dbh;
@ -348,12 +215,6 @@ sub case_count {
return $self->{'case_count'};
}
=head2 plan_case_ids
Returns a reference to a list of case_ids in this category for a given plan.
=cut
sub plan_case_ids {
my ($self, $plan_id) = @_;
my $dbh = Bugzilla->dbh;
@ -369,14 +230,255 @@ sub plan_case_ids {
return $self->{'case_ids'};
}
1;
__END__
=head1 NAME
Bugzilla::Testopia::Category - An object representing a test case category
=head1 EXTENDS
Bugzilla::Object
=head1 DESCRIPTION
Categories are used to classify test cases. Each test case must
belong to one category. Categories are product level attributes.
Every plan in a product will have access to that product's categories.
=head1 SYNOPSIS
=head2 Creating
$category = Bugzilla::Testopia::Category->new($category_id);
$category = Bugzilla::Testopia::Category->new({name => $name});
$new_category = Bugzilla::Testopia::Category->create({name => $name,
description => $desc});
=head3 Deprecated
$category = Bugzilla::Testopia::Category->new({name => $name,
description => $desc,
PREVALIDATED => 1});
my $id = $category->store();
=head2 Updating
$category->set_name($name);
$category->set_description($name);
$category->update();
=head2 Accessors
my $id = $category->id;
my $name = $category->name;
my $desc = $category->description;
my $c_cont = $category->case_count;
my $pid = $category->product_id;
my $case_ids = $category->plan_case_ids;
=head1 FIELDS
=over
=item C<category_id>
The unique id in the database.
=item C<product_id>
The product id of the Bugzilla product this category belongs to.
=item C<name>
A unique name for this category
=item C<description>
A detailed description for this category.
=back
=head1 FUNCTIONS
=over
=item C<check_case_category($param)>
Description: Checks if a category of a given name exists for a given product.
Params: name - string representing the name to check for.
product_id - the product to lookup the category in.
Returns: The id of the category if one matches.
undef if it does not match any category.
=back
=head1 METHODS
=over
=item C<new($param)>
Description: Used to load an existing Category from the database.
Params: $param - An integer representing the Category ID in the database
or a hash with the "name" key representing the named
category in the database.
Returns: A blessed Bugzilla::Testopia::Category object
=back
=over
=item C<candelete()>
Description: Tests to see if the current category can be safely deleted from
the database. To be a candidate for removal, there can be no
assigned test cases with this category. Also, the user must be in
the Testers group.
Params: none.
Returns: 1 if this category can be safely removed.
0 if this category cannot be removed safely or if the logged in user
does not have sufficient rights to perform the operation.
=back
=over
=item C<create()>
Description: Creates a new category object and stores it in the database
Params: A hash with keys and values matching the fields of the category to
be created.
Returns: The newly created object
=back
=over
=item C<plan_case_ids()>
Description: Looks up the case ids assigned to this category in a given plan.
Params: The plan id to look up.
Returns: Integer representing the count of cases found with this category.
=back
=over
=item C<remove()>
Description: Completely removes this category from the database. This should not
be called unless candelete has returned true.
Params: none.
Returns: nothing.
=back
=over
=item C<set_description()>
Description: Replaces the current category's description. Must call update to
store the change in the database.
Params: text - the new description.
Returns: nothing.
=back
=over
=item C<set_name()>
Description: Renames the current category. If the new name is already in use
by another category in this product, an error will be thrown.
The update method must be called to make the change in the database.
Params: string - the new name
Returns: nothing.
=back
=over
=item C<store()> DEPRECATED
Description: Similar to create except validation is not performed during store.
Params: none.
Returns: The id of the newly stored category.
=back
=head1 ACCESSORS
=over
=item C<case_count()>
Returns an integer representing the number of cases found in this category.
=back
=over
=item C<description()>
Returns the description of the category.
=back
=over
=item C<id()>
Returns the category id
=back
=over
=item C<name()>
Returns the name of the category.
=back
=over
=item C<product_id()>
Returns the id of the product this category belongs to
=back
=head1 SEE ALSO
TestCase
L<Bugzilla::Testopia::TestCase>
L<Bugzilla::Testopia::Product>
L<Bugzilla::Object>
=head1 AUTHOR
Greg Hendricks <ghendricks@novell.com>
=cut
1;

1
mozilla/webtools/testopia/Bugzilla/Testopia/Xml.pm
View File

@ -273,6 +273,7 @@ sub parse()
name => $category_name,
product_id => $product->id(),
description => $description,
PREVALIDATED => 1,
});
# Only create the category if it does not exist.

3
mozilla/webtools/testopia/Bugzilla/WebService/Testopia/Build.pm
View File

@ -122,6 +122,7 @@ sub lookup_name_by_id
return $result;
}
# DEPRECATED use Build::check_build($name, $product_id) instead
sub lookup_id_by_name
{
my $self = shift;
@ -129,7 +130,7 @@ sub lookup_id_by_name
$self->login;
my $result = Bugzilla::Testopia::Build->check_build_by_name($name);
my $result = check_build_by_name($name);
$self->logout;

12
mozilla/webtools/testopia/tr_show_plan.cgi
View File

@ -260,17 +260,24 @@ elsif ($action eq 'History'){
#######################
elsif ($action eq 'Attach'){
print $cgi->header;
my $plan = Bugzilla::Testopia::TestPlan->new($plan_id);
ThrowUserError("testopia-read-only", {'object' => $plan}) unless $plan->canedit;
defined $cgi->upload('data')
|| ThrowUserError("file_not_specified");
my $filename = $cgi->upload('data');
$cgi->param('description')
|| ThrowUserError("missing_attachment_description");
my $description = $cgi->param('description');
my $contenttype = $cgi->uploadInfo($cgi->param('data'))->{'Content-Type'};
trick_taint($description);
#trick_taint($contenttype);
my $fh = $cgi->upload('data');
my $data;
# enable 'slurp' mode
@ -287,10 +294,13 @@ elsif ($action eq 'Attach'){
contents => $data
});
$attachment->store;
$attachment->store;
$vars->{'tr_message'} = "Attachment added successfully";
$vars->{'backlink'} = $plan;
do_update($plan);
display(Bugzilla::Testopia::TestPlan->new($plan_id));
}
elsif ($action eq 'Delete'){