From 190cd14c28682b7238447723439d0e43346742f2 Mon Sep 17 00:00:00 2001 From: "ghendricks%novell.com" Date: Fri, 29 Feb 2008 23:36:54 +0000 Subject: [PATCH] Include Java API Clean up Patch Add patch for 3.0.x synchronize with SVN git-svn-id: svn://10.0.0.236/trunk@246816 18797224-902f-48f8-a5cc-f745e15eee43 --- .../testopia/Bugzilla/Testopia/TestCase.pm | 2 +- .../Bugzilla/WebService/Testopia/TestCase.pm | 12 +- .../Bugzilla/WebService/Testopia/TestRun.pm | 2 +- .../code/db_schema-abstract_schema.pl | 6 +- .../testopia/code/install-update_db.pl | 4 +- .../testopia/category/delete.html.tmpl | 44 - .../default/testopia/category/form.html.tmpl | 54 - .../default/testopia/category/list.html.tmpl | 53 - .../testopia/contrib/drivers/java/.classpath | 15 + .../testopia/contrib/drivers/java/.project | 17 + .../contrib/drivers/java/OptionalData.xml | 16 + .../contrib/drivers/java/TESTS-TestSuites.xml | 46 + .../testopia/contrib/drivers/java/build.xml | 68 + .../drivers/java/doc/allclasses-frame.html | 46 + .../drivers/java/doc/allclasses-noframe.html | 46 + .../drivers/java/doc/constant-values.html | 140 + .../drivers/java/doc/deprecated-list.html | 140 + .../contrib/drivers/java/doc/help-doc.html | 211 + .../drivers/java/doc/index-files/index-1.html | 139 + .../java/doc/index-files/index-10.html | 151 + .../java/doc/index-files/index-11.html | 157 + .../drivers/java/doc/index-files/index-2.html | 139 + .../drivers/java/doc/index-files/index-3.html | 139 + .../drivers/java/doc/index-files/index-4.html | 139 + .../drivers/java/doc/index-files/index-5.html | 209 + .../drivers/java/doc/index-files/index-6.html | 155 + .../drivers/java/doc/index-files/index-7.html | 139 + .../drivers/java/doc/index-files/index-8.html | 139 + .../drivers/java/doc/index-files/index-9.html | 229 ++ .../contrib/drivers/java/doc/index.html | 34 + .../drivers/java/doc/overview-tree.html | 146 + .../contrib/drivers/java/doc/package-list | 1 + .../drivers/java/doc/resources/inherit.gif | Bin 0 -> 57 bytes .../contrib/drivers/java/doc/stylesheet.css | 29 + .../drivers/java/doc/testopia/API/Build.html | 339 ++ .../java/doc/testopia/API/Component.html | 263 ++ .../java/doc/testopia/API/Environment.html | 319 ++ .../java/doc/testopia/API/Product.html | 304 ++ .../java/doc/testopia/API/TestAPI.html | 247 ++ .../java/doc/testopia/API/TestCaseRun.html | 453 +++ .../java/doc/testopia/API/TestPlan.html | 608 +++ .../java/doc/testopia/API/TestRun.html | 545 +++ .../doc/testopia/API/TestopiaTestCase.html | 660 +++ .../drivers/java/doc/testopia/API/User.html | 262 ++ .../doc/testopia/API/class-use/Build.html | 138 + .../doc/testopia/API/class-use/Component.html | 138 + .../testopia/API/class-use/Environment.html | 138 + .../doc/testopia/API/class-use/Product.html | 138 + .../doc/testopia/API/class-use/TestAPI.html | 138 + .../testopia/API/class-use/TestCaseRun.html | 138 + .../doc/testopia/API/class-use/TestPlan.html | 138 + .../doc/testopia/API/class-use/TestRun.html | 138 + .../API/class-use/TestopiaTestCase.html | 138 + .../java/doc/testopia/API/class-use/User.html | 138 + .../java/doc/testopia/API/package-frame.html | 48 + .../doc/testopia/API/package-summary.html | 184 + .../java/doc/testopia/API/package-tree.html | 144 + .../java/doc/testopia/API/package-use.html | 138 + .../testopia/contrib/drivers/java/jar/README | 19 + .../drivers/java/testopia/API/Build.java | 326 ++ .../drivers/java/testopia/API/Component.java | 170 + .../java/testopia/API/Environment.java | 368 ++ .../drivers/java/testopia/API/Lookup.java | 152 + .../drivers/java/testopia/API/Product.java | 235 ++ .../java/testopia/API/TestCaseRun.java | 399 ++ .../drivers/java/testopia/API/TestPlan.java | 650 +++ .../drivers/java/testopia/API/TestRun.java | 494 +++ .../java/testopia/API/TestopiaTestCase.java | 670 ++++ .../drivers/java/testopia/API/User.java | 178 + .../drivers/java/testopia/API/lookupHelp.txt | 30 + .../java/testopia/Test/JunitToTestopia.java | 313 ++ .../java/testopia/Test/OptionalData.java | 78 + .../java/testopia/Test/OptionalValues.java | 169 + .../drivers/java/testopia/Test/ParseAnt.java | 141 + .../java/testopia/Test/TestCaseRunnable.java | 64 + .../java/testopia/Test/TestopiaConnector.java | 354 ++ .../contrib/drivers/java/testopiaData.xml | 34 + .../contrib/drivers/php/.xmlrpc.inc.php | 3566 +++++++++++++++++ .../testopia/testopia/dojo/DOJO_INSTALL_HELP | 12 - .../webtools/testopia/testopia/img/new.png | Bin 0 -> 593 bytes .../webtools/testopia/testopia/img/new.svg | 131 + mozilla/webtools/testopia/testopia/patch-3.0 | 52 - .../webtools/testopia/testopia/patch-3.0.x | 414 ++ 83 files changed, 17549 insertions(+), 231 deletions(-) delete mode 100644 mozilla/webtools/testopia/template/en/default/testopia/category/delete.html.tmpl delete mode 100644 mozilla/webtools/testopia/template/en/default/testopia/category/form.html.tmpl delete mode 100644 mozilla/webtools/testopia/template/en/default/testopia/category/list.html.tmpl create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/.classpath create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/.project create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/OptionalData.xml create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/TESTS-TestSuites.xml create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/build.xml create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/allclasses-frame.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/allclasses-noframe.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/constant-values.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/deprecated-list.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/help-doc.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-1.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-10.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-11.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-2.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-3.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-4.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-5.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-6.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-7.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-8.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-9.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/overview-tree.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/package-list create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/resources/inherit.gif create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/stylesheet.css create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Build.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Component.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Environment.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Product.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestAPI.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestCaseRun.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestPlan.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestRun.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestopiaTestCase.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/User.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Build.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Component.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Environment.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Product.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestAPI.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestCaseRun.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestPlan.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestRun.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestopiaTestCase.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/User.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-frame.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-summary.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-tree.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-use.html create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/jar/README create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Build.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Component.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Environment.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Lookup.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Product.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestCaseRun.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestPlan.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestRun.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestopiaTestCase.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/User.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/lookupHelp.txt create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/JunitToTestopia.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/OptionalData.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/OptionalValues.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/ParseAnt.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/TestCaseRunnable.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/TestopiaConnector.java create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/java/testopiaData.xml create mode 100644 mozilla/webtools/testopia/testopia/contrib/drivers/php/.xmlrpc.inc.php delete mode 100644 mozilla/webtools/testopia/testopia/dojo/DOJO_INSTALL_HELP create mode 100644 mozilla/webtools/testopia/testopia/img/new.png create mode 100644 mozilla/webtools/testopia/testopia/img/new.svg create mode 100644 mozilla/webtools/testopia/testopia/patch-3.0.x diff --git a/mozilla/webtools/testopia/Bugzilla/Testopia/TestCase.pm b/mozilla/webtools/testopia/Bugzilla/Testopia/TestCase.pm index eccf0fdd5d0..0ab4285c34b 100644 --- a/mozilla/webtools/testopia/Bugzilla/Testopia/TestCase.pm +++ b/mozilla/webtools/testopia/Bugzilla/Testopia/TestCase.pm @@ -50,7 +50,7 @@ use JSON; use Text::Diff; use base qw(Exporter Bugzilla::Object); -@Bugzilla::Testopia::Util::EXPORT = qw(lookup_status lookup_status_by_name +@Bugzilla::Testopia::TestCase::EXPORT = qw(lookup_status lookup_status_by_name lookup_category lookup_category_by_name lookup_priority lookup_priority_by_value lookup_default_tester); diff --git a/mozilla/webtools/testopia/Bugzilla/WebService/Testopia/TestCase.pm b/mozilla/webtools/testopia/Bugzilla/WebService/Testopia/TestCase.pm index d464475e52c..e5e977bb9df 100644 --- a/mozilla/webtools/testopia/Bugzilla/WebService/Testopia/TestCase.pm +++ b/mozilla/webtools/testopia/Bugzilla/WebService/Testopia/TestCase.pm @@ -111,7 +111,7 @@ sub create my $test_case = Bugzilla::Testopia::TestCase->create($new_values); - $test_case->link_plan($plan->id, $test_case->id); + $test_case->link_plan($plan_id, $test_case->id); $self->logout; @@ -424,18 +424,12 @@ sub add_tag die "User Not Authorized"; } - my $result = $test_case->add_tag($tag_name); - - if ($result == 1) - { - $self->logout; - die "Tag, " . $tag_name . ", already exists for Testcase, " . $test_case_id; - } + $test_case->add_tag($tag_name); $self->logout; # Result 0 on success, otherwise an exception will be thrown - return $result; + return 0; } sub remove_tag diff --git a/mozilla/webtools/testopia/Bugzilla/WebService/Testopia/TestRun.pm b/mozilla/webtools/testopia/Bugzilla/WebService/Testopia/TestRun.pm index 5a780a101f3..3640f34981c 100644 --- a/mozilla/webtools/testopia/Bugzilla/WebService/Testopia/TestRun.pm +++ b/mozilla/webtools/testopia/Bugzilla/WebService/Testopia/TestRun.pm @@ -294,7 +294,7 @@ sub add_tag $self->logout; # Result 0 on success, otherwise an exception will be thrown - return $result; + return 0; } sub remove_tag diff --git a/mozilla/webtools/testopia/extensions/testopia/code/db_schema-abstract_schema.pl b/mozilla/webtools/testopia/extensions/testopia/code/db_schema-abstract_schema.pl index 24748b6875b..1a85786ebfb 100644 --- a/mozilla/webtools/testopia/extensions/testopia/code/db_schema-abstract_schema.pl +++ b/mozilla/webtools/testopia/extensions/testopia/code/db_schema-abstract_schema.pl @@ -244,7 +244,7 @@ $schema->{test_plan_texts} = { # Tiny table -- don't add keys besides primary key. $schema->{test_plan_types} = { FIELDS => [ - type_id => {TYPE => 'TINYSERIAL', PRIMARYKEY => 1, NOTNULL => 1}, + type_id => {TYPE => 'SMALLSERIAL', PRIMARYKEY => 1, NOTNULL => 1}, name => {TYPE => 'varchar(64)', NOTNULL => 1}, description => {TYPE => 'MEDIUMTEXT'}, ], @@ -392,7 +392,7 @@ $schema->{test_relationships} = { # Tiny table -- don't add keys besides primary key. $schema->{test_case_run_status} = { FIELDS => [ - case_run_status_id => {TYPE => 'TINYSERIAL', PRIMARYKEY => 1, NOTNULL => 1}, + case_run_status_id => {TYPE => 'SMALLSERIAL', PRIMARYKEY => 1, NOTNULL => 1}, name => {TYPE => 'varchar(20)'}, sortkey => {TYPE => 'INT4'}, description => {TYPE => 'TEXT'}, @@ -401,7 +401,7 @@ $schema->{test_case_run_status} = { # Tiny table -- don't add keys besides primary key. $schema->{test_case_status} = { FIELDS => [ - case_status_id => {TYPE => 'TINYSERIAL', PRIMARYKEY => 1, NOTNULL => 1}, + case_status_id => {TYPE => 'SMALLSERIAL', PRIMARYKEY => 1, NOTNULL => 1}, name => {TYPE => 'varchar(255)', NOTNULL => 1}, description => {TYPE => 'TEXT'}, ], diff --git a/mozilla/webtools/testopia/extensions/testopia/code/install-update_db.pl b/mozilla/webtools/testopia/extensions/testopia/code/install-update_db.pl index d70f3334c30..de424317b10 100644 --- a/mozilla/webtools/testopia/extensions/testopia/code/install-update_db.pl +++ b/mozilla/webtools/testopia/extensions/testopia/code/install-update_db.pl @@ -100,9 +100,9 @@ sub testopiaUpdateDB { $dbh->bz_alter_column('test_case_runs', 'environment_id', {TYPE => 'INT4', UNSIGNED => 1, NOTNULL => 1}); $dbh->bz_alter_column('test_case_runs', 'iscurrent', {TYPE => 'BOOLEAN', NOTNULL => 1, DEFAULT => '0'}); $dbh->bz_alter_column('test_case_runs', 'run_id', {TYPE => 'INT4', UNSIGNED => 1, NOTNULL => 1}); - $dbh->bz_alter_column('test_case_run_status', 'case_run_status_id', {TYPE => 'TINYSERIAL', PRIMARYKEY => 1, NOTNULL => 1}); + $dbh->bz_alter_column('test_case_run_status', 'case_run_status_id', {TYPE => 'SMALLSERIAL', PRIMARYKEY => 1, NOTNULL => 1}); $dbh->bz_alter_column('test_cases', 'case_id', {TYPE => 'INTSERIAL', PRIMARYKEY => 1, NOTNULL => 1}); - $dbh->bz_alter_column('test_case_status', 'case_status_id', {TYPE => 'TINYSERIAL', PRIMARYKEY => 1, NOTNULL => 1}); + $dbh->bz_alter_column('test_case_status', 'case_status_id', {TYPE => 'SMALLSERIAL', PRIMARYKEY => 1, NOTNULL => 1}); $dbh->bz_alter_column('test_case_tags', 'case_id', {TYPE => 'INT4', UNSIGNED => 1, NOTNULL => 1}); $dbh->bz_alter_column('test_case_texts', 'case_id', {TYPE => 'INT4', UNSIGNED => 1, NOTNULL => 1}); $dbh->bz_alter_column('test_case_texts', 'creation_ts', {TYPE => 'DATETIME', NOTNULL => 1}); diff --git a/mozilla/webtools/testopia/template/en/default/testopia/category/delete.html.tmpl b/mozilla/webtools/testopia/template/en/default/testopia/category/delete.html.tmpl deleted file mode 100644 index 37161e1f408..00000000000 --- a/mozilla/webtools/testopia/template/en/default/testopia/category/delete.html.tmpl +++ /dev/null @@ -1,44 +0,0 @@ -[%# 1.0@bugzilla.org %] -[%# 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): Greg Hendricks - #%] - -[% PROCESS global/header.html.tmpl - style_urls = ['testopia.css'] - title = "Delete Category $category.name From Product $product.name" -%] - -
- - - - - -You are about to delete category '[% category.name FILTER html %]' from product - [% product.name FILTER html %].
-

Are you sure?

- -
-

-[% IF plan_id %] -Back to test plan or -[% END %] -edit categories -

- -[% PROCESS global/footer.html.tmpl %] diff --git a/mozilla/webtools/testopia/template/en/default/testopia/category/form.html.tmpl b/mozilla/webtools/testopia/template/en/default/testopia/category/form.html.tmpl deleted file mode 100644 index 9a846e17009..00000000000 --- a/mozilla/webtools/testopia/template/en/default/testopia/category/form.html.tmpl +++ /dev/null @@ -1,54 +0,0 @@ -[%# 1.0@bugzilla.org %] -[%# 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): Greg Hendricks - #%] - -[% IF action == 'do_add' %] - [% title = "Create a New Category for $product.name" %] -[% ELSE %] - [% title = "Edit Category $category.name for $product.name" %] -[% END %] - -[% PROCESS global/header.html.tmpl - style_urls = ['testopia.css'] %] - -
- - - - - - - - - - - - - -
Category Name:
Category Description:
- -
-

-[% IF plan_id %] -Back to test plan or -[% END %] -edit categories -

- -[% PROCESS global/footer.html.tmpl %] diff --git a/mozilla/webtools/testopia/template/en/default/testopia/category/list.html.tmpl b/mozilla/webtools/testopia/template/en/default/testopia/category/list.html.tmpl deleted file mode 100644 index 002f590e7e1..00000000000 --- a/mozilla/webtools/testopia/template/en/default/testopia/category/list.html.tmpl +++ /dev/null @@ -1,53 +0,0 @@ -[%# 1.0@bugzilla.org %] -[%# 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): Greg Hendricks - #%] - -[% PROCESS global/header.html.tmpl - style_urls = ['testopia.css'] - title = "Test Categories for $product.name" -%] - - - - - - -[% FOREACH cat = product.categories %] - - - - - -[% END %] -
NameDescriptionActions
[% cat.name FILTER html %][% cat.description FILTER html %] - Edit -[%- IF cat.candelete -%] - | Delete -[%- END %] -
-
- [% IF user.in_group('Testers') %] - Add new - [% END %] -[% IF plan_id %] -

-Back to test plan -

-[% END %] -[% PROCESS global/footer.html.tmpl %] diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/.classpath b/mozilla/webtools/testopia/testopia/contrib/drivers/java/.classpath new file mode 100644 index 00000000000..9da18f2372f --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/.classpath @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/.project b/mozilla/webtools/testopia/testopia/contrib/drivers/java/.project new file mode 100644 index 00000000000..481efdac219 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/.project @@ -0,0 +1,17 @@ + + + Testopia Java API + + + + + + org.eclipse.jdt.core.javabuilder + + + + + + org.eclipse.jdt.core.javanature + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/OptionalData.xml b/mozilla/webtools/testopia/testopia/contrib/drivers/java/OptionalData.xml new file mode 100644 index 00000000000..8ca66d2998e --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/OptionalData.xml @@ -0,0 +1,16 @@ + + + + + +null +0 +0 + +0 + + + + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/TESTS-TestSuites.xml b/mozilla/webtools/testopia/testopia/contrib/drivers/java/TESTS-TestSuites.xml new file mode 100644 index 00000000000..eefeb629034 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/TESTS-TestSuites.xml @@ -0,0 +1,46 @@ + + + + + + + + + + + + java.lang.NullPointerException + + + + + + + + + + + + + + + + + + could not find expected string + + + + + + + + + + + + + + + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/build.xml b/mozilla/webtools/testopia/testopia/contrib/drivers/java/build.xml new file mode 100644 index 00000000000..9a4edb159ca --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/build.xml @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ + + + + \ No newline at end of file diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/allclasses-frame.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/allclasses-frame.html new file mode 100644 index 00000000000..029f82cd275 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/allclasses-frame.html @@ -0,0 +1,46 @@ + + + + + + +All Classes + + + + + + + + + + +All Classes +
+ + + + + +
Build +
+Component +
+Environment +
+Product +
+TestCaseRun +
+TestopiaTestCase +
+TestPlan +
+TestRun +
+User +
+
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/allclasses-noframe.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/allclasses-noframe.html new file mode 100644 index 00000000000..ab593189a8f --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/allclasses-noframe.html @@ -0,0 +1,46 @@ + + + + + + +All Classes + + + + + + + + + + +All Classes +
+ + + + + +
Build +
+Component +
+Environment +
+Product +
+TestCaseRun +
+TestopiaTestCase +
+TestPlan +
+TestRun +
+User +
+
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/constant-values.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/constant-values.html new file mode 100644 index 00000000000..c5118143032 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/constant-values.html @@ -0,0 +1,140 @@ + + + + + + +Constant Field Values + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Constant Field Values

+
+
+Contents
    +
+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/deprecated-list.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/deprecated-list.html new file mode 100644 index 00000000000..7aba306d552 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/deprecated-list.html @@ -0,0 +1,140 @@ + + + + + + +Deprecated List + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Deprecated API

+
+
+Contents
    +
+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/help-doc.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/help-doc.html new file mode 100644 index 00000000000..1e14ddcd245 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/help-doc.html @@ -0,0 +1,211 @@ + + + + + + +API Help + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

    +
  • Interfaces (italic)
  • Classes
  • Enums
  • Exceptions
  • Errors
  • Annotation Types
+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
  • Class inheritance diagram
  • Direct Subclasses
  • All Known Subinterfaces
  • All Known Implementing Classes
  • Class/interface declaration
  • Class/interface description +

    +

  • Nested Class Summary
  • Field Summary
  • Constructor Summary
  • Method Summary +

    +

  • Field Detail
  • Constructor Detail
  • Method Detail
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

    +
  • Annotation Type declaration
  • Annotation Type description
  • Required Element Summary
  • Optional Element Summary
  • Element Detail
+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

    +
  • Enum declaration
  • Enum description
  • Enum Constant Summary
  • Enum Constant Detail
+
+

+Use

+
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
    +
  • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
  • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-1.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-1.html new file mode 100644 index 00000000000..ece3fb8bd51 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-1.html @@ -0,0 +1,139 @@ + + + + + + +A-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+A

+
+
addComponent(int) - +Method in class testopia.API.TestopiaTestCase +
Adds a component to the testCase +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-10.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-10.html new file mode 100644 index 00000000000..650a489049f --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-10.html @@ -0,0 +1,151 @@ + + + + + + +T-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+T

+
+
TestCaseRun - Class in testopia.API
 
TestCaseRun(String, String, int, URL) - +Constructor for class testopia.API.TestCaseRun +
Use this constructor if you just want to use gets +
TestCaseRun(String, String, int, int, int, int, Integer, URL) - +Constructor for class testopia.API.TestCaseRun +
Use this constructor if you want to do sets and gets +
testopia.API - package testopia.API
 
TestopiaTestCase - Class in testopia.API
 
TestopiaTestCase(String, String, URL, Integer) - +Constructor for class testopia.API.TestopiaTestCase +
  +
TestPlan - Class in testopia.API
Creates a test plan object, that allows the user to create, change and get test plan values
TestPlan(String, String, URL, Integer) - +Constructor for class testopia.API.TestPlan +
  +
TestRun - Class in testopia.API
 
TestRun(String, String, URL, Integer) - +Constructor for class testopia.API.TestRun +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-11.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-11.html new file mode 100644 index 00000000000..d16ad259a01 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-11.html @@ -0,0 +1,157 @@ + + + + + + +U-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+U

+
+
update() - +Method in class testopia.API.TestCaseRun +
Updates are not called when the .set is used. +
update() - +Method in class testopia.API.TestopiaTestCase +
Updates are not called when the .set is used. +
update() - +Method in class testopia.API.TestPlan +
Updates are not called when the .set is used. +
update() - +Method in class testopia.API.TestRun +
  +
updateBuild(String, String, Boolean, String, int) - +Method in class testopia.API.Build +
Updates builds on testopia with the specified parameters +
updateEnvironment(String, Boolean, Integer, int) - +Method in class testopia.API.Environment +
Updates the environment on testopia with the specified parameters +
User - Class in testopia.API
 
User(String, String, String, URL) - +Constructor for class testopia.API.User +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-2.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-2.html new file mode 100644 index 00000000000..5975a1f080a --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-2.html @@ -0,0 +1,139 @@ + + + + + + +B-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+B

+
+
Build - Class in testopia.API
Allows the user to get a buildID from it's name, or it's name from the buildID.
Build(String, String, URL) - +Constructor for class testopia.API.Build +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-3.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-3.html new file mode 100644 index 00000000000..6b78f99ef84 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-3.html @@ -0,0 +1,139 @@ + + + + + + +C-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+C

+
+
Component - Class in testopia.API
Allows the user to get a hashmap of the component values by inputing the component ID
Component(String, String, URL) - +Constructor for class testopia.API.Component +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-4.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-4.html new file mode 100644 index 00000000000..68927c376ce --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-4.html @@ -0,0 +1,139 @@ + + + + + + +E-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+E

+
+
Environment - Class in testopia.API
Allows the user to get an environment from it's ID.
Environment(String, String, URL) - +Constructor for class testopia.API.Environment +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-5.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-5.html new file mode 100644 index 00000000000..9b82dfed895 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-5.html @@ -0,0 +1,209 @@ + + + + + + +G-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+G

+
+
getAttributes() - +Method in class testopia.API.TestCaseRun +
  +
getAttributes() - +Method in class testopia.API.TestopiaTestCase +
Gets the attributes of the test case, caseID must not be null +
getAttributes() - +Method in class testopia.API.TestPlan +
Gets the attributes of the test plan, planID must not be null +
getAttributes() - +Method in class testopia.API.TestRun +
Gets the attributes of the test run, runID must not be null +
getAttributes() - +Method in class testopia.API.User +
  +
getBuildIDByName(String) - +Method in class testopia.API.Build +
  +
getBuildIDByName(String) - +Method in class testopia.API.TestopiaTestCase +
  +
getBuildNameByID(int) - +Method in class testopia.API.Build +
  +
getBuilds() - +Method in class testopia.API.TestPlan +
  +
getCategories() - +Method in class testopia.API.TestPlan +
  +
getComponentByID(int) - +Method in class testopia.API.Component +
  +
getComponents() - +Method in class testopia.API.TestopiaTestCase +
Gets the components as an array of hashMaps or null if + an error occurs +
getComponents() - +Method in class testopia.API.TestPlan +
  +
getEnvirnoment(int) - +Method in class testopia.API.Environment +
Returns the environmnet as a HashMap or null if environment can't be found +
getList(String, String, URL, HashMap<String, Object>) - +Static method in class testopia.API.TestopiaTestCase +
Returns hashmap(s) of testcases that match the inputed values +
getList(String, String, URL, HashMap<String, Object>) - +Static method in class testopia.API.TestPlan +
Returns hashmap(s) of testplans that match the inputed values +
getList(String, String, URL, HashMap<String, Object>) - +Static method in class testopia.API.TestRun +
Returns hashmap(s) of testplans that match the inputed values +
getMilestones(int) - +Method in class testopia.API.Product +
  +
getProductIDByName(String) - +Method in class testopia.API.Product +
  +
getProductNameByID(int) - +Method in class testopia.API.Product +
  +
getTestCaseRuns() - +Method in class testopia.API.TestRun +
  +
getTestCases() - +Method in class testopia.API.TestPlan +
  +
getTestCases() - +Method in class testopia.API.TestRun +
  +
getTestRuns() - +Method in class testopia.API.TestPlan +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-6.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-6.html new file mode 100644 index 00000000000..667bbf7a55e --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-6.html @@ -0,0 +1,155 @@ + + + + + + +M-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+M

+
+
makeBuild(String, int, Boolean) - +Method in class testopia.API.Build +
Creates a new build and returns the buildID, 0 is returned if an error occurs +
makeEnvironment(String, int, boolean) - +Method in class testopia.API.Environment +
Creates a new environment and returns the environmentID, 0 is returned + if an error occurs +
makeTestCase(int, int, int, boolean, int, String, Integer) - +Method in class testopia.API.TestopiaTestCase +
  +
makeTestCaseRun(int, int) - +Method in class testopia.API.TestCaseRun +
used to create a testRunCase +
makeTestPlan(String, String, String, String, String) - +Method in class testopia.API.TestPlan +
  +
makeTestRun(int, int, int, int, int, String) - +Method in class testopia.API.TestRun +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-7.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-7.html new file mode 100644 index 00000000000..97b6afea2c4 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-7.html @@ -0,0 +1,139 @@ + + + + + + +P-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+P

+
+
Product - Class in testopia.API
Allows the user to get a productID from it's name, or it's name from the productID.
Product(String, String, URL) - +Constructor for class testopia.API.Product +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-8.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-8.html new file mode 100644 index 00000000000..b8fb98dc60d --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-8.html @@ -0,0 +1,139 @@ + + + + + + +R-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+R

+
+
removeComponent(int) - +Method in class testopia.API.TestopiaTestCase +
Removes a component to the testCase +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-9.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-9.html new file mode 100644 index 00000000000..e8c34019fd6 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index-files/index-9.html @@ -0,0 +1,229 @@ + + + + + + +S-Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+

+S

+
+
setAlias(String) - +Method in class testopia.API.TestopiaTestCase +
  +
setArguments(String) - +Method in class testopia.API.TestopiaTestCase +
  +
setAssigneeID(int) - +Method in class testopia.API.TestCaseRun +
Changes the assigneeID of the testCaseRun +
setAuthorID(int) - +Method in class testopia.API.TestPlan +
  +
setBuildID(int) - +Method in class testopia.API.TestCaseRun +
Changes the buildID of the testCaseRun +
setBuildID(int) - +Method in class testopia.API.TestRun +
  +
setCanview(boolean) - +Method in class testopia.API.TestopiaTestCase +
  +
setCaseStatusID(String) - +Method in class testopia.API.TestopiaTestCase +
  +
setCategoryID(int) - +Method in class testopia.API.TestopiaTestCase +
  +
setCreationDate(String) - +Method in class testopia.API.TestPlan +
  +
setDefaultProductVersion(String) - +Method in class testopia.API.TestPlan +
  +
setDefaultTesterID(int) - +Method in class testopia.API.TestopiaTestCase +
  +
setEnvironmentID(int) - +Method in class testopia.API.TestCaseRun +
Changes the environmentID of the testCaseRun +
setEnvironmentID(int) - +Method in class testopia.API.TestRun +
  +
setIsActive(boolean) - +Method in class testopia.API.TestPlan +
  +
setIsAutomated(boolean) - +Method in class testopia.API.TestopiaTestCase +
  +
setManagerID(int) - +Method in class testopia.API.TestRun +
  +
setName(String) - +Method in class testopia.API.TestPlan +
  +
setNotes(String) - +Method in class testopia.API.TestCaseRun +
This is used to append a note +
setNotes(String) - +Method in class testopia.API.TestRun +
  +
setPlanID(Integer) - +Method in class testopia.API.TestRun +
  +
setPriorityID(int) - +Method in class testopia.API.TestopiaTestCase +
  +
setProductID(int) - +Method in class testopia.API.TestPlan +
  +
setRequirement(String) - +Method in class testopia.API.TestopiaTestCase +
  +
setScript(String) - +Method in class testopia.API.TestopiaTestCase +
  +
setStartDate(String) - +Method in class testopia.API.TestRun +
  +
setStatus(int) - +Method in class testopia.API.TestCaseRun +
This is used to change the testCaseRun status (2 for pass, 3 for fail) +
setStopDate(String) - +Method in class testopia.API.TestRun +
  +
setSummary(String) - +Method in class testopia.API.TestopiaTestCase +
  +
setSummary(String) - +Method in class testopia.API.TestRun +
  +
setTypeID(int) - +Method in class testopia.API.TestPlan +
  +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated   Index  Help 
+		 + +
+ PREV LETTER  + NEXT LETTER + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C E G M P R S T U
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index.html new file mode 100644 index 00000000000..e9cc5226bc1 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/index.html @@ -0,0 +1,34 @@ + + + + + + +Generated Documentation (Untitled) + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="testopia/API/package-summary.html">Non-frame version.</A> + + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/overview-tree.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/overview-tree.html new file mode 100644 index 00000000000..39068aa928c --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/overview-tree.html @@ -0,0 +1,146 @@ + + + + + + +Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
testopia.API
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/package-list b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/package-list new file mode 100644 index 00000000000..009e108be3c --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/package-list @@ -0,0 +1 @@ +testopia.API diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/resources/inherit.gif b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/resources/inherit.gif new file mode 100644 index 0000000000000000000000000000000000000000..c814867a13deb0ca7ea2156c6ca1d5a03372af7e GIT binary patch literal 57 zcmZ?wbhEHbIIT!9-C*e{wE9>Kx3D)-;0v)C; KYxQGgum%9JOA&7X literal 0 HcmV?d00001 diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/stylesheet.css b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/stylesheet.css new file mode 100644 index 00000000000..6d31fdbc7f0 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF } /* Light mauve */ +.TableRowColor { background: #FFFFFF } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF;} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B;} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Build.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Build.html new file mode 100644 index 00000000000..eca3aad7d42 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Build.html @@ -0,0 +1,339 @@ + + + + + + +Build + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class Build

+
+java.lang.Object
+  extended by testopia.API.Build
+
+
+
+
public class Build
extends java.lang.Object
+ + +

+Allows the user to get a buildID from it's name, or it's name from the buildID. + It can also create and update a build +

+ +

+

+
Author:
+
anelson
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
Build(java.lang.String userName, + java.lang.String password, + java.net.URL url) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetBuildIDByName(java.lang.String buildName) + +
+           
+ java.lang.StringgetBuildNameByID(int id) + +
+           
+ intmakeBuild(java.lang.String name, + int productID, + java.lang.Boolean isactive) + +
+          Creates a new build and returns the buildID, 0 is returned if an error occurs
+ voidupdateBuild(java.lang.String name, + java.lang.String milestone, + java.lang.Boolean isactive, + java.lang.String description, + int buildID) + +
+          Updates builds on testopia with the specified parameters
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Build

+
+public Build(java.lang.String userName,
+             java.lang.String password,
+             java.net.URL url)
+
+
+
Parameters:
userName - - your testopia/bugzilla username
password - - the password for your account
login - - the user you want attributes returned for
url - - the url of the testopia server
+
+ + + + + + + + +
+Method Detail
+ +

+makeBuild

+
+public int makeBuild(java.lang.String name,
+                     int productID,
+                     java.lang.Boolean isactive)
+
+
Creates a new build and returns the buildID, 0 is returned if an error occurs +

+

+
Parameters:
name -
productID -
+
+
+
+ +

+updateBuild

+
+public void updateBuild(java.lang.String name,
+                        java.lang.String milestone,
+                        java.lang.Boolean isactive,
+                        java.lang.String description,
+                        int buildID)
+
+
Updates builds on testopia with the specified parameters +

+

+
Parameters:
name - string - the name of the build. Can be null
milestone - string - the milestone. Can be null
isactive - Boolean - if the build is active. Can be null
description - String - description of the build. Can be null
buildID - int - the buildID
+
+
+
+ +

+getBuildIDByName

+
+public int getBuildIDByName(java.lang.String buildName)
+
+
+
Parameters:
BuildName - the name of the build that the ID will be returned for. 0 Will be + returned if the build can't be found +
Returns:
the ID of the specified product
+
+
+
+ +

+getBuildNameByID

+
+public java.lang.String getBuildNameByID(int id)
+
+
+
Parameters:
id - the ID of the build name that will be returned. Null is returned + if the product can't be found +
Returns:
the product name that corresponds the specified product ID
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Component.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Component.html new file mode 100644 index 00000000000..16b2219052a --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Component.html @@ -0,0 +1,263 @@ + + + + + + +Component + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class Component

+
+java.lang.Object
+  extended by testopia.API.Component
+
+
+
+
public class Component
extends java.lang.Object
+ + +

+Allows the user to get a hashmap of the component values by inputing the component ID +

+ +

+

+
Author:
+
anelson
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
Component(java.lang.String userName, + java.lang.String password, + java.net.URL url) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ java.util.HashMap<java.lang.String,java.lang.Object>getComponentByID(int id) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Component

+
+public Component(java.lang.String userName,
+                 java.lang.String password,
+                 java.net.URL url)
+
+
+
Parameters:
userName - - your testopia/bugzilla username
password - - the password for your account
url - - the url of the testopia server
+
+ + + + + + + + +
+Method Detail
+ +

+getComponentByID

+
+public java.util.HashMap<java.lang.String,java.lang.Object> getComponentByID(int id)
+
+
+
Parameters:
id - the ID of the component that will be returned. Null is returned + if the component can't be found +
Returns:
the product name that corresponds the specified product ID
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Environment.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Environment.html new file mode 100644 index 00000000000..57b5d92e2af --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Environment.html @@ -0,0 +1,319 @@ + + + + + + +Environment + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class Environment

+
+java.lang.Object
+  extended by testopia.API.Environment
+
+
+
+
public class Environment
extends java.lang.Object
+ + +

+Allows the user to get an environment from it's ID. It can also create + and update an environment +

+ +

+

+
Author:
+
anelson
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
Environment(java.lang.String userName, + java.lang.String password, + java.net.URL url) + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.HashMap<java.lang.String,java.lang.Object>getEnvirnoment(int environmentID) + +
+          Returns the environmnet as a HashMap or null if environment can't be found
+ intmakeEnvironment(java.lang.String name, + int productID, + boolean isActive) + +
+          Creates a new environment and returns the environmentID, 0 is returned + if an error occurs
+ voidupdateEnvironment(java.lang.String name, + java.lang.Boolean isactive, + java.lang.Integer productID, + int environmentID) + +
+          Updates the environment on testopia with the specified parameters
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Environment

+
+public Environment(java.lang.String userName,
+                   java.lang.String password,
+                   java.net.URL url)
+
+
+
Parameters:
userName - - your testopia/bugzilla username
password - - the password for your account
login - - the user you want attributes returned for
url - - the url of the testopia server
+
+ + + + + + + + +
+Method Detail
+ +

+makeEnvironment

+
+public int makeEnvironment(java.lang.String name,
+                           int productID,
+                           boolean isActive)
+
+
Creates a new environment and returns the environmentID, 0 is returned + if an error occurs +

+

+
Parameters:
name -
productID -
+
+
+
+ +

+updateEnvironment

+
+public void updateEnvironment(java.lang.String name,
+                              java.lang.Boolean isactive,
+                              java.lang.Integer productID,
+                              int environmentID)
+
+
Updates the environment on testopia with the specified parameters +

+

+
Parameters:
name - string - the name of the build. Can be null
milestone - string - the milestone. Can be null
isactive - Boolean - if the build is active. Can be null
description - String - description of the build. Can be null
buildID - int - the buildID
+
+
+
+ +

+getEnvirnoment

+
+public java.util.HashMap<java.lang.String,java.lang.Object> getEnvirnoment(int environmentID)
+
+
Returns the environmnet as a HashMap or null if environment can't be found +

+

+
Parameters:
environmentName - +
Returns:
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Product.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Product.html new file mode 100644 index 00000000000..ccad579794e --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/Product.html @@ -0,0 +1,304 @@ + + + + + + +Product + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class Product

+
+java.lang.Object
+  extended by testopia.API.Product
+
+
+
+
public class Product
extends java.lang.Object
+ + +

+Allows the user to get a productID from it's name, or it's name from the productID. It's also able to return a + product's milestones'. +

+ +

+

+
Author:
+
anelson
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
Product(java.lang.String userName, + java.lang.String password, + java.net.URL url) + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.Object[]getMilestones(int id) + +
+           
+ intgetProductIDByName(java.lang.String productName) + +
+           
+ java.lang.StringgetProductNameByID(int id) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Product

+
+public Product(java.lang.String userName,
+               java.lang.String password,
+               java.net.URL url)
+
+
+
Parameters:
userName - - your testopia/bugzilla username
password - - the password for your account
login - - the user you want attributes returned for
url - - the url of the testopia server
+
+ + + + + + + + +
+Method Detail
+ +

+getProductIDByName

+
+public int getProductIDByName(java.lang.String productName)
+
+
+
Parameters:
productName - the name of the product, that the ID will be returned for. 0 Will be + returned if the product can't be found +
Returns:
the ID of the specified product
+
+
+
+ +

+getProductNameByID

+
+public java.lang.String getProductNameByID(int id)
+
+
+
Parameters:
id - the ID of the product name that will be returned. Null is returned + if the product can't be found +
Returns:
the product name that corresponds the specified product ID
+
+
+
+ +

+getMilestones

+
+public java.lang.Object[] getMilestones(int id)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestAPI.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestAPI.html new file mode 100644 index 00000000000..3fe8bed685c --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestAPI.html @@ -0,0 +1,247 @@ + + + + + + +TestAPI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class TestAPI

+
+java.lang.Object
+  extended by testopia.API.TestAPI
+
+
+
+
public class TestAPI
extends java.lang.Object
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TestAPI() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(java.lang.String[] args) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TestAPI

+
+public TestAPI()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(java.lang.String[] args)
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestCaseRun.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestCaseRun.html new file mode 100644 index 00000000000..c1d7246191f --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestCaseRun.html @@ -0,0 +1,453 @@ + + + + + + +TestCaseRun + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class TestCaseRun

+
+java.lang.Object
+  extended by testopia.API.TestCaseRun
+
+
+
+
public class TestCaseRun
extends java.lang.Object
+ + +

+

+
Author:
+
anelson, bstice + Creates a wrapper class for the TestRunCase
+
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
TestCaseRun(java.lang.String userName, + java.lang.String password, + int caseID, + int runID, + int buildID, + int environmentID, + java.lang.Integer caseRunID, + java.net.URL url) + +
+          Use this constructor if you want to do sets and gets
TestCaseRun(java.lang.String userName, + java.lang.String password, + int caseRunID, + java.net.URL url) + +
+          Use this constructor if you just want to use gets
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.HashMap<java.lang.String,java.lang.Object>getAttributes() + +
+           
+ intmakeTestCaseRun(int assigneeID, + int caseTextVersion) + +
+          used to create a testRunCase
+ voidsetAssigneeID(int assigneeID) + +
+          Changes the assigneeID of the testCaseRun
+ voidsetBuildID(int buildID) + +
+          Changes the buildID of the testCaseRun
+ voidsetEnvironmentID(int environmentID) + +
+          Changes the environmentID of the testCaseRun
+ voidsetNotes(java.lang.String notes) + +
+          This is used to append a note
+ voidsetStatus(int status) + +
+          This is used to change the testCaseRun status (2 for pass, 3 for fail)
+ voidupdate() + +
+          Updates are not called when the .set is used.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TestCaseRun

+
+public TestCaseRun(java.lang.String userName,
+                   java.lang.String password,
+                   int caseRunID,
+                   java.net.URL url)
+
+
Use this constructor if you just want to use gets +

+

+
Parameters:
userName - your bugzilla username
password - your bugzilla password
caseRunID - ID used to get the case
url - URL - the url of the testopia server that you want to connect to
+
+
+ +

+TestCaseRun

+
+public TestCaseRun(java.lang.String userName,
+                   java.lang.String password,
+                   int caseID,
+                   int runID,
+                   int buildID,
+                   int environmentID,
+                   java.lang.Integer caseRunID,
+                   java.net.URL url)
+
+
Use this constructor if you want to do sets and gets +

+

+
Parameters:
userName - your bugzilla username
password - your bugzilla password
caseRunID - ID used to get the case
runID - test run number
buildID - ID generated by bugzilla
environmentID - ID generated by bugzilla
url - URL - the url of the testopia server that you want to connect to
+
+ + + + + + + + +
+Method Detail
+ +

+makeTestCaseRun

+
+public int makeTestCaseRun(int assigneeID,
+                           int caseTextVersion)
+                    throws java.lang.Exception
+
+
used to create a testRunCase +

+

+
Parameters:
assigneeID -
caseRunStatusID -
caseTextVersion - +
Returns:
+
Throws: +
java.lang.Exception
+
+
+
+ +

+update

+
+public void update()
+            throws java.lang.Exception
+
+
Updates are not called when the .set is used. You must call update after all your sets + to push the changes over to testopia. +

+

+ +
Throws: +
java.lang.Exception - will throw an exception if you used the 3 param constuctor.
+
+
+
+ +

+getAttributes

+
+public java.util.HashMap<java.lang.String,java.lang.Object> getAttributes()
+
+
+ +
Returns:
a hashMap of all the values found. Returns null if there is an error + and the TestCaseRun cannot be returned
+
+
+
+ +

+setNotes

+
+public void setNotes(java.lang.String notes)
+
+
This is used to append a note +

+

+
Parameters:
notes - string - the note you want entered into the testCaseRun
+
+
+
+ +

+setStatus

+
+public void setStatus(int status)
+
+
This is used to change the testCaseRun status (2 for pass, 3 for fail) +

+

+
Parameters:
status - int - the status you want to change the testCaseRun to
+
+
+
+ +

+setBuildID

+
+public void setBuildID(int buildID)
+
+
Changes the buildID of the testCaseRun +

+

+
Parameters:
buildID - int - the new buildID
+
+
+
+ +

+setEnvironmentID

+
+public void setEnvironmentID(int environmentID)
+
+
Changes the environmentID of the testCaseRun +

+

+
Parameters:
environmentID - int - the number that the environment ID will be changed to
+
+
+
+ +

+setAssigneeID

+
+public void setAssigneeID(int assigneeID)
+
+
Changes the assigneeID of the testCaseRun +

+

+
Parameters:
assigneeID -
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestPlan.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestPlan.html new file mode 100644 index 00000000000..5441cbc3554 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestPlan.html @@ -0,0 +1,608 @@ + + + + + + +TestPlan + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class TestPlan

+
+java.lang.Object
+  extended by testopia.API.TestPlan
+
+
+
+
public class TestPlan
extends java.lang.Object
+ + +

+Creates a test plan object, that allows the user to create, change and get test plan values +

+ +

+

+
Author:
+
anelson
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
TestPlan(java.lang.String userName, + java.lang.String password, + java.net.URL url, + java.lang.Integer planID) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.HashMap<java.lang.String,java.lang.Object>getAttributes() + +
+          Gets the attributes of the test plan, planID must not be null
+ java.lang.Object[]getBuilds() + +
+           
+ java.util.HashMap<java.lang.String,java.lang.Object>getCategories() + +
+           
+ java.lang.Object[]getComponents() + +
+           
+static java.lang.Object[]getList(java.lang.String userName, + java.lang.String password, + java.net.URL url, + java.util.HashMap<java.lang.String,java.lang.Object> values) + +
+          Returns hashmap(s) of testplans that match the inputed values
+ java.lang.Object[]getTestCases() + +
+           
+ java.lang.Object[]getTestRuns() + +
+           
+ intmakeTestPlan(java.lang.String authorID, + java.lang.String productID, + java.lang.String defaultProductVersion, + java.lang.String typeID, + java.lang.String name) + +
+           
+ voidsetAuthorID(int authorID) + +
+           
+ voidsetCreationDate(java.lang.String creationDate) + +
+           
+ voidsetDefaultProductVersion(java.lang.String defaultProductVersion) + +
+           
+ voidsetIsActive(boolean isActive) + +
+           
+ voidsetName(java.lang.String name) + +
+           
+ voidsetProductID(int productID) + +
+           
+ voidsetTypeID(int typeID) + +
+           
+ voidupdate() + +
+          Updates are not called when the .set is used.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TestPlan

+
+public TestPlan(java.lang.String userName,
+                java.lang.String password,
+                java.net.URL url,
+                java.lang.Integer planID)
+
+
+
Parameters:
userName - your bugzilla/testopia userName
password - your password
url - the url of the testopia server
planID - - Integer the planID, you may enter null here if you are creating a test plan
+
+ + + + + + + + +
+Method Detail
+ +

+makeTestPlan

+
+public int makeTestPlan(java.lang.String authorID,
+                        java.lang.String productID,
+                        java.lang.String defaultProductVersion,
+                        java.lang.String typeID,
+                        java.lang.String name)
+
+
+
Parameters:
authorID - the bugzilla/testopia ID of the author
productID - the bugzilla/testopia ID of the product
defaultProductVersion -
typeID -
name - the name of the test plan +
Returns:
the ID of the test plan
+
+
+
+ +

+update

+
+public void update()
+            throws java.lang.Exception
+
+
Updates are not called when the .set is used. You must call update after all your sets + to push the changes over to testopia. +

+

+ +
Throws: +
java.lang.Exception - if planID is null + (you made the TestPlan with a null planID and have not created a new test plan)
+
+
+
+ +

+setAuthorID

+
+public void setAuthorID(int authorID)
+
+
+
Parameters:
authorID - int - the bugzilla authorID that the TestPlan will be changed to
+
+
+
+ +

+setDefaultProductVersion

+
+public void setDefaultProductVersion(java.lang.String defaultProductVersion)
+
+
+
Parameters:
defaultProductVersion - String - the default product version the test plan will be changed to
+
+
+
+ +

+setCreationDate

+
+public void setCreationDate(java.lang.String creationDate)
+
+
+
Parameters:
creationDate - String - the creation date the test plan will be changed to (Format: yyyy-mm-dd hh:mm:ss)
+
+
+
+ +

+setIsActive

+
+public void setIsActive(boolean isActive)
+
+
+
Parameters:
isActive - boolean - change if the test plan is active or not
+
+
+
+ +

+setName

+
+public void setName(java.lang.String name)
+
+
+
Parameters:
name - String - the new name of the test plan
+
+
+
+ +

+setProductID

+
+public void setProductID(int productID)
+
+
+
Parameters:
productID - int - the new product ID of the test plan
+
+
+
+ +

+setTypeID

+
+public void setTypeID(int typeID)
+
+
+
Parameters:
typeID - int - the new type of the test plan
+
+
+
+ +

+getAttributes

+
+public java.util.HashMap<java.lang.String,java.lang.Object> getAttributes()
+                                                                   throws java.lang.Exception
+
+
Gets the attributes of the test plan, planID must not be null +

+

+ +
Returns:
a hashMap of all the values found. Returns null if there is an error + and the TestPlan cannot be returned +
Throws: +
java.lang.Exception
+
+
+
+ +

+getCategories

+
+public java.util.HashMap<java.lang.String,java.lang.Object> getCategories()
+                                                                   throws java.lang.Exception
+
+
+ +
Returns:
a hashMap of all the values found. Returns null if there is an error + and the TestPlan cannot be returned +
Throws: +
java.lang.Exception
+
+
+
+ +

+getBuilds

+
+public java.lang.Object[] getBuilds()
+                             throws java.lang.Exception
+
+
+ +
Returns:
an array of objects (Object[]) of all the values found for the builds. + Returns null if there is an error and the TestPlan cannot be returned +
Throws: +
java.lang.Exception
+
+
+
+ +

+getComponents

+
+public java.lang.Object[] getComponents()
+                                 throws java.lang.Exception
+
+
+ +
Returns:
an array of objects (Object[]) of all the components found. + Returns null if there is an error and the TestPlan cannot be returned +
Throws: +
java.lang.Exception
+
+
+
+ +

+getList

+
+public static java.lang.Object[] getList(java.lang.String userName,
+                                         java.lang.String password,
+                                         java.net.URL url,
+                                         java.util.HashMap<java.lang.String,java.lang.Object> values)
+
+
Returns hashmap(s) of testplans that match the inputed values +

+

+
Parameters:
userName - your bugzilla/testopia userName
password - your password
url - the url of the testopia server
values - a HashMap with the parameters that will be searched for + if you supply the pair "plan_id", 5 then plan_id 5 will be returned. Any combination + of testplan attributes can be entered and the result will be all matches that fit + the inputed values +
Returns:
+
+
+
+ +

+getTestCases

+
+public java.lang.Object[] getTestCases()
+                                throws java.lang.Exception
+
+
+ +
Returns:
an array of objects (Object[]) of all the testcases found. + Returns null if there is an error and the TestPlan cannot be returned +
Throws: +
java.lang.Exception
+
+
+
+ +

+getTestRuns

+
+public java.lang.Object[] getTestRuns()
+                               throws java.lang.Exception
+
+
+ +
Returns:
an array of objects (Object[]) of all the test runs found. + Returns null if there is an error and the TestPlan cannot be returned +
Throws: +
java.lang.Exception
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestRun.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestRun.html new file mode 100644 index 00000000000..5b7d2ec05a1 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestRun.html @@ -0,0 +1,545 @@ + + + + + + +TestRun + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class TestRun

+
+java.lang.Object
+  extended by testopia.API.TestRun
+
+
+
+
public class TestRun
extends java.lang.Object
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TestRun(java.lang.String userName, + java.lang.String password, + java.net.URL url, + java.lang.Integer runID) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.HashMap<java.lang.String,java.lang.Object>getAttributes() + +
+          Gets the attributes of the test run, runID must not be null
+static java.lang.Object[]getList(java.lang.String userName, + java.lang.String password, + java.net.URL url, + java.util.HashMap<java.lang.String,java.lang.Object> values) + +
+          Returns hashmap(s) of testplans that match the inputed values
+ java.lang.Object[]getTestCaseRuns() + +
+           
+ java.lang.Object[]getTestCases() + +
+           
+ intmakeTestRun(int buildID, + int environmentID, + int managerID, + int planID, + int planTextVersion, + java.lang.String summary) + +
+           
+ voidsetBuildID(int buildID) + +
+           
+ voidsetEnvironmentID(int environmentID) + +
+           
+ voidsetManagerID(int managerID) + +
+           
+ voidsetNotes(java.lang.String notes) + +
+           
+ voidsetPlanID(java.lang.Integer newPlanID) + +
+           
+ voidsetStartDate(java.lang.String startDate) + +
+           
+ voidsetStopDate(java.lang.String stopDate) + +
+           
+ voidsetSummary(java.lang.String summary) + +
+           
+ voidupdate() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TestRun

+
+public TestRun(java.lang.String userName,
+               java.lang.String password,
+               java.net.URL url,
+               java.lang.Integer runID)
+
+
+
Parameters:
userName - your bugzilla/testopia userName
password - your password
url - the url of the testopia server
runID - - Integer the runID, you may enter null here if you are creating a test run
+
+ + + + + + + + +
+Method Detail
+ +

+setBuildID

+
+public void setBuildID(int buildID)
+
+
+
Parameters:
buildID - int - the new builID
+
+
+
+ +

+setEnvironmentID

+
+public void setEnvironmentID(int environmentID)
+
+
+
Parameters:
environmentID - int = the new environemnetID
+
+
+
+ +

+setManagerID

+
+public void setManagerID(int managerID)
+
+
+
Parameters:
managerID - int - the new managerID
+
+
+
+ +

+setNotes

+
+public void setNotes(java.lang.String notes)
+
+
+
Parameters:
notes - String - the new notes
+
+
+
+ +

+setStartDate

+
+public void setStartDate(java.lang.String startDate)
+
+
+
Parameters:
startDate - String - the new startDate (Format: yyyy-mm-dd hh:mm:ss)
+
+
+
+ +

+setStopDate

+
+public void setStopDate(java.lang.String stopDate)
+
+
+
Parameters:
stopDate - String - the new stopDate (Format: yyyy-mm-dd hh:mm:ss)
+
+
+
+ +

+setSummary

+
+public void setSummary(java.lang.String summary)
+
+
+
Parameters:
summary - String - the new summary
+
+
+
+ +

+setPlanID

+
+public void setPlanID(java.lang.Integer newPlanID)
+
+
+
Parameters:
newPlanID - int - the plan that the test run now belongs to
+
+
+
+ +

+update

+
+public void update()
+            throws java.lang.Exception
+
+
+ +
Throws: +
java.lang.Exception
+
+
+
+ +

+getAttributes

+
+public java.util.HashMap<java.lang.String,java.lang.Object> getAttributes()
+                                                                   throws java.lang.Exception
+
+
Gets the attributes of the test run, runID must not be null +

+

+ +
Returns:
a hashMap of all the values found. Returns null if there is an error + and the TestRun cannot be returned +
Throws: +
java.lang.Exception
+
+
+
+ +

+getList

+
+public static java.lang.Object[] getList(java.lang.String userName,
+                                         java.lang.String password,
+                                         java.net.URL url,
+                                         java.util.HashMap<java.lang.String,java.lang.Object> values)
+
+
Returns hashmap(s) of testplans that match the inputed values +

+

+
Parameters:
userName - your bugzilla/testopia userName
password - your password
url - the url of the testopia server
values - a HashMap with the parameters that will be searched for + if you supply the pair "run_id", 5 then run_id 5 will be returned. Any combination + of testrun attributes can be entered and the result will be all matches that fit + the inputed values +
Returns:
+
+
+
+ +

+makeTestRun

+
+public int makeTestRun(int buildID,
+                       int environmentID,
+                       int managerID,
+                       int planID,
+                       int planTextVersion,
+                       java.lang.String summary)
+
+
+
Parameters:
buildID -
environmentID -
managerID -
planID - int - the ID of the plan the run will be added to
planTextVersion -
summary - String - text summary of the run +
Returns:
the ID of the test run
+
+
+
+ +

+getTestCases

+
+public java.lang.Object[] getTestCases()
+                                throws java.lang.Exception
+
+
+ +
Returns:
an array of objects (Object[]) of all the testcases found. + Returns null if there is an error and the TestRun cannot be returned +
Throws: +
java.lang.Exception
+
+
+
+ +

+getTestCaseRuns

+
+public java.lang.Object[] getTestCaseRuns()
+                                   throws java.lang.Exception
+
+
+ +
Returns:
an array of objects (Object[]) of all the testCaseRuns found. + Returns null if there is an error and the TestRun cannot be found +
Throws: +
java.lang.Exception
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestopiaTestCase.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestopiaTestCase.html new file mode 100644 index 00000000000..dc28e9b4ac0 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/TestopiaTestCase.html @@ -0,0 +1,660 @@ + + + + + + +TestopiaTestCase + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class TestopiaTestCase

+
+java.lang.Object
+  extended by testopia.API.TestopiaTestCase
+
+
+
+
public class TestopiaTestCase
extends java.lang.Object
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
TestopiaTestCase(java.lang.String userName, + java.lang.String password, + java.net.URL url, + java.lang.Integer caseID) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddComponent(int componentID) + +
+          Adds a component to the testCase
+ java.util.HashMap<java.lang.String,java.lang.Object>getAttributes() + +
+          Gets the attributes of the test case, caseID must not be null
+ intgetBuildIDByName(java.lang.String categoryName) + +
+           
+ java.lang.Object[]getComponents() + +
+          Gets the components as an array of hashMaps or null if + an error occurs
+static java.lang.Object[]getList(java.lang.String userName, + java.lang.String password, + java.net.URL url, + java.util.HashMap<java.lang.String,java.lang.Object> values) + +
+          Returns hashmap(s) of testcases that match the inputed values
+ intmakeTestCase(int authorID, + int caseStatusID, + int categoryID, + boolean isAutomated, + int planID, + java.lang.String summary, + java.lang.Integer priorityID) + +
+           
+ voidremoveComponent(int componentID) + +
+          Removes a component to the testCase
+ voidsetAlias(java.lang.String alias) + +
+           
+ voidsetArguments(java.lang.String arguments) + +
+           
+ voidsetCanview(boolean canview) + +
+           
+ voidsetCaseStatusID(java.lang.String caseStatusID) + +
+           
+ voidsetCategoryID(int categoryID) + +
+           
+ voidsetDefaultTesterID(int defaultTesterID) + +
+           
+ voidsetIsAutomated(boolean isAutomated) + +
+           
+ voidsetPriorityID(int priorityID) + +
+           
+ voidsetRequirement(java.lang.String requirement) + +
+           
+ voidsetScript(java.lang.String script) + +
+           
+ voidsetSummary(java.lang.String summary) + +
+           
+ voidupdate() + +
+          Updates are not called when the .set is used.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+TestopiaTestCase

+
+public TestopiaTestCase(java.lang.String userName,
+                        java.lang.String password,
+                        java.net.URL url,
+                        java.lang.Integer caseID)
+
+
+
Parameters:
userName - your bugzilla/testopia userName
password - your password
url - the url of the testopia server
caseID - - Integer the caseID, you may enter null here if you are creating a test case
+
+ + + + + + + + +
+Method Detail
+ +

+setAlias

+
+public void setAlias(java.lang.String alias)
+
+
+
Parameters:
alias - String - the new Alias
+
+
+
+ +

+setArguments

+
+public void setArguments(java.lang.String arguments)
+
+
+
Parameters:
arguments - String - the new arguments
+
+
+
+ +

+setCanview

+
+public void setCanview(boolean canview)
+
+
+
Parameters:
canview -
+
+
+
+ +

+setCaseStatusID

+
+public void setCaseStatusID(java.lang.String caseStatusID)
+
+
+
Parameters:
caseStatusID - String - the new case Status ID
+
+
+
+ +

+setCategoryID

+
+public void setCategoryID(int categoryID)
+
+
+
Parameters:
categoryID - int - the new categorID
+
+
+
+ +

+setDefaultTesterID

+
+public void setDefaultTesterID(int defaultTesterID)
+
+
+
Parameters:
defaultTesterID - int - the new defaultTesterID
+
+
+
+ +

+setIsAutomated

+
+public void setIsAutomated(boolean isAutomated)
+
+
+
Parameters:
isAutomated - boolean - true if it's to be set automated, + false otherwise
+
+
+
+ +

+setPriorityID

+
+public void setPriorityID(int priorityID)
+
+
+
Parameters:
priorityID - - int the new priorityID
+
+
+
+ +

+setRequirement

+
+public void setRequirement(java.lang.String requirement)
+
+
+
Parameters:
requirement - String - the new requirement
+
+
+
+ +

+setScript

+
+public void setScript(java.lang.String script)
+
+
+
Parameters:
script - String - the new script
+
+
+
+ +

+setSummary

+
+public void setSummary(java.lang.String summary)
+
+
+
Parameters:
summary - String - the new summary
+
+
+
+ +

+addComponent

+
+public void addComponent(int componentID)
+                  throws java.lang.Exception
+
+
Adds a component to the testCase +

+

+
Parameters:
componentID - the ID of the component that will be added to the + testCase +
Throws: +
java.lang.Exception
+
+
+
+ +

+removeComponent

+
+public void removeComponent(int componentID)
+                     throws java.lang.Exception
+
+
Removes a component to the testCase +

+

+
Parameters:
componentID - the ID of the component that will be removed from the + testCase +
Throws: +
java.lang.Exception
+
+
+
+ +

+getComponents

+
+public java.lang.Object[] getComponents()
+                                 throws java.lang.Exception
+
+
Gets the components as an array of hashMaps or null if + an error occurs +

+

+ +
Returns:
an array of component hashMaps or null +
Throws: +
java.lang.Exception
+
+
+
+ +

+update

+
+public void update()
+            throws java.lang.Exception
+
+
Updates are not called when the .set is used. You must call update after all your sets + to push the changes over to testopia. +

+

+ +
Throws: +
java.lang.Exception - if planID is null + (you made the TestCase with a null caseID and have not created a new test plan)
+
+
+
+ +

+makeTestCase

+
+public int makeTestCase(int authorID,
+                        int caseStatusID,
+                        int categoryID,
+                        boolean isAutomated,
+                        int planID,
+                        java.lang.String summary,
+                        java.lang.Integer priorityID)
+
+
+
Parameters:
authorID - the bugzilla/testopia ID of the author
caseStatusID -
categoryID -
isAutomated -
planID - the ID of the plan the testCase will be added to
summary - string - the summary of the testCase. Null allowed
priorityID - Integer - the priority of the testCase (0-5). Null allowed +
Returns:
+
+
+
+ +

+getAttributes

+
+public java.util.HashMap<java.lang.String,java.lang.Object> getAttributes()
+                                                                   throws java.lang.Exception
+
+
Gets the attributes of the test case, caseID must not be null +

+

+ +
Returns:
a hashMap of all the values found. Returns null if there is an error + and the TestCase cannot be returned +
Throws: +
java.lang.Exception
+
+
+
+ +

+getList

+
+public static java.lang.Object[] getList(java.lang.String userName,
+                                         java.lang.String password,
+                                         java.net.URL url,
+                                         java.util.HashMap<java.lang.String,java.lang.Object> values)
+
+
Returns hashmap(s) of testcases that match the inputed values +

+

+
Parameters:
userName - your bugzilla/testopia userName
password - your password
url - the url of the testopia server
values - a HashMap with the parameters that will be searched for + if you supply the pair "case_id", 5 then case_id 5 will be returned. Any combination + of testcase attributes can be entered and the result will be all the matches that fit + the inputed values +
Returns:
+
+
+
+ +

+getBuildIDByName

+
+public int getBuildIDByName(java.lang.String categoryName)
+
+
+
Parameters:
categoryName - the name of the category that the ID will be returned for. This will search within the + test plans that this test case belongs to and return the first category with a matching name. 0 Will be + returned if the category can't be found +
Returns:
the ID of the specified product
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/User.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/User.html new file mode 100644 index 00000000000..f32bfb7cd98 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/User.html @@ -0,0 +1,262 @@ + + + + + + +User + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +testopia.API +
+Class User

+
+java.lang.Object
+  extended by testopia.API.User
+
+
+
+
public class User
extends java.lang.Object
+ + +

+

+
Author:
+
anelson, bstice + Retrives the user ID for the inputed email
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
User(java.lang.String userName, + java.lang.String password, + java.lang.String login, + java.net.URL url) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ intgetAttributes() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+User

+
+public User(java.lang.String userName,
+            java.lang.String password,
+            java.lang.String login,
+            java.net.URL url)
+
+
+
Parameters:
userName - - your testopia/bugzilla username
password - - the password for your account
login - - the user you want attributes returned for
url - - the url of the testopia server
+
+ + + + + + + + +
+Method Detail
+ +

+getAttributes

+
+public int getAttributes()
+
+
+ +
Returns:
the user_id for the specified login. Returns 0 if there is + an error and the user ID cannot be returned
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Build.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Build.html new file mode 100644 index 00000000000..e0995b05b1f --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Build.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.Build + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.Build

+
+No usage of testopia.API.Build +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Component.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Component.html new file mode 100644 index 00000000000..85c706bed4d --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Component.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.Component + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.Component

+
+No usage of testopia.API.Component +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Environment.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Environment.html new file mode 100644 index 00000000000..1eb236afff6 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Environment.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.Environment + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.Environment

+
+No usage of testopia.API.Environment +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Product.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Product.html new file mode 100644 index 00000000000..3a73ae5915e --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/Product.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.Product + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.Product

+
+No usage of testopia.API.Product +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestAPI.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestAPI.html new file mode 100644 index 00000000000..6a9aa95c614 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestAPI.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.TestAPI + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.TestAPI

+
+No usage of testopia.API.TestAPI +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestCaseRun.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestCaseRun.html new file mode 100644 index 00000000000..420aa3a9ee8 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestCaseRun.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.TestCaseRun + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.TestCaseRun

+
+No usage of testopia.API.TestCaseRun +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestPlan.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestPlan.html new file mode 100644 index 00000000000..7bbf1cf180d --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestPlan.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.TestPlan + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.TestPlan

+
+No usage of testopia.API.TestPlan +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestRun.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestRun.html new file mode 100644 index 00000000000..8dcdb4fdaa0 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestRun.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.TestRun + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.TestRun

+
+No usage of testopia.API.TestRun +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestopiaTestCase.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestopiaTestCase.html new file mode 100644 index 00000000000..3879cbd6a91 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/TestopiaTestCase.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.TestopiaTestCase + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.TestopiaTestCase

+
+No usage of testopia.API.TestopiaTestCase +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/User.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/User.html new file mode 100644 index 00000000000..8a925fbf0cd --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/class-use/User.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Class testopia.API.User + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
testopia.API.User

+
+No usage of testopia.API.User +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-frame.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-frame.html new file mode 100644 index 00000000000..70a27251468 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-frame.html @@ -0,0 +1,48 @@ + + + + + + +testopia.API + + + + + + + + + + + +testopia.API + + + + +
+Classes  + +
+Build +
+Component +
+Environment +
+Product +
+TestCaseRun +
+TestopiaTestCase +
+TestPlan +
+TestRun +
+User
+ + + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-summary.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-summary.html new file mode 100644 index 00000000000..113e3651720 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-summary.html @@ -0,0 +1,184 @@ + + + + + + +testopia.API + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package testopia.API +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
BuildAllows the user to get a buildID from it's name, or it's name from the buildID.
ComponentAllows the user to get a hashmap of the component values by inputing the component ID
EnvironmentAllows the user to get an environment from it's ID.
ProductAllows the user to get a productID from it's name, or it's name from the productID.
TestCaseRun 
TestopiaTestCase 
TestPlanCreates a test plan object, that allows the user to create, change and get test plan values
TestRun 
User 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-tree.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-tree.html new file mode 100644 index 00000000000..b45af43fac1 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-tree.html @@ -0,0 +1,144 @@ + + + + + + +testopia.API Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package testopia.API +

+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-use.html b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-use.html new file mode 100644 index 00000000000..2ca5bcf811d --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/doc/testopia/API/package-use.html @@ -0,0 +1,138 @@ + + + + + + +Uses of Package testopia.API + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
testopia.API

+
+No usage of testopia.API +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/jar/README b/mozilla/webtools/testopia/testopia/contrib/drivers/java/jar/README new file mode 100644 index 00000000000..a07309279bd --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/jar/README @@ -0,0 +1,19 @@ +The following Java jar files belong in this directory: + +http://www.jdom.org/downloads/index.html +---------------------------------------- +jdom.jar + +http://ws.apache.org/commons/util/project-info.html +-------------------------------------------------- +ws-commons-util-1.0.1.jar +ws-commons-util-1.0.1-sources.jar + +http://ws.apache.org/xmlrpc/download.html +----------------------------------------- +xmlrpc-client-3.0rc1.jar +xmlrpc-client-3.0rc1-sources.jar +xmlrpc-common-3.0rc1.jar +xmlrpc-common-3.0rc1-sources.jar +xmlrpc-server-3.0rc1.jar +xmlrpc-server-3.0rc1-sources.jar diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Build.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Build.java new file mode 100644 index 00000000000..558107a0368 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Build.java @@ -0,0 +1,326 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * Jason Sabin + * + */package testopia.API; +import java.net.URL; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.HashMap; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.xmlrpc.client.XmlRpcClient; +import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; + +/** + * Allows the user to get a buildID from it's name, or it's name from the buildID. + * It can also create and update a build + * @author anelson + * + */ +public class Build { + private String userName; + private String password; + private URL url; + + + /** + * + * @param userName - your testopia/bugzilla username + * @param password - the password for your account + * @param login - the user you want attributes returned for + * @param url - the url of the testopia server + */ + public Build(String userName, String password, URL url) + { + this.userName = userName; + this.password = password; + this.url = url; + } + + + /** + * Creates a new build and returns the buildID, 0 is returned if an error occurs + * @param name + * @param productID + */ + public int makeBuild(String name, int productID, Boolean isactive, String milestone) + { + int result = 0; + + //Check if the build already exists. Will return a 0 if the build does not exist + int buildTest = getBuildIDByName(name); + + if(buildTest == 0){ + //Build does not exist so we need to create a new build + + HashMap map = new HashMap(); + map.put("name", name); + map.put("product_id", productID); + map.put("milestone", milestone); + + //1 for true, 0 for false + if(isactive) + map.put("isactive", 1); + else + map.put("isactive", 0); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the build + params.add(map); + + //get the result + result = (Integer)client.execute("Build.create",params); + return result; + + //System.out.println(result); + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + } + else{ + //Build already exists + System.out.println("-->Build "+name+" already exists will not create build"); + //Make sure we don't forget to set the buildID + result = buildTest; + return result; + } + } + + /** + * Updates builds on testopia with the specified parameters + * @param name string - the name of the build. Can be null + * @param milestone string - the milestone. Can be null + * @param isactive Boolean - if the build is active. Can be null + * @param description String - description of the build. Can be null + * @param buildID int - the buildID + */ + public void updateBuild(String name, String milestone, Boolean isactive, + String description, int buildID) + { + //put values into map if they are not null + HashMap map = new HashMap(); + if(name != null) + map.put("name", name); + if(milestone != null) + map.put("milestone", milestone); + if(isactive != null) + { + //put 1 into map if true + if(isactive) + map.put("isactive", 1); + //else put false + else + map.put("isactive", 0); + } + + if(description != null) + map.put("description", description); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the build + params.add(buildID); + params.add(map); + + //get the result + HashMap result = (HashMap)client.execute("Build.update",params); + + //System.out.println(result); + + } + + catch (Exception e) + { + e.printStackTrace(); + + } + + } + + /** + * + * @param BuildName the name of the build that the ID will be returned for. 0 Will be + * returned if the build can't be found + * @return the ID of the specified product + */ + public int getBuildIDByName(String buildName) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the build + params.add(buildName); + + //get the result + int result = (Integer)client.execute("Build.lookup_id_by_name",params); + + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + } + + /** + * + * @param id the ID of the build name that will be returned. Null is returned + * if the product can't be found + * @return the product name that corresponds the specified product ID + */ + public String getBuildNameByID(int id) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the build + params.add(id); + + //get the result + String result = (String)client.execute("Build.lookup_id_by_name", params); + + //System.out.println(result); + + return result; + + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + + + /** + * + * @return the XML client used to connect to and modify TestCaseRun + */ + private XmlRpcClient getXMLclient() throws Exception + { + try + { + + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + return client; + } + + catch (Exception e) + { + e.printStackTrace(); + } + + throw new Exception("could not connect to server"); + } + + private static void TrustAllCerts() + throws java.security.NoSuchAlgorithmException, + java.security.KeyManagementException + { + // Create a trust manager that does not validate certificate chains + + TrustManager[] trustAllCerts = new TrustManager[] + { + new X509TrustManager() + { + public X509Certificate[] getAcceptedIssuers() + { + return null; + } + + public void checkClientTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + + public void checkServerTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + } + }; + + // Install the all-trusting trust manager + SSLContext sc = SSLContext.getInstance("SSL"); + + // Create empty HostnameVerifier + HostnameVerifier hv = new HostnameVerifier() + { + public boolean verify(String arg0, SSLSession arg1) + { + return true; + } + }; + + sc.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier(hv); + } + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Component.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Component.java new file mode 100644 index 00000000000..c3617cc11d2 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Component.java @@ -0,0 +1,170 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.API; + +import java.net.URL; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.HashMap; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.xmlrpc.client.XmlRpcClient; +import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; + +/** + * Allows the user to get a hashmap of the component values by inputing the component ID + * @author anelson + * + */ +public class Component { + private String userName; + private String password; + private URL url; + + + /** + * + * @param userName - your testopia/bugzilla username + * @param password - the password for your account + * @param url - the url of the testopia server + */ + public Component(String userName, String password, URL url) + { + this.userName = userName; + this.password = password; + this.url = url; + } + + /** + * + * @param id the ID of the component that will be returned. Null is returned + * if the component can't be found + * @return the product name that corresponds the specified product ID + */ + public HashMap getComponentByID(int id) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the build + params.add(id); + + //get the result + HashMap result = (HashMap)client.execute("Component.get", params); + + //System.out.println(result); + + return result; + + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return the XML client used to connect to and modify TestCaseRun + */ + private XmlRpcClient getXMLclient() throws Exception + { + try + { + + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + return client; + } + + catch (Exception e) + { + e.printStackTrace(); + } + + throw new Exception("could not connect to server"); + } + + private static void TrustAllCerts() + throws java.security.NoSuchAlgorithmException, + java.security.KeyManagementException + { + // Create a trust manager that does not validate certificate chains + + TrustManager[] trustAllCerts = new TrustManager[] + { + new X509TrustManager() + { + public X509Certificate[] getAcceptedIssuers() + { + return null; + } + + public void checkClientTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + + public void checkServerTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + } + }; + + // Install the all-trusting trust manager + SSLContext sc = SSLContext.getInstance("SSL"); + + // Create empty HostnameVerifier + HostnameVerifier hv = new HostnameVerifier() + { + public boolean verify(String arg0, SSLSession arg1) + { + return true; + } + }; + + sc.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier(hv); + } + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Environment.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Environment.java new file mode 100644 index 00000000000..63d4f3a1eda --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Environment.java @@ -0,0 +1,368 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * Jason Sabin + * + */ +package testopia.API; +import java.net.URL; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.HashMap; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.xmlrpc.client.XmlRpcClient; +import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; + +/** + * Allows the user to get an environment from it's ID. It can also create + * and update an environment + * @author anelson + * + */ +public class Environment { + private String userName; + private String password; + private URL url; + + + /** + * + * @param userName - your testopia/bugzilla username + * @param password - the password for your account + * @param login - the user you want attributes returned for + * @param url - the url of the testopia server + */ + public Environment(String userName, String password, URL url) + { + this.userName = userName; + this.password = password; + this.url = url; + } + + + /** + * Creates a new environment and returns the environmentID, 0 is returned + * if an error occurs + * @param name + * @param productID + */ + public int makeEnvironment(String name, int productID, boolean isActive) + { + int result = 0; + + //Check if the environment already exists. Will return a null if the environment does not exist + HashMap environmentTest = listEnvironments(productID, name); + + //System.out.println("Environment Returned: "+ environmentTest.toString()); + + if(environmentTest == null){ + //environment does not exist so we need to create a new environment + + HashMap map = new HashMap(); + + //1 for true, 0 for false + if(isActive) + map.put("isactive", 1); + else + map.put("isactive", 0); + + map.put("name", name); + map.put("product_id", productID); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the environment + params.add(map); + + //get the result + result = (Integer) client.execute("Environment.create",params); + return result; + + //System.out.println(result); + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + } + else{ + //Build already exists + System.out.println("-->Build "+name+" already exists will not create build"); + //Set the id correctly before returning + String envIDString = environmentTest.get("environment_id").toString(); + result = Integer.parseInt(envIDString); + return result; + } + } + + /** + * Updates the environment on testopia with the specified parameters + * @param name string - the name of the build. Can be null + * @param milestone string - the milestone. Can be null + * @param isactive Boolean - if the build is active. Can be null + * @param description String - description of the build. Can be null + * @param buildID int - the buildID + */ + public void updateEnvironment(String name, Boolean isactive, + Integer productID, int environmentID) + { + //put values into map if they are not null + HashMap map = new HashMap(); + if(name != null) + map.put("name", name); + if(productID != null) + map.put("product_id", productID); + if(isactive != null) + { + //put 1 into map if true + if(isactive) + map.put("isactive", 1); + //else put false + else + map.put("isactive", 0); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the build + params.add(environmentID); + params.add(map); + + //get the result + HashMap result = (HashMap)client.execute("Environment.update",params); + + //System.out.println(result); + + } + + catch (Exception e) + { + e.printStackTrace(); + } + + } + + /** + * Returns the environmnet as a HashMap or null if environment can't be found + * @param environmentName + * @return + */ + public HashMap getEnvirnoment(int environmentID) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the environment + params.add(environmentID); + + //get the result + HashMap result = (HashMap)client.execute("Environment.get", params); + + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @param productName - the name of the product that the + * @param environmentName + * @return + */ + public HashMap listEnvironments(String productName, String environmentName) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the environment + if(productName != null) + { + Product product = new Product(userName, password, url); + int productId = product.getProductIDByName(productName); + params.add(productId); + } + + if(environmentName != null) + params.add(environmentName); + + //get the result + HashMap result = (HashMap)client.execute("Environment.get", params); + + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @param productId - the product id + * @param environmentName + * @return + */ + public HashMap listEnvironments(int productId, String environmentName) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + params.add(productId); + + if(environmentName != null) + params.add(environmentName); + + //get the result + HashMap result = (HashMap)client.execute("Environment.get", params); + + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return the XML client used to connect to and modify TestCaseRun + */ + private XmlRpcClient getXMLclient() throws Exception + { + try + { + + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + return client; + } + + catch (Exception e) + { + e.printStackTrace(); + } + + throw new Exception("could not connect to server"); + } + + private static void TrustAllCerts() + throws java.security.NoSuchAlgorithmException, + java.security.KeyManagementException + { + // Create a trust manager that does not validate certificate chains + + TrustManager[] trustAllCerts = new TrustManager[] + { + new X509TrustManager() + { + public X509Certificate[] getAcceptedIssuers() + { + return null; + } + + public void checkClientTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + + public void checkServerTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + } + }; + + // Install the all-trusting trust manager + SSLContext sc = SSLContext.getInstance("SSL"); + + // Create empty HostnameVerifier + HostnameVerifier hv = new HostnameVerifier() + { + public boolean verify(String arg0, SSLSession arg1) + { + return true; + } + }; + + sc.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier(hv); + } + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Lookup.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Lookup.java new file mode 100644 index 00000000000..1858663ef4c --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Lookup.java @@ -0,0 +1,152 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.API; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.HashMap; +import java.util.StringTokenizer; +import java.util.Map.Entry; + +public class Lookup { + public static URL url; + + public static void main(String args[]) throws Exception + { + //declare variables + url = new URL("http://apibugzillastage.provo.novell.com/tr_xmlrpc.cgi"); + + //get username and password + System.out.println("Welcome to Testopia Lookup tool 1.0"); + StringBuilder command = new StringBuilder(); + StringBuilder object = new StringBuilder(); + System.out.println("Please Eneter your bugzilla username"); + + StringBuilder userNameStringBuilder = new StringBuilder(); + processInput(userNameStringBuilder, null, null); + + System.out.println("Please enter your bugzilla password"); + StringBuilder passwordStringBuilder = new StringBuilder(); + processInput(passwordStringBuilder, null, null); + + + System.out.println("You may now enter a command query"); + System.out.println("To see a list of supported queries, please"); + System.out.println("read the lookupHelp.txt"); + + + //begin query loop + String username = userNameStringBuilder.toString(); + String password = passwordStringBuilder.toString(); + StringBuilder secondObject; + while(true) + { + command = new StringBuilder(); + object = new StringBuilder(); + secondObject = new StringBuilder(); + //get input from console + processInput(command, object, null); + + System.out.println("Query Result:"); + + if(command.toString().equals("build")) + { + Build build = new Build(username, password, url); + int buildId = build.getBuildIDByName(object.toString()); + System.out.println(buildId); + } + + else if(command.toString().equals("component")) + { + TestPlan testPlan = new TestPlan(username, password, url, new Integer(object.toString())); + Object[] objects = testPlan.getComponents(); + for(Object o : objects) + System.out.println(o.toString()); + } + + else if(command.toString().equals("environmentByProduct")) + { + Environment environment = new Environment(username, password, url); + + HashMap map = environment.listEnvironments(object.toString(), null); + + System.out.println("Environment Name: " + map.get("name")); + System.out.println("Environment ID: " + map.get("environment_id")); + + } + + else if(command.toString().equals("environmentByName")) + { + Environment environment = new Environment(username, password, url); + + HashMap map = environment.listEnvironments(object.toString(), null); + + System.out.println("Environment Name: " + map.get("name")); + System.out.println("Environment ID: " + map.get("environment_id")); + + } + + else if(command.toString().equals("exit")) + { + System.out.println("Thanks For Using the Lookup Tool"); + break; + } + + else + { + System.out.println("unrecognized command"); + } + + System.out.println("You may now enter another command query, or type exit to exit"); + } + } + + /** + * Helper method to take input from console + * @param command - first parameter + * @param object - second parameter + */ + public static void processInput(StringBuilder command, StringBuilder object, StringBuilder secondObject) + { + InputStream in = System.in; + BufferedReader reader = new BufferedReader(new InputStreamReader(in)); + StringTokenizer token = null; + try { + token = new StringTokenizer(reader.readLine(), ":"); + } catch (IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + + if(token.hasMoreTokens()) + command.append(token.nextToken()); + if(token.hasMoreTokens() && object != null) + object.append(token.nextToken()); + if(token.hasMoreTokens() && secondObject != null) + secondObject.append(token.nextToken()); + + } + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Product.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Product.java new file mode 100644 index 00000000000..554c9957d7b --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/Product.java @@ -0,0 +1,235 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.API; +import java.net.URL; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.HashMap; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.xmlrpc.client.XmlRpcClient; +import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; + +/** + * Allows the user to get a productID from it's name, or it's name from the productID. It's also able to return a + * product's milestones'. + * @author anelson + * + */ +public class Product { + private String userName; + private String password; + private URL url; + + + /** + * + * @param userName - your testopia/bugzilla username + * @param password - the password for your account + * @param login - the user you want attributes returned for + * @param url - the url of the testopia server + */ + public Product(String userName, String password, URL url) + { + this.userName = userName; + this.password = password; + this.url = url; + } + + /** + * + * @param productName the name of the product, that the ID will be returned for. 0 Will be + * returned if the product can't be found + * @return the ID of the specified product + */ + public int getProductIDByName(String productName) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the product + params.add(productName); + + //get the result + int result = (Integer)client.execute("Product.lookup_id_by_name",params); + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + } + + /** + * + * @param id the ID of the product name that will be returned. Null is returned + * if the product can't be found + * @return the product name that corresponds the specified product ID + */ + public String getProductNameByID(int id) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the product + params.add(id); + + //get the result + String result = (String)client.execute("Product.lookup_name_by_id", params); + + //System.out.println(result); + + return result; + + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + public Object[] getMilestones(int id) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the product + params.add(id); + + //get the result + Object[] result = (Object[])client.execute("Product.get_milestones", params); + + //System.out.println(result); + + return result; + + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return the XML client used to connect to and modify TestCaseRun + */ + private XmlRpcClient getXMLclient() throws Exception + { + try + { + + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + return client; + } + + catch (Exception e) + { + e.printStackTrace(); + } + + throw new Exception("could not connect to server"); + } + + private static void TrustAllCerts() + throws java.security.NoSuchAlgorithmException, + java.security.KeyManagementException + { + // Create a trust manager that does not validate certificate chains + + TrustManager[] trustAllCerts = new TrustManager[] + { + new X509TrustManager() + { + public X509Certificate[] getAcceptedIssuers() + { + return null; + } + + public void checkClientTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + + public void checkServerTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + } + }; + + // Install the all-trusting trust manager + SSLContext sc = SSLContext.getInstance("SSL"); + + // Create empty HostnameVerifier + HostnameVerifier hv = new HostnameVerifier() + { + public boolean verify(String arg0, SSLSession arg1) + { + return true; + } + }; + + sc.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier(hv); + } + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestCaseRun.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestCaseRun.java new file mode 100644 index 00000000000..28160a7e70a --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestCaseRun.java @@ -0,0 +1,399 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * Jason Sabin + */ +package testopia.API; +import java.net.URL; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.HashMap; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.xmlrpc.client.XmlRpcClient; +import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; + +/** + * + * @author anelson, bstice + * Creates a wrapper class for the TestRunCase + */ +public class TestCaseRun { + + //used to store data to identify a testCaseRun + private String userName; + private String password; + private URL url; + private int caseID; + private int runID; + private int buildID; + private int environmentID; + private Integer caseRunID; + + //checks which constructor is used + private boolean canUpdate; + + //stores if the variable needs to updated + private boolean isSetNotes = false; + private boolean isSetStatus = false; + private boolean isSetAssigneeID = false; + private boolean isSetBuildID = false; + private boolean isSetEnvironmentID = false; + + //stores the updated value until it's pushed to tesopia with an update + private String notes; + private int caseStatus; + private int assigneeID; + private int build_ID; + private int environment_ID; + + + /** + * Use this constructor if you just want to use gets + * @param userName your bugzilla username + * @param password your bugzilla password + * @param caseRunID ID generated by bugzilla - can be null + * @param url URL - the url of the testopia server that you want to connect to + */ + public TestCaseRun(String userName, String password, int caseRunID, URL url) + { + this.userName = userName; + this.password = password; + this.caseRunID = caseRunID; + this.canUpdate = false; + this.url = url; + } + + /** + * Use this constructor if you want to do sets and gets + * @param userName your bugzilla username + * @param password your bugzilla password + * @param caseID ID used to get the case + * @param runID test run number + * @param buildID ID generated by bugzilla + * @param environmentID ID generated by bugzilla + * @param caseRunID ID generated by bugzilla - can be null + * @param url URL - the url of the testopia server that you want to connect to + */ + public TestCaseRun(String userName, String password, int caseID, + int runID, int buildID, int environmentID, Integer caseRunID, URL url) + { + this.userName = userName; + this.password = password; + this.caseID = caseID; + this.runID = runID; + this.buildID = buildID; + this.environmentID = environmentID; + this.caseRunID = caseRunID; + this.canUpdate = true; + this.url = url; + } + + /** + * used to create a testRunCase + * @param assigneeID + * @param caseRunStatusID + * @param caseTextVersion + * @return caseRunID + * @throws Exception + */ + public int makeTestCaseRun(int assigneeID, int caseTextVersion) throws Exception + { + if (canUpdate == false) + { + throw new Exception( + "You can't update if you use the 3 parameter constructor, you must use the constuctor with 7 parameters"); + } + + //set the values for the test case + HashMap map = new HashMap(); + map.put("assignee", assigneeID); + map.put("case_id", caseID); + map.put("case_text_version", caseTextVersion); + map.put("environment_id", environmentID); + map.put("run_id", runID); + map.put("build_id", buildID); + + //System.out.println("assignee: "+assigneeID+"\ncase_id: "+caseID+"\ncase_text_version: "+caseTextVersion+"\nenvironment_id: "+environmentID+"\nrun_id: "+runID+"\nbuild_id: "+buildID); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(map); + + + //update the test case + int result = (Integer)client.execute("TestCaseRun.create", + params); + + caseRunID = result; + //System.out.println(result); + return result; + + } + + catch (Exception e) + { + //e.printStackTrace(); + System.out.println("ERROR: Unable to create new TestCaseRun"); + return 0; + } + } + + /** + * Updates are not called when the .set is used. You must call update after all your sets + * to push the changes over to testopia. + * @throws Exception will throw an exception if you used the 3 param constuctor. + */ + public void update() throws Exception + { + if (canUpdate == false) + { + throw new Exception( + "You can't update if you use the 3 parameter constructor, you must use the constuctor with 7 parameters"); + } + + //hashmap to store attributes to be updated + HashMap map = new HashMap(); + + //add attributes that need to be updated to the hashmap + if(isSetNotes) + map.put("notes", notes); + if(isSetStatus) + map.put("case_run_status_id", caseStatus); + if(isSetAssigneeID) + map.put("assignee", assigneeID); + if(isSetBuildID) + map.put("build_id", build_ID); + if(isSetEnvironmentID) + map.put("environment_id", environment_ID); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(runID); + params.add(caseID); + params.add(buildID); + params.add(environmentID); + params.add(map); + + //update the testRunCase + HashMap result = (HashMap) client.execute("TestCaseRun.update", + params); + + //System.out.println(result); + + //make sure multiple updates aren't called, for one set + isSetAssigneeID = false; + isSetBuildID = false; + isSetEnvironmentID = false; + isSetNotes = false; + isSetStatus = false; + + } + + catch (Exception e) + { + e.printStackTrace(); + } + } + + /** + * + * @return a hashMap of all the values found. Returns null if there is an error + * and the TestCaseRun cannot be returned + */ + public HashMap getAttributes() + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(caseRunID); + + //update the testRunCase + HashMap result = (HashMap) client.execute("TestCaseRun.get", + params); + + //System.out.println(result); + + return result; + + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return the XML client used to connect to and modify TestCaseRun + */ + private XmlRpcClient getXMLclient() throws Exception + { + try + { + + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + + //set the server url and username and password + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + return client; + } + + catch (Exception e) + { + e.printStackTrace(); + } + + throw new Exception("could not connect to server"); + } + + + /** + * This is used to append a note + * @param notes string - the note you want entered into the testCaseRun + */ + public void setNotes(String notes) + { + isSetNotes = true; + this.notes = notes; + } + + /** + * This is used to change the testCaseRun status (2 for pass, 3 for fail) + * @param status int - the status you want to change the testCaseRun to + */ + public void setStatus(int status) + { + isSetStatus = true; + this.caseStatus = status; + } + + /** + * Changes the buildID of the testCaseRun + * @param buildID int - the new buildID + */ + public void setBuildID(int buildID) + { + isSetBuildID = true; + this.build_ID = buildID; + } + + /** + * Changes the environmentID of the testCaseRun + * @param environmentID int - the number that the environment ID will be changed to + */ + public void setEnvironmentID(int environmentID) + { + isSetEnvironmentID = true; + this.environment_ID = environmentID; + } + + + /** + * Changes the assigneeID of the testCaseRun + * @param assigneeID + */ + public void setAssigneeID(int assigneeID) + { + isSetAssigneeID = true; + this.assigneeID = assigneeID; + } + + +// Trust All Certificates - Needed for SSL Client + // + private static void TrustAllCerts() + throws java.security.NoSuchAlgorithmException, + java.security.KeyManagementException + { + // Create a trust manager that does not validate certificate chains + + TrustManager[] trustAllCerts = new TrustManager[] + { + new X509TrustManager() + { + public X509Certificate[] getAcceptedIssuers() + { + return null; + } + + public void checkClientTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + + public void checkServerTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + } + }; + + // Install the all-trusting trust manager + SSLContext sc = SSLContext.getInstance("SSL"); + + // Create empty HostnameVerifier + HostnameVerifier hv = new HostnameVerifier() + { + public boolean verify(String arg0, SSLSession arg1) + { + return true; + } + }; + + sc.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier(hv); + } + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestPlan.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestPlan.java new file mode 100644 index 00000000000..be5abe4d8f4 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestPlan.java @@ -0,0 +1,650 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.API; +import java.net.URL; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.HashMap; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.xmlrpc.client.XmlRpcClient; +import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; + +/** + * Creates a test plan object, that allows the user to create, change and get test plan values + * @author anelson + * + */ +public class TestPlan { + + //inputed values to get a testPlan + private String userName; + private String password; + private URL url; + private Integer planID; + + //inputed values to update a testPlan + private int authorID; + private String defaultProductVersion; + private String creation_date; + private int isactive; + private String name; + private int productID; + private int typeID; + + //booleans used to trigger if a value has been set + private boolean isSetAuthorID = false; + private boolean isSetDefaultProductVersion = false; + private boolean isSetcreation_date = false; + private boolean isSetIsactive = false; + private boolean isSetName = false; + private boolean isSetProductID = false; + private boolean isSetTypeID = false; + + /** + * + * @param userName your bugzilla/testopia userName + * @param password your password + * @param url the url of the testopia server + * @param planID - Integer the planID, you may enter null here if you are creating a test plan + */ + public TestPlan(String userName, String password, URL url, Integer planID) + { + this.userName = userName; + this.password = password; + this.url = url; + this.planID = planID; + } + + /** + * + * @param authorID the bugzilla/testopia ID of the author + * @param productID the bugzilla/testopia ID of the product + * @param defaultProductVersion + * @param typeID + * @param name the name of the test plan + * @return the ID of the test plan + */ + public int makeTestPlan(String authorID, String productID, String defaultProductVersion, + String typeID, String name) + { + //set the values for the test plan + HashMap map = new HashMap(); + map.put("author_id", authorID); + map.put("product_id", productID); + map.put("default_product_version", defaultProductVersion); + map.put("type_id", typeID); + map.put("name", name); + + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(map); + + + //update the testRunCase + int result = (Integer)client.execute("TestPlan.create", + params); + + planID = result; + //System.out.println(result); + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + + } + + /** + * Updates are not called when the .set is used. You must call update after all your sets + * to push the changes over to testopia. + * @throws Exception if planID is null + * (you made the TestPlan with a null planID and have not created a new test plan) + */ + public void update() throws Exception + { + if (planID == null) + { + throw new Exception("planID is null."); + } + + //hashmap to store attributes to be updated + HashMap map = new HashMap(); + + //add attributes that need to be updated to the hashmap + if(isSetAuthorID == true) + map.put("author_id", authorID); + + if(isSetDefaultProductVersion == true) + map.put("default_product_version", defaultProductVersion); + + + if (isSetcreation_date == true) + map.put("creation_date", creation_date); + + if(isSetIsactive == true) + map.put("isactive", isactive); + + if(isSetName == true) + map.put("name", name); + + if(isSetProductID == true) + map.put("product_id", productID); + + if(isSetTypeID == true) + map.put("type_id", typeID); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(planID); + params.add(map); + + + //update the testRunCase + HashMap result = (HashMap) client.execute("TestPlan.update", + params); + + //System.out.println(result); + + //make sure multiple updates aren't called, for one set + isSetAuthorID = false; + isSetDefaultProductVersion = false; + isSetcreation_date = false; + isSetIsactive = false; + isSetName = false; + isSetProductID = false; + isSetTypeID = false; + + } + + catch (Exception e) + { + e.printStackTrace(); + } + } + + /** + * + * @param authorID int - the bugzilla authorID that the TestPlan will be changed to + */ + public void setAuthorID(int authorID) + { + this.isSetAuthorID = true; + this.authorID = authorID; + } + + /** + * + * @param defaultProductVersion String - the default product version the test plan will be changed to + */ + public void setDefaultProductVersion(String defaultProductVersion) + { + this.isSetDefaultProductVersion = true; + this.defaultProductVersion = defaultProductVersion; + } + + /** + * + * @param creationDate String - the creation date the test plan will be changed to (Format: yyyy-mm-dd hh:mm:ss) + */ + public void setCreationDate(String creationDate) + { + this.isSetcreation_date = true; + this.creation_date = creationDate; + } + + /** + * + * @param isActive boolean - change if the test plan is active or not + */ + public void setIsActive(boolean isActive) + { + this.isSetIsactive = true; + + //convert to integer of 1 if isActive is true (1 == true) + if(isActive) + this.isactive = 1; + + //else convert to 0 for false (0 == false) + else + this.isactive = 0; + + } + + /** + * + * @param name String - the new name of the test plan + */ + public void setName(String name) + { + this.isSetName = true; + this.name = name; + } + + /** + * + * @param productID int - the new product ID of the test plan + */ + public void setProductID(int productID) + { + this.isSetProductID = true; + this.productID = productID; + } + + /** + * + * @param typeID int - the new type of the test plan + */ + public void setTypeID(int typeID) + { + this.isSetTypeID = true; + this.typeID = typeID; + } + + /** + * Gets the attributes of the test plan, planID must not be null + * @return a hashMap of all the values found. Returns null if there is an error + * and the TestPlan cannot be returned + * @throws Exception + */ + public HashMap getAttributes() throws Exception + { + if (planID == null) + { + throw new Exception("planID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(planID.intValue()); + + //get the hashmap + HashMap result = (HashMap) client.execute("TestPlan.get", + params); + + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return a hashMap of all the values found. Returns null if there is an error + * and the TestPlan cannot be returned + * @throws Exception + */ + public HashMap getCategories() throws Exception + { + if (planID == null) + { + throw new Exception("planID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(planID.intValue()); + + //get the hashmap + HashMap categories = (HashMap)client.execute("TestPlan.get", + params); + + //System.out.println(result); + + return categories; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return an array of objects (Object[]) of all the values found for the builds. + * Returns null if there is an error and the TestPlan cannot be returned + * @throws Exception + */ + public Object[] getBuilds() throws Exception + { + if (planID == null) + { + throw new Exception("planID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(planID.intValue()); + + //get the hashmap + Object[] categories = (Object[])client.execute("TestPlan.get_builds", + params); + + //System.out.println(result); + + return categories; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return an array of objects (Object[]) of all the components found. + * Returns null if there is an error and the TestPlan cannot be returned + * @throws Exception + */ + public Object[] getComponents() throws Exception + { + if (planID == null) + { + throw new Exception("planID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(planID.intValue()); + + //get the hashmap + Object[] categories = (Object[])client.execute("TestPlan.get_components", + params); + + //System.out.println(result); + + return categories; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * Returns hashmap(s) of testplans that match the inputed values + * @param userName your bugzilla/testopia userName + * @param password your password + * @param url the url of the testopia server + * @param values a HashMap with the parameters that will be searched for + * if you supply the pair "plan_id", 5 then plan_id 5 will be returned. Any combination + * of testplan attributes can be entered and the result will be all matches that fit + * the inputed values + * @return + */ + public static Object[] getList(String userName, String password, + URL url, HashMap values) + { + try + { + TrustAllCerts(); + + //setup client + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + ArrayList params = new ArrayList(); + + // set up params, to identify the test plan + params.add(values); + + // get the hashmap + Object[] result = (Object[]) client.execute( + "TestPlan.list", params); + + // System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return an array of objects (Object[]) of all the testcases found. + * Returns null if there is an error and the TestPlan cannot be returned + * @throws Exception + */ + public Object[] getTestCases() throws Exception + { + if (planID == null) + { + throw new Exception("planID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(planID.intValue()); + + //get the hashmap + Object[] categories = (Object[])client.execute("TestPlan.get_test_cases", + params); + + //System.out.println(result); + + return categories; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return an array of objects (Object[]) of all the test runs found. + * Returns null if there is an error and the TestPlan cannot be returned + * @throws Exception + */ + public Object[] getTestRuns() throws Exception + { + if (planID == null) + { + throw new Exception("planID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(planID.intValue()); + + //get the hashmap + Object[] categories = (Object[])client.execute("TestPlan.get_test_runs", + params); + + //System.out.println(result); + + return categories; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + private static void TrustAllCerts() + throws java.security.NoSuchAlgorithmException, + java.security.KeyManagementException +{ + // Create a trust manager that does not validate certificate chains + + TrustManager[] trustAllCerts = new TrustManager[] + { + new X509TrustManager() + { + public X509Certificate[] getAcceptedIssuers() + { + return null; + } + + public void checkClientTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + + public void checkServerTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + } + }; + + // Install the all-trusting trust manager + SSLContext sc = SSLContext.getInstance("SSL"); + + // Create empty HostnameVerifier + HostnameVerifier hv = new HostnameVerifier() + { + public boolean verify(String arg0, SSLSession arg1) + { + return true; + } + }; + + sc.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier(hv); +} + + private XmlRpcClient getXMLclient() throws Exception + { + try + { + + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + return client; + } + + catch (Exception e) + { + e.printStackTrace(); + } + + throw new Exception("could not connect to server"); + } + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestRun.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestRun.java new file mode 100644 index 00000000000..70647c80a15 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestRun.java @@ -0,0 +1,494 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.API; +import java.net.URL; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.HashMap; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.xmlrpc.client.XmlRpcClient; +import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; + + +public class TestRun { + //inputed values to get a testRun + private String userName; + private String password; + private URL url; + private Integer runID; + + //variables used to update the testRun + private String notes = null; + private Integer managerID = null; + private String summary = null; + private String startDate = null; + private String stopDate = null; + private Integer buildID = null; + private Integer environmentID = null; + private Integer newPlanID = null; + + /** + * + * @param buildID int - the new builID + */ + public void setBuildID(int buildID) { + this.buildID = buildID; + } + + /** + * + * @param environmentID int = the new environemnetID + */ + public void setEnvironmentID(int environmentID) { + this.environmentID = environmentID; + } + + /** + * + * @param managerID int - the new managerID + */ + public void setManagerID(int managerID) { + this.managerID = managerID; + } + + /** + * + * @param notes String - the new notes + */ + public void setNotes(String notes) { + this.notes = notes; + } + + /** + * + * @param startDate String - the new startDate (Format: yyyy-mm-dd hh:mm:ss) + */ + public void setStartDate(String startDate) { + this.startDate = startDate; + } + + /** + * + * @param stopDate String - the new stopDate (Format: yyyy-mm-dd hh:mm:ss) + */ + public void setStopDate(String stopDate) { + this.stopDate = stopDate; + } + + /** + * + * @param summary String - the new summary + */ + public void setSummary(String summary) { + this.summary = summary; + } + + /** + * + * @param newPlanID int - the plan that the test run now belongs to + */ + public void setPlanID(Integer newPlanID) + { + this.newPlanID = newPlanID; + } + + public void update() throws Exception + { + if (runID == null) + { + throw new Exception("runID is null."); + } + + //hashmap to store attributes to be updated + HashMap map = new HashMap(); + + //add attributes that need to be updated to the hashmap + if(buildID != null) + map.put("build_id", buildID); + + if(environmentID != null) + map.put("environment_id", environmentID); + + if (managerID != null) + map.put("manager_id", managerID); + + if(notes != null) + map.put("notes", notes); + + if(startDate != null) + map.put("start_date", startDate); + + if(stopDate != null) + map.put("stop_date", stopDate); + + if(summary != null) + map.put("summary", summary); + + if(newPlanID != null) + map.put("plan_id", newPlanID); + + + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(runID); + params.add(map); + + + //update the testRunCase + HashMap result = (HashMap) client.execute("TestRun.update", + params); + + //System.out.println(result); + + notes = null; + managerID = null; + summary = null; + startDate = null; + stopDate = null; + buildID = null; + environmentID = null; + newPlanID = null; + + } + + catch (Exception e) + { + e.printStackTrace(); + } + } + + /** + * Gets the attributes of the test run, runID must not be null + * @return a hashMap of all the values found. Returns null if there is an error + * and the TestRun cannot be returned + * @throws Exception + */ + public HashMap getAttributes() throws Exception + { + if (runID == null) + { + throw new Exception("runID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(runID.intValue()); + + //get the hashmap + HashMap result = (HashMap) client.execute("TestRun.get", + params); + + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * Returns hashmap(s) of testplans that match the inputed values + * @param userName your bugzilla/testopia userName + * @param password your password + * @param url the url of the testopia server + * @param values a HashMap with the parameters that will be searched for + * if you supply the pair "run_id", 5 then run_id 5 will be returned. Any combination + * of testrun attributes can be entered and the result will be all matches that fit + * the inputed values + * @return + */ + public static Object[] getList(String userName, String password, + URL url, HashMap values) + { + try + { + TrustAllCerts(); + + //setup client + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + ArrayList params = new ArrayList(); + + // set up params, to identify the test plan + params.add(values); + + // get the hashmap + Object[] result = (Object[]) client.execute( + "TestRun.list", params); + + // System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @param userName your bugzilla/testopia userName + * @param password your password + * @param url the url of the testopia server + * @param runID - Integer the runID, you may enter null here if you are creating a test run + */ + public TestRun(String userName, String password, URL url, Integer runID) + { + this.userName = userName; + this.password = password; + this.url = url; + this.runID = runID; + } + + /** + * + * @param buildID + * @param environmentID + * @param managerID + * @param planID int - the ID of the plan the run will be added to + * @param planTextVersion + * @param summary String - text summary of the run + * @return the ID of the test run + */ + public int makeTestRun(int buildID, int environmentID, int managerID, int planID, + int planTextVersion, String summary) + { + //set the values for the test plan + HashMap map = new HashMap(); + map.put("build_id", buildID); + map.put("environment_id", environmentID); + map.put("manager_id", managerID); + map.put("plan_id", planID); + map.put("plan_text_version", planTextVersion); + map.put("summary", summary); + + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(map); + + + //update the testRunCase + int result = (Integer)client.execute("TestRun.create", + params); + + runID = result; + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + + } + + /** + * + * @return an array of objects (Object[]) of all the testcases found. + * Returns null if there is an error and the TestRun cannot be returned + * @throws Exception + */ + public Object[] getTestCases() throws Exception + { + if (runID == null) + { + throw new Exception("runID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(runID.intValue()); + + + //get the hashmap + Object[] categories = (Object[])client.execute("TestRun.get_test_cases", + params); + + //System.out.println(result); + + return categories; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * + * @return an array of objects (Object[]) of all the testCaseRuns found. + * Returns null if there is an error and the TestRun cannot be found + * @throws Exception + */ + public Object[] getTestCaseRuns() throws Exception + { + if (runID == null) + { + throw new Exception("runID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(runID.intValue()); + + //get the hashmap + Object[] categories = (Object[])client.execute("TestRun.get_test_case_runs", + params); + + //System.out.println(result); + + return categories; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + private static void TrustAllCerts() + throws java.security.NoSuchAlgorithmException, + java.security.KeyManagementException { + // Create a trust manager that does not validate certificate chains + + TrustManager[] trustAllCerts = new TrustManager[] { new X509TrustManager() { + public X509Certificate[] getAcceptedIssuers() { + return null; + } + + public void checkClientTrusted(X509Certificate[] certs, + String authType) { + // Trust always + } + + public void checkServerTrusted(X509Certificate[] certs, + String authType) { + // Trust always + } + } }; + + // Install the all-trusting trust manager + SSLContext sc = SSLContext.getInstance("SSL"); + + // Create empty HostnameVerifier + HostnameVerifier hv = new HostnameVerifier() { + public boolean verify(String arg0, SSLSession arg1) { + return true; + } + }; + + sc.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier(hv); + } + + private XmlRpcClient getXMLclient() throws Exception + { + try + { + + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + return client; + } + + catch (Exception e) { + e.printStackTrace(); + } + + throw new Exception("could not connect to server"); + } + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestopiaTestCase.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestopiaTestCase.java new file mode 100644 index 00000000000..21a8a5a42f7 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/TestopiaTestCase.java @@ -0,0 +1,670 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.API; +import java.net.URL; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.HashMap; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.xmlrpc.client.XmlRpcClient; +import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; + + +public class TestopiaTestCase { + + //inputed values to get a testCase + private String userName; + private String password; + private URL url; + private Integer caseID; + + //values for updates + private Integer defaultTesterID = null; + private Integer isAutomated; + private Integer priorityID; + private Integer categoryID; + private Integer canview; + private String arguments; + private String alias; + private String requirement; + private String script; + private String caseStatusID; + private String summary; + + /** + * @param userName your bugzilla/testopia userName + * @param password your password + * @param url the url of the testopia server + * @param caseID - Integer the caseID, you may enter null here if you are creating a test case + */ + public TestopiaTestCase(String userName, String password, URL url, Integer caseID) + { + this.userName = userName; + this.password = password; + this.url = url; + this.caseID = caseID; + } + /** + * + * @param alias String - the new Alias + */ + public void setAlias(String alias) { + this.alias = alias; + } + + /** + * + * @param arguments String - the new arguments + */ + public void setArguments(String arguments) { + this.arguments = arguments; + } + + /** + * + * @param canview + */ + public void setCanview(boolean canview) { + + //true == 1 + if(canview) + this.canview = 1; + + //false ==0 + else + this.canview = 0; + } + + /** + * + * @param caseStatusID String - the new case Status ID + */ + public void setCaseStatusID(String caseStatusID) { + this.caseStatusID = caseStatusID; + } + + /** + * + * @param categoryID int - the new categorID + */ + public void setCategoryID(int categoryID) { + this.categoryID = categoryID; + } + + /** + * + * @param defaultTesterID int - the new defaultTesterID + */ + public void setDefaultTesterID(int defaultTesterID) { + this.defaultTesterID = defaultTesterID; + } + + /** + * + * @param isAutomated boolean - true if it's to be set automated, + * false otherwise + */ + public void setIsAutomated(boolean isAutomated) { + //true == 1 + if(isAutomated) + this.isAutomated = 1; + + //false ==0 + else + this.isAutomated = 0; + } + + /** + * + * @param priorityID - int the new priorityID + */ + public void setPriorityID(int priorityID) { + this.priorityID = priorityID; + } + + /** + * + * @param requirement String - the new requirement + */ + public void setRequirement(String requirement) { + this.requirement = requirement; + } + + /** + * + * @param script String - the new script + */ + public void setScript(String script) { + this.script = script; + } + + /** + * + * @param summary String - the new summary + */ + public void setSummary(String summary) { + this.summary = summary; + } + + /** + * Adds a component to the testCase + * @param componentID the ID of the component that will be added to the + * testCase + * @throws Exception + */ + public void addComponent(int componentID) throws Exception + { + if(caseID == null) + throw new Exception("CaseID cannot be null"); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(caseID); + params.add(componentID); + + + //add the component to the test case + int result = (Integer) client.execute("TestCase.add_component", + params); + + //System.out.println(result); + + } + + catch (Exception e) + { + e.printStackTrace(); + } + + } + + /** + * Removes a component to the testCase + * @param componentID the ID of the component that will be removed from the + * testCase + * @throws Exception + */ + public void removeComponent(int componentID) throws Exception + { + if(caseID == null) + throw new Exception("CaseID cannot be null"); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(caseID); + params.add(componentID); + + + //add the component to the test case + int result = (Integer) client.execute("TestCase.remove_component", + params); + + //System.out.println(result); + + } + + catch (Exception e) + { + e.printStackTrace(); + } + + } + + /** + * Gets the components as an array of hashMaps or null if + * an error occurs + * @return an array of component hashMaps or null + * @throws Exception + */ + public Object[] getComponents() throws Exception + { + if(caseID == null) + throw new Exception("CaseID cannot be null"); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(caseID); + + // get the hashmap + Object[] result = (Object[]) client.execute( + "TestCase.get_components", params); + + // System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + + /** + * Updates are not called when the .set is used. You must call update after all your sets + * to push the changes over to testopia. + * @throws Exception if planID is null + * (you made the TestCase with a null caseID and have not created a new test plan) + */ + public void update() throws Exception + { + if (caseID == null) + { + throw new Exception("caseID is null."); + } + + //hashmap to store attributes to be updated + HashMap map = new HashMap(); + + //add attributes that need to be updated to the hashmap + if(isAutomated != null) + map.put("isautomated", isAutomated.intValue()); + + if(priorityID != null) + map.put("priority_id", priorityID.intValue()); + + if(canview != null) + map.put("canview", canview.intValue()); + + if(categoryID != null) + map.put("category_id", categoryID); + + if(arguments != null) + map.put("arguments", arguments); + + if(alias != null) + map.put("alias", alias); + + if(requirement != null) + map.put("requirement", requirement); + + if(script != null) + map.put("script", script); + + if(caseStatusID != null) + map.put("case_status_id", caseStatusID); + + if(summary != null) + map.put("summary", summary); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(caseID); + params.add(map); + + + //update the testRunCase + HashMap result = (HashMap) client.execute("TestCase.update", + params); + + //System.out.println(result); + + } + + catch (Exception e) + { + e.printStackTrace(); + } + + //make sure multiple updates aren't called + isAutomated = null; + priorityID = null; + categoryID = null; + canview = null; + arguments = null; + alias = null; + requirement = null; + script = null; + caseStatusID = null; + summary = null; + } + + /** + * + * @param authorID the bugzilla/testopia ID of the author + * @param caseStatusID + * @param categoryID + * @param isAutomated + * @param planID the ID of the plan the testCase will be added to + * @param summary string - the summary of the testCase. Null allowed + * @param priorityID Integer - the priority of the testCase (0-5). Null allowed + * @return + */ + public int makeTestCase(int authorID, int caseStatusID, int categoryID, + boolean isAutomated, int planID, String summary,Integer priorityID) + { + + int isAutomatedInt; + + //convert to integer of 1 if isAutomated is true (1 == true) + if(isAutomated) + isAutomatedInt = 1; + + //else convert to 0 for false (0 == false) + else + isAutomatedInt = 0; + + //set the values for the test case + HashMap map = new HashMap(); + map.put("author_id", authorID); + map.put("case_status_id", caseStatusID); + map.put("category_id", categoryID); + map.put("isautomated", isAutomatedInt); + map.put("plan_id", planID); + + //add the optional values if they are not null + if(summary != null) + map.put("summary", summary); + + if(priorityID != null) + map.put("priority_id", priorityID.intValue()); + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test case + params.add(map); + + + //update the test case + int result = (Integer)client.execute("TestCase.create", + params); + + caseID = result; + //System.out.println(result); + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + } + + /** + * Gets the attributes of the test case, caseID must not be null + * @return a hashMap of all the values found. Returns null if there is an error + * and the TestCase cannot be returned + * @throws Exception + */ + public HashMap getAttributes() throws Exception + { + if (caseID == null) + { + throw new Exception("caseID is null."); + } + + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the test plan + params.add(caseID.intValue()); + + //get the hashmap + HashMap result = (HashMap) client.execute("TestCase.get", + params); + + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + /** + * Returns hashmap(s) of testcases that match the inputed values + * @param userName your bugzilla/testopia userName + * @param password your password + * @param url the url of the testopia server + * @param values a HashMap with the parameters that will be searched for + * if you supply the pair "case_id", 5 then case_id 5 will be returned. Any combination + * of testcase attributes can be entered and the result will be all the matches that fit + * the inputed values + * @return + */ + public static Object[] getList(String userName, String password, + URL url, HashMap values) + { + try + { + TrustAllCerts(); + + //setup client + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + ArrayList params = new ArrayList(); + + // set up params, to identify the test plan + params.add(values); + + // get the hashmap + Object[] result = (Object[]) client.execute( + "TestCase.list", params); + + // System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return null; + } + } + + public int getCategoryIdByName(String categoryName) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the category + params.add(categoryName); + + //get the result + int result = (Integer)client.execute("TestCase.lookup_category_id_by_name", params); + + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + + } + + /** + * + * @param categoryName the name of the category that the ID will be returned for. This will search within the + * test plans that this test case belongs to and return the first category with a matching name. 0 Will be + * returned if the category can't be found + * @return the ID of the specified product + */ + public int getBuildIDByName(String categoryName) + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the category + params.add(categoryName); + + //get the result + int result = (Integer)client.execute("TestCase.lookup_category_id_by_name", params); + + //System.out.println(result); + + return result; + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + } + + private static void TrustAllCerts() + throws java.security.NoSuchAlgorithmException, + java.security.KeyManagementException +{ + // Create a trust manager that does not validate certificate chains + + TrustManager[] trustAllCerts = new TrustManager[] + { + new X509TrustManager() + { + public X509Certificate[] getAcceptedIssuers() + { + return null; + } + + public void checkClientTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + + public void checkServerTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + } + }; + + // Install the all-trusting trust manager + SSLContext sc = SSLContext.getInstance("SSL"); + + // Create empty HostnameVerifier + HostnameVerifier hv = new HostnameVerifier() + { + public boolean verify(String arg0, SSLSession arg1) + { + return true; + } + }; + + sc.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier(hv); +} + + private XmlRpcClient getXMLclient() throws Exception + { + try + { + + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + return client; + } + + catch (Exception e) + { + e.printStackTrace(); + } + + throw new Exception("could not connect to server"); + } +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/User.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/User.java new file mode 100644 index 00000000000..f8e4882792a --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/User.java @@ -0,0 +1,178 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.API; +import java.net.URL; +import java.security.cert.X509Certificate; +import java.util.ArrayList; +import java.util.HashMap; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.HttpsURLConnection; +import javax.net.ssl.SSLContext; +import javax.net.ssl.SSLSession; +import javax.net.ssl.TrustManager; +import javax.net.ssl.X509TrustManager; + +import org.apache.xmlrpc.client.XmlRpcClient; +import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; + +import org.apache.xmlrpc.client.XmlRpcClient; + +/** + * + * @author anelson, bstice + * Retrives the user ID for the inputed email + */ +public class User { + + + private String user; + private String userName; + private String password; + private URL url; + + + /** + * + * @param userName - your testopia/bugzilla username + * @param password - the password for your account + * @param login - the user you want attributes returned for + * @param url - the url of the testopia server + */ + public User(String userName, String password, String login, URL url) + { + this.user = login; + this.userName = userName; + this.password = password; + this.url = url; + } + + + /** + * @return the user_id for the specified login. Returns 0 if there is + * an error and the user ID cannot be returned + */ + public int getAttributes() + { + try + { + TrustAllCerts(); + + XmlRpcClient client = getXMLclient(); + + ArrayList params = new ArrayList(); + + //set up params, to identify the user + params.add(user); + + //update the testRunCase + int result = (Integer)client.execute("User.lookup_id_by_login",params); + + //System.out.println(result); + + return result; + + + } + + catch (Exception e) + { + e.printStackTrace(); + return 0; + } + } + + /** + * + * @return the XML client used to connect to and modify TestCaseRun + */ + private XmlRpcClient getXMLclient() throws Exception + { + try + { + + XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl(); + config.setServerURL(url); + config.setBasicUserName(userName); + config.setBasicPassword(password); + + XmlRpcClient client = new XmlRpcClient(); + client.setConfig(config); + + return client; + } + + catch (Exception e) + { + e.printStackTrace(); + } + + throw new Exception("could not connect to server"); + } + + private static void TrustAllCerts() + throws java.security.NoSuchAlgorithmException, + java.security.KeyManagementException + { + // Create a trust manager that does not validate certificate chains + + TrustManager[] trustAllCerts = new TrustManager[] + { + new X509TrustManager() + { + public X509Certificate[] getAcceptedIssuers() + { + return null; + } + + public void checkClientTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + + public void checkServerTrusted(X509Certificate[] certs, String authType) + { + // Trust always + } + } + }; + + // Install the all-trusting trust manager + SSLContext sc = SSLContext.getInstance("SSL"); + + // Create empty HostnameVerifier + HostnameVerifier hv = new HostnameVerifier() + { + public boolean verify(String arg0, SSLSession arg1) + { + return true; + } + }; + + sc.init(null, trustAllCerts, new java.security.SecureRandom()); + HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); + HttpsURLConnection.setDefaultHostnameVerifier(hv); + } + + + + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/lookupHelp.txt b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/lookupHelp.txt new file mode 100644 index 00000000000..890a5d167ae --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/API/lookupHelp.txt @@ -0,0 +1,30 @@ +Example usage: + +Welcome to Testopia Lookup tool 1.0 +Please Eneter your bugzilla username + +username + +Please enter your bugzilla password + +password + +You may now enter a command query +To see a list of supported queries, please +read the lookupHelp.txt + +//this is looking for a build called beta, and will return the buildId +build:beta +Query Result: +1112 + +//this is looking for an environment that belongs to the product Testopia +environmentByProduct:Testopia +Query Result: +Environment Name: SLES10SP1 +Environment ID: 275 + +//this queries for components for a plan +component:planId + +You can change the url it points to by changing it in the code \ No newline at end of file diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/JunitToTestopia.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/JunitToTestopia.java new file mode 100644 index 00000000000..f2b4f3c4248 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/JunitToTestopia.java @@ -0,0 +1,313 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * Jason Sabin + * + */ +package testopia.Test; +import java.io.BufferedWriter; +import java.io.File; +import java.io.FileOutputStream; +import java.io.FileWriter; +import java.io.IOException; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.Date; +import java.util.Iterator; +import java.util.List; + +import org.jdom.Content; +import org.jdom.Element; +import org.jdom.JDOMException; +import org.jdom.Text; +import org.jdom.input.SAXBuilder; +import org.jdom.output.XMLOutputter; + +import testopia.API.Build; +import testopia.API.Environment; +import testopia.API.Product; + +public class JunitToTestopia { + private File XMLTestopiaData; + private ParseAnt parser; + private TestopiaConnector connector; + private File XMLFile; + private int testPlanID; + private int testRunID; + private String userName; + private String password; + private String email; + private URL serverURL; + private int buildID; + private int environmentID; + private int productID; + private int defaultPriority; + private String defaultCategory; + private OptionalValues optionalValues; + private boolean blockers; + private boolean newTestCaseRunEveryTime; + public static void main(String args[]) throws Exception + { + + String buildName = null; + String path = null; + String environmentName = null; + String runID = null; + + //if parameters are being passed, use them + if (args.length == 4) + { + buildName = args[0]; + path = args[1]; + environmentName = args[2]; + runID = args[3]; + } + + FileWriter fout = new FileWriter("log.txt", true); + BufferedWriter out = new BufferedWriter(fout); + out.write("\nTAP LOG:\n"); + Date date = new Date(); + out.write("Start Time: " + date.toString() + "\n"); + + System.out.println("Start Time: " + date); + JunitToTestopia junit = new JunitToTestopia(buildName, path, + environmentName, runID, out); + junit.pushToTestopia(); + Date date2 = new Date(); + System.out.println("End Time: " + date2); + out.write("Stop Time: " + date2.toString() + "\n"); + + out.close(); + fout.close(); + } + + public JunitToTestopia(String buildName, String path, + String environmentName, String runID, BufferedWriter out) throws Exception + { + //gets testopia data + XMLTestopiaData = new File("testopiaData.xml"); + parseXML(buildName, path, environmentName, runID); + + optionalValues = new OptionalValues(); + + //sets up the connector to talk to testopia + connector = new TestopiaConnector(testPlanID,testRunID,userName, + password,email, serverURL, optionalValues, out, blockers, defaultPriority, defaultCategory, newTestCaseRunEveryTime); + + //gets the paser setup with the xml results + parser = new ParseAnt(XMLFile, connector, buildID, environmentID); + + } + + /** + * Has the parser parse and upload all the files to testopia + * @throws Exception + * + */ + public void pushToTestopia() throws Exception + { + parser.processXMl(); + } + + private void parseXML(String passedBuildName, String passedPath, + String passedEnvironmentName, String passedRunID) + throws MalformedURLException + { + Element testopiaData = null; + + //get the testSuite data from XML + try + { + //make a list from the XML file + testopiaData = new SAXBuilder().build(XMLTestopiaData).getRootElement(); + } + catch (Exception e) + { + e.printStackTrace(); + } + + //get data out of XML file + Element userNameElement = testopiaData.getChild("username"); + userName = userNameElement.getContent(0).getValue(); + + Element passwordElement = testopiaData.getChild("password"); + password = passwordElement.getContent(0).getValue(); + + Element buildIDElement = testopiaData.getChild("buildID"); + String buildIDString = buildIDElement.getContent(0).getValue(); + + Element environmentIDElemet = testopiaData.getChild("environmentID"); + String environmentIDString = environmentIDElemet.getContent(0).getValue(); + + Element productIDElement = testopiaData.getChild("productID"); + String productIDString = productIDElement.getContent(0).getValue(); + + Element emailElement = testopiaData.getChild("email"); + email = emailElement.getContent(0).getValue(); + + Element planIDElement = testopiaData.getChild("planID"); + String planIDString = planIDElement.getContent(0).getValue(); + testPlanID = new Integer(planIDString); + + //override local XML data if xml data is passed + if(passedRunID != null) + { + Element runIDElement = testopiaData.getChild("runID"); + String runIDString = passedRunID; + testRunID = new Integer(runIDString); + Text runIDText = new Text(runIDString); + runIDElement.setContent(0, runIDText); + } + //otherwise, use testopiaXMLData + else + { + Element runIDElement = testopiaData.getChild("runID"); + String runIDString = runIDElement.getContent(0).getValue(); + testRunID = new Integer(runIDString); + } + + //override local XML data if xml data is passed + if(passedPath != null) + { + Element xmlLocationElement = testopiaData.getChild("xmlResultsLocation"); + String xmlLocationString = passedPath; + XMLFile = new File(xmlLocationString); + Text pathText = new Text(xmlLocationString); + xmlLocationElement.setContent(0, pathText); + } + + //otherwise, use testopiaXMLData + else + { + Element xmlLocationElement = testopiaData.getChild("xmlResultsLocation"); + String xmlLocationString = xmlLocationElement.getContent(0).getValue(); + XMLFile = new File(xmlLocationString); + } + + Element serverURLElement = testopiaData.getChild("serverURL"); + String serverURLString = serverURLElement.getContent(0).getValue(); + serverURL = new URL(serverURLString); + + + + //create product, environment and build as necessary + if(productIDString.equals("0")) + { + String productName = testopiaData.getChild("productName").getContent(0).getValue(); + Product product = new Product(userName, password, serverURL); + productID = product.getProductIDByName(productName); + Text productText = new Text(new Integer(productID).toString()); + productIDElement.setContent(0, productText); + } + + else + productID = Integer.parseInt(productIDString); + + + if(buildIDString.equals("0") || passedBuildName != null) + { + Build build = new Build(userName, password, serverURL); + + //override local XML data if xml data is passed + if(passedBuildName != null ) + { + buildID = build.makeBuild(passedBuildName, productID, true, "---"); + } + + //otherwise, use testopiaXMLData + else + { + String buildName = testopiaData.getChild("buildName").getContent(0).getValue(); + buildID = build.makeBuild(buildName, productID, true, "---"); + } + + + + Text buildText = new Text(new Integer(buildID).toString()); + buildIDElement.setContent(0, buildText); + } + else + buildID = Integer.parseInt(buildIDString); + + if(environmentIDString.equals("0") || passedEnvironmentName != null) + { + Environment environment = new Environment(userName, password, serverURL); + + //override local XML data if xml data is passed + if(passedEnvironmentName != null) + { + environmentID = environment.makeEnvironment(passedEnvironmentName, productID, true); + } + + //otherwise, use testopiaXMLData + else + { + String environmentName = testopiaData.getChild("environmentName").getContent(0).getValue(); + environmentID = environment.makeEnvironment(environmentName, productID, true); + } + Text environmentText = new Text(new Integer(environmentID).toString()); + environmentIDElemet.setContent(0, environmentText); + } + else + environmentID = Integer.parseInt(environmentIDString); + + + Element blocker = testopiaData.getChild("blockers"); + String blockers = blocker.getContent(0).getValue(); + + //detect if blockers are turned on + if(blockers.trim().equalsIgnoreCase("yes")) + this.blockers = true; + else + this.blockers = false; + + + Element newTestCaseRunEveryTimeElement = testopiaData.getChild("newTestCaseRunEveryTime"); + String newTestCaseRunEveryTimeString = newTestCaseRunEveryTimeElement.getContent(0).getValue(); + + //detect if newTestCaseRunEveryTime is turned on + if(newTestCaseRunEveryTimeString.trim().equalsIgnoreCase("yes")) + this.newTestCaseRunEveryTime = true; + else + this.newTestCaseRunEveryTime = false; + + + //Set the default Priority + Element prioritySetting = testopiaData.getChild("priority"); + String priorityString = prioritySetting.getContent(0).getValue(); + defaultPriority = Integer.parseInt(priorityString); + + //Set the default Category + Element categorySetting = testopiaData.getChild("category"); + defaultCategory = categorySetting.getContent(0).getValue(); + + //write the updated testopia file to disk, to keep buildID and environmentID + XMLOutputter outputter = new XMLOutputter(); + + try + { + FileWriter writer = new FileWriter(XMLTestopiaData); + outputter.output(testopiaData, writer); + } + catch (IOException e) + { + System.err.println(e); + } + + } +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/OptionalData.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/OptionalData.java new file mode 100644 index 00000000000..9cd9128d6e9 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/OptionalData.java @@ -0,0 +1,78 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.Test; + +import java.util.ArrayList; + +/** + * + * @author anelson + * Stores data from the optionadata xml file + */ +public class OptionalData { + private String assignee; + private Integer category; + private Integer priority; + private ArrayList components; + + + public OptionalData() + { + category = null; + components = new ArrayList(); + } + + public int getCategory() { + return category; + } + + public void setCategory(Integer category) { + this.category = category; + } + + public ArrayList getComponents() { + return components; + } + + public void addComponent(Integer component) { + this.components.add(component); + } + + public void removeComponent(Integer component) { + this.components.remove(component); + } + + public String getAssignee() { + return assignee; + } + public void setAssignee(String assignee) { + this.assignee = assignee; + } + + public Integer getPriority() { + return priority; + } + public void setPriority(Integer priority) { + this.priority = priority; + } + + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/OptionalValues.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/OptionalValues.java new file mode 100644 index 00000000000..d9a24f89260 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/OptionalValues.java @@ -0,0 +1,169 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.Test; + +import java.io.File; +import java.net.URL; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; + +import org.jdom.Element; +import org.jdom.input.SAXBuilder; + +import testopia.API.TestopiaTestCase; + +/** + * parses the optionaldata xml file + * @author anelson + * + */ +public class OptionalValues { + private HashMap testCaseMap; + private OptionalData currentlySelected; + + public OptionalValues() + { + File XMLOptionalValues = new File("OptionalData.xml"); + Element optionalData = null; + + testCaseMap = new HashMap(); + currentlySelected = null; + + //get the optional data from XML + try + { + //make a list from the XML file + optionalData = new SAXBuilder().build(XMLOptionalValues).getRootElement(); + } + catch (Exception e) + { + e.printStackTrace(); + } + + //get testsuites + List testSuite = optionalData.getChildren("testsuite"); + Iterator testSuiteIT = testSuite.iterator(); + + List testCases = null; + Element testSuiteElement = null; + Element testCase = null; + + //loops for all test suites + while(testSuiteIT.hasNext()) + { + testSuiteElement = (Element)testSuiteIT.next(); + testCases = testSuiteElement.getChildren("testcase"); + Iterator testCasesIT = testCases.iterator(); + + //loops for all testcases + while (testCasesIT.hasNext()) { + testCase = (Element) testCasesIT.next(); + + // get the values for the testcase + OptionalData entry = new OptionalData(); + String className = testCase.getAttributeValue("classname"); + + // get the assignee + String assignee = testCase.getChildText("assignee"); + entry.setAssignee(assignee); + + // get the category + String category = testCase.getChildText("category"); + entry.setCategory(Integer.parseInt(category)); + + // get components + Element components = testCase.getChild("components"); + Iterator componentsIT = components.getChildren("component").iterator(); + while (componentsIT.hasNext()) + { + Element component = (Element) componentsIT.next(); + String stringcomponent = component.getContent(0).getValue(); + Integer intcomponent = Integer.parseInt(stringcomponent); + entry.addComponent(intcomponent); + } + + // get the priority + String priority = testCase.getChildText("priority"); + Integer intPriority = Integer.parseInt(priority); + entry.setPriority(intPriority); + + // add the testCase to the hashmap + testCaseMap.put(className, entry); + } + } + + } + + public static void main(String args[]) + { + OptionalValues values = new OptionalValues(); + values.selectClass("className"); + System.out.println(values.getAssignee()); + } + + /** + * Use select class to get a specific class out of the HashMap and allow + * access to the classes data via the get methods + * @param className String - the name of the class selected + */ + public boolean selectClass(String className) + { + currentlySelected = testCaseMap.get(className); + if(currentlySelected == null) + return false; + return true; + + } + + public Integer getCategories() + { + if(currentlySelected != null) + return currentlySelected.getCategory(); + + return null; + } + + public int getPriority() + { + if(currentlySelected != null) + return currentlySelected.getPriority(); + + return 0; + } + + public String getAssignee() + { + if(currentlySelected != null) + return currentlySelected.getAssignee(); + + return null; + } + + public ArrayList getComponents() + { + if(currentlySelected != null) + return currentlySelected.getComponents(); + + return null; + } +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/ParseAnt.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/ParseAnt.java new file mode 100644 index 00000000000..9707fdc4457 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/ParseAnt.java @@ -0,0 +1,141 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * Jason Sabin + * + */ +package testopia.Test; + +import java.io.File; +import java.io.IOException; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.Iterator; +import java.util.List; + +import org.jdom.Element; +import org.jdom.JDOMException; +import org.jdom.input.SAXBuilder; + +/** + * + * @author anelson + * Parses the given XML document into testsuites and testcases, so that + * testopia can be updated + */ +public class ParseAnt { + private File XMLFile; + private TestopiaConnector testopiaConnector; + private Integer buildID; + private Integer environmentID; + + public ParseAnt(File XMLFile, TestopiaConnector testopiaConnector, + Integer buildID, Integer environmentID) + { + this.XMLFile = XMLFile; + this.testopiaConnector = testopiaConnector; + this.buildID = buildID; + this.environmentID = environmentID; + } + + /** + * Process the XML and uploads the results to testopia + * @throws Exception + * + */ + public void processXMl() throws Exception + { + + List testSuites = null; + + //get the testSuite data from XML + try + { + testSuites = (new SAXBuilder()).build(XMLFile).getRootElement().getChildren("testsuite"); + } + catch (Exception e) + { + e.printStackTrace(); + } + + //if there are suites listed in the xml file + //parse through the testCases + if (testSuites.size() != 0) + { + List testCases = null; + Iterator testSuiteIt = testSuites.iterator(); + Iterator testCaseIt = null; + + //for all testsuites + while (testSuiteIt.hasNext()) + { + Element testSuite = (Element) testSuiteIt.next(); + + //get package and suite information + String classname = testSuite.getAttribute("package").getValue() + + "." + testSuite.getAttribute("name").getValue(); + String suitename = testSuite.getAttribute("name") + .getValue(); + + System.out.println("-->Processing class '" + classname + "'"); + System.out.println("-->Working on suite '" + suitename + "'"); + + testCases = testSuite.getChildren("testcase"); + testCaseIt = testCases.iterator(); + String name = null; + String message = null; + String testCaseName = null; + + //loop for all testcases + while(testCaseIt.hasNext()) + { + Element testCase = (Element) testCaseIt.next(); + name = testCase.getAttributeValue("name"); + testCaseName = testCase.getAttributeValue("classname"); + Element failure = testCase.getChild("failure"); + Element error = testCase.getChild("error"); + boolean blocker = false; + +// get the failure message, otherwise reset message to null + if(failure!=null) + { + message = failure.getContent(0).getValue(); + + } + + else if(error != null) + { + message = error.getContent(0).getValue(); + blocker = true; + } + + else if(failure == null && error == null) + message = null; + + name = testCaseName + "." + name; + testopiaConnector.processTestCase(name, message, buildID, environmentID, testCaseName, blocker); + + } + + + + } + } + + } +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/TestCaseRunnable.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/TestCaseRunnable.java new file mode 100644 index 00000000000..bb5097cedab --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/TestCaseRunnable.java @@ -0,0 +1,64 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * + */ +package testopia.Test; + +import testopia.API.TestopiaTestCase; + +public class TestCaseRunnable implements Runnable +{ + private TestopiaTestCase testCase; + private int authorID; + private int caseStatusID; + private int categoryID; + private boolean isAutomated; + private int planID; + private String name; + private Integer priorityID; + private Integer caseID; + + public TestCaseRunnable(TestopiaTestCase testCase, int authorID, int caseStatusID, + int categoryID, boolean isAutomated, int planID, + String name, Integer priorityID, Integer caseID) + { + this.testCase = testCase; + this.authorID = authorID; + this.caseStatusID = caseStatusID; + this.categoryID = categoryID; + this.isAutomated = isAutomated; + this.planID = planID; + this.name = name; + this.priorityID = priorityID; + this.caseID = caseID; + + } + + public void run() + { + caseID = testCase.makeTestCase(authorID, caseStatusID, categoryID, true, planID, name, null); + } + + public static void main(String args[]) + { + //(new Thread(new TestCaseRunnable())).start(); + } + +} + diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/TestopiaConnector.java b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/TestopiaConnector.java new file mode 100644 index 00000000000..cb46ee25dc4 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopia/Test/TestopiaConnector.java @@ -0,0 +1,354 @@ + /* + * 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 Java API. + * + * The Initial Developer of the Original Code is Andrew Nelson. + * Portions created by Andrew Nelson are Copyright (C) 2006 + * Novell. All Rights Reserved. + * + * Contributor(s): Andrew Nelson + * Jason Sabin + * + */ +package testopia.Test; + +import java.io.BufferedWriter; +import java.net.URL; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Date; +import java.util.HashMap; +import java.util.List; + +import testopia.API.TestCaseRun; +import testopia.API.TestRun; +import testopia.API.TestopiaTestCase; +import testopia.API.User; + +public class TestopiaConnector +{ + private int planID; + private int runID; + private int defaultPriority; + private String defaultCategory; + private TestRun testRun; + private String username; + private String password; + private URL serverURL; + private HashMap testCasesMap; + private HashMap testRunCasesMap; + private int authorID; + private String email; + private OptionalValues optionalValues; + private BufferedWriter out; + private boolean blockers; + private boolean newTestCaseRunEveryTime; + + /** + * This constuctor is for already created TestPlans + * @param testPlanID + * @param testRunID + * @param userName + * @param password + * @param serverURL + * @throws Exception + */ + public TestopiaConnector(int testPlanID, int testRunID, String userName, + String password, String email, URL serverURL, + OptionalValues optionaValues, BufferedWriter out, boolean blockers, int defaultPriority, String defaultCategory, boolean newTestCaseRunEveryTime) throws Exception + { + this.planID = testPlanID; + this.runID = testRunID; + this.username = userName; + this.password = password; + this.serverURL = serverURL; + this.email = email; + this.out = out; + this.blockers = blockers; + this.defaultPriority = defaultPriority; + this.defaultCategory = defaultCategory; + this.newTestCaseRunEveryTime = newTestCaseRunEveryTime; + + //make the array of testCases into a hashmap + testRun = new TestRun(userName, password, serverURL, testRunID); + Object[] testCases = testRun.getTestCases(); + + HashMap testCasesMap = new HashMap(testCases.length); + for(int i = 0; i < testCases.length; i++) + { + String key = (String)((HashMap)testCases[i]).get("summary"); + testCasesMap.put(key, (HashMap)testCases[i]); + } + + this.testCasesMap = testCasesMap; + + //make the array of testRunCases into a hashmap + Object[] testRunCases = testRun.getTestCaseRuns(); + + HashMap testRunCasesMap = new HashMap(testRunCases.length); + for(int i = 0; i < testRunCases.length; i++) + { + Integer key = (Integer)((HashMap)testRunCases[i]).get("case_id"); + testRunCasesMap.put(key, (HashMap)testRunCases[i]); + } + + this.testRunCasesMap = testRunCasesMap; + + //get the userID + User user = new User(username, password, email, serverURL); + this.authorID = user.getAttributes(); + + //get the optionalValues object + this.optionalValues = optionaValues; + + } + + /** + * This takes a parsed junit result and will either create a testcase and testCaseRun or updates them + * @param name + * @param message + * @param caseStatusID + * @param categoryID + * @param buildID + * @param environmentID + * @throws Exception + */ + public void processTestCase(String name, String message, Integer buildID, + Integer environmentID, String className, boolean blocker) throws Exception + { + //setup failsafe defaults + Integer caseStatusID = 2; + Integer categoryID = 1; + int authorID = this.authorID; + Integer priorityID = this.defaultPriority; + + if(buildID == null) + buildID = 2; + + if(environmentID == null) + environmentID = 1; + + int passedOrFailed; + + //check to see if the testCase passed or is blocked + if(message == null) + passedOrFailed = 2; + else if(blockers == true && blocker == true) + passedOrFailed = 6; + else + passedOrFailed = 3; + + + //get optionalValues setup to give data for the current class + boolean classExists = optionalValues.selectClass(className); + + //if data exists on the current class, then use that data instead of the + //defaults + String tempAssignee; + int tempPriority; + ArrayList components = null; + Integer category = null; + + if(classExists) + { + //get optional data if it exists + tempAssignee = optionalValues.getAssignee(); + if(!tempAssignee.equals("null")) + { + User user = new User(username, password, tempAssignee, serverURL); + authorID = user.getAttributes(); + } + + + tempPriority = optionalValues.getPriority(); + if(tempPriority != 0) + { + priorityID = tempPriority; + } + + //get the components for the class + components = optionalValues.getComponents(); + + //get the categories for the class + category = optionalValues.getCategories(); + } + + + HashMap testCaseMap = testCasesMap.get(name); + + int caseID = 0; + + // make new testCase if it doesn't exist, otherwise get caseID + if(testCaseMap == null) + { + TestopiaTestCase testCase = new TestopiaTestCase(username, password, serverURL, null); + categoryID = testCase.getCategoryIdByName(defaultCategory); + caseID = testCase.makeTestCase(authorID, caseStatusID, categoryID, true, planID, name, priorityID); + + + //add all the components, if components exist + if(components != null) + { + for(Integer componentID: components) + { + testCase.addComponent(componentID); + } + + } + + //update the category if it exists + if(category != null) + { + testCase.setCategoryID(category); + testCase.update(); + } + } + + else + { + caseID = (Integer)testCaseMap.get("case_id"); + TestopiaTestCase testCase = new TestopiaTestCase(username, password, serverURL, caseID); + + if(classExists) + { + //check to see if the testCase's priority needs to be updated + Integer priority = null; + try { + priority = (Integer) testCaseMap.get("priority_id"); + } + + catch (Exception e) { + } + + + if(priorityID != null && (priority == null || priorityID != priority.intValue())) + testCase.setPriorityID(priorityID); + + //get the components for the testCase + Object[] componentArray = testCase.getComponents(); + List tempList = Arrays.asList(componentArray); + ArrayList componentList = new ArrayList(tempList); + ArrayList componentInts = new ArrayList(); + testCase.update(); + + //get all the component IDs out and put them into a new ArrayList + for(Object componentObject: componentList) + { + HashMap componentMap = (HashMap)componentObject; + componentInts.add((Integer)componentMap.get("id")); + } + + //loop to see if the component exists already + for(Object componentID: components) + { + //if it exists, remove it from the list + if( componentInts.contains(componentID)) + componentInts.remove(componentID); + + //otherwise, add the component to the list + else + testCase.addComponent((Integer)componentID); + } + + //if any components are left, then remove them from the arrayList + for(Integer componentID: componentInts) + { + testCase.removeComponent(componentID); + } + + //update the category if it exists + if(category != null) + { + testCase.setCategoryID(category); + testCase.update(); + } + + } + } + + //check to see if testCase exists in testRun + HashMap testRunCaseMap = testRunCasesMap.get(caseID); + + //if it's null or newTestCaseRunEveryTime is true, then add to test run, otherwise update testRunCase + if(testRunCaseMap == null || newTestCaseRunEveryTime == true ) + { + TestCaseRun caseRun = new TestCaseRun(username, password, caseID, runID, + buildID, environmentID, null, serverURL); + + //try and create testCaseRun + try + { + int makeTestCaseRunResult = caseRun.makeTestCaseRun(authorID, 1); + if(makeTestCaseRunResult == 0){ + //Try to update instead + int caseRunID = (Integer)testRunCaseMap.get("case_run_id"); + System.out.println("Attempting to Update TestCaseRun "+caseRunID); + TestCaseRun caseRunTryAgain = new TestCaseRun(username, password, caseID, runID, + buildID, environmentID, caseRunID, serverURL); + } + caseRun.setStatus(passedOrFailed); + + if(message != null) + caseRun.setNotes(message); + + caseRun.update(); + } + catch (Exception e) + { + + e.printStackTrace(); + } + } + + else + { + //if the testCaseRun exists, update it with the new information + int caseRunID = (Integer)testRunCaseMap.get("case_run_id"); + TestCaseRun caseRun = new TestCaseRun(username, password, caseID, runID, + buildID, environmentID, caseRunID, serverURL); + + if(message != null) + caseRun.setNotes(message); + else + caseRun.setNotes("Passed at " + new Date()); + + caseRun.setBuildID(buildID); + caseRun.setStatus(passedOrFailed); + + + //check to see if the assignee needs to be updated + Integer currentAssignee = (Integer)testRunCaseMap.get("assignee"); + if(currentAssignee == null || authorID != currentAssignee) + { + caseRun.setAssigneeID(authorID); + } + + //try and push the update to testopia + try + { + caseRun.update(); + } catch (Exception e) + { + e.printStackTrace(); + } + + } + + //log the results + if(!classExists) + { + out.write("Class Not In Optional Data: " + className + "\n"); + } + + } + +} diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopiaData.xml b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopiaData.xml new file mode 100644 index 00000000000..b91bc21ea20 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/java/testopiaData.xml @@ -0,0 +1,34 @@ + + + username + password + + + TESTS-TestSuites.xml + + http://apibugzillastage.provo.novell.com/tr_xmlrpc.cgi + 0 + 0 + + username@novell.com + + Testopia + 1.0 API + linux/firefox + + yes + + yes + + 4 + + Functionality + + + 0 + 0 + 0 + \ No newline at end of file diff --git a/mozilla/webtools/testopia/testopia/contrib/drivers/php/.xmlrpc.inc.php b/mozilla/webtools/testopia/testopia/contrib/drivers/php/.xmlrpc.inc.php new file mode 100644 index 00000000000..22b67f711b9 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/contrib/drivers/php/.xmlrpc.inc.php @@ -0,0 +1,3566 @@ + +// $Id: .xmlrpc.inc.php,v 1.1 2008-02-29 23:36:45 ghendricks%novell.com Exp $ + +// Copyright (c) 1999,2000,2002 Edd Dumbill. +// All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions +// are met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following +// disclaimer in the documentation and/or other materials provided +// with the distribution. +// +// * Neither the name of the "XML-RPC for PHP" nor the names of its +// contributors may be used to endorse or promote products derived +// from this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +// REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. + + if(!function_exists('xml_parser_create')) + { + // For PHP 4 onward, XML functionality is always compiled-in on windows: + // no more need to dl-open it. It might have been compiled out on *nix... + if(strtoupper(substr(PHP_OS, 0, 3) != 'WIN')) + { + dl('xml.so'); + } + } + + // Try to be backward compat with php < 4.2 (are we not being nice ?) + $phpversion = phpversion(); + if($phpversion[0] == '4' && $phpversion[2] < 2) + { + // give an opportunity to user to specify where to include other files from + if(!defined('PHP_XMLRPC_COMPAT_DIR')) + { + define('PHP_XMLRPC_COMPAT_DIR',dirname(__FILE__).'/compat/'); + } + if($phpversion[2] == '0') + { + if($phpversion[4] < 6) + { + include(PHP_XMLRPC_COMPAT_DIR.'is_callable.php'); + } + include(PHP_XMLRPC_COMPAT_DIR.'is_scalar.php'); + include(PHP_XMLRPC_COMPAT_DIR.'array_key_exists.php'); + include(PHP_XMLRPC_COMPAT_DIR.'version_compare.php'); + } + include(PHP_XMLRPC_COMPAT_DIR.'var_export.php'); + include(PHP_XMLRPC_COMPAT_DIR.'is_a.php'); + } + + // G. Giunta 2005/01/29: declare global these variables, + // so that xmlrpc.inc will work even if included from within a function + // Milosch: 2005/08/07 - explicitly request these via $GLOBALS where used. + $GLOBALS['xmlrpcI4']='i4'; + $GLOBALS['xmlrpcInt']='int'; + $GLOBALS['xmlrpcBoolean']='boolean'; + $GLOBALS['xmlrpcDouble']='double'; + $GLOBALS['xmlrpcString']='string'; + $GLOBALS['xmlrpcDateTime']='dateTime.iso8601'; + $GLOBALS['xmlrpcBase64']='base64'; + $GLOBALS['xmlrpcArray']='array'; + $GLOBALS['xmlrpcStruct']='struct'; + $GLOBALS['xmlrpcValue']='undefined'; + + $GLOBALS['xmlrpcTypes']=array( + $GLOBALS['xmlrpcI4'] => 1, + $GLOBALS['xmlrpcInt'] => 1, + $GLOBALS['xmlrpcBoolean'] => 1, + $GLOBALS['xmlrpcString'] => 1, + $GLOBALS['xmlrpcDouble'] => 1, + $GLOBALS['xmlrpcDateTime'] => 1, + $GLOBALS['xmlrpcBase64'] => 1, + $GLOBALS['xmlrpcArray'] => 2, + $GLOBALS['xmlrpcStruct'] => 3 + ); + + $GLOBALS['xmlrpc_valid_parents'] = array( + 'VALUE' => array('MEMBER', 'DATA', 'PARAM', 'FAULT'), + 'BOOLEAN' => array('VALUE'), + 'I4' => array('VALUE'), + 'INT' => array('VALUE'), + 'STRING' => array('VALUE'), + 'DOUBLE' => array('VALUE'), + 'DATETIME.ISO8601' => array('VALUE'), + 'BASE64' => array('VALUE'), + 'MEMBER' => array('STRUCT'), + 'NAME' => array('MEMBER'), + 'DATA' => array('ARRAY'), + 'ARRAY' => array('VALUE'), + 'STRUCT' => array('VALUE'), + 'PARAM' => array('PARAMS'), + 'METHODNAME' => array('METHODCALL'), + 'PARAMS' => array('METHODCALL', 'METHODRESPONSE'), + 'FAULT' => array('METHODRESPONSE'), + 'NIL' => array('VALUE') // only used when extension activated + ); + + // define extra types for supporting NULL (useful for json or ) + $GLOBALS['xmlrpcNull']='null'; + $GLOBALS['xmlrpcTypes']['null']=1; + + // Not in use anymore since 2.0. Shall we remove it? + /// @deprecated + $GLOBALS['xmlEntities']=array( + 'amp' => '&', + 'quot' => '"', + 'lt' => '<', + 'gt' => '>', + 'apos' => "'" + ); + + // tables used for transcoding different charsets into us-ascii xml + + $GLOBALS['xml_iso88591_Entities']=array(); + $GLOBALS['xml_iso88591_Entities']['in'] = array(); + $GLOBALS['xml_iso88591_Entities']['out'] = array(); + for ($i = 0; $i < 32; $i++) + { + $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i); + $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';'; + } + for ($i = 160; $i < 256; $i++) + { + $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i); + $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';'; + } + + /// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159. + /// These will NOT be present in true ISO-8859-1, but will save the unwary + /// windows user from sending junk. +/* +$cp1252_to_xmlent = + array( + '\x80'=>'€', '\x81'=>'?', '\x82'=>'‚', '\x83'=>'ƒ', + '\x84'=>'„', '\x85'=>'…', '\x86'=>'†', \x87'=>'‡', + '\x88'=>'ˆ', '\x89'=>'‰', '\x8A'=>'Š', '\x8B'=>'‹', + '\x8C'=>'Œ', '\x8D'=>'?', '\x8E'=>'Ž', '\x8F'=>'?', + '\x90'=>'?', '\x91'=>'‘', '\x92'=>'’', '\x93'=>'“', + '\x94'=>'”', '\x95'=>'•', '\x96'=>'–', '\x97'=>'—', + '\x98'=>'˜', '\x99'=>'™', '\x9A'=>'š', '\x9B'=>'›', + '\x9C'=>'œ', '\x9D'=>'?', '\x9E'=>'ž', '\x9F'=>'Ÿ' + ); +*/ + + $GLOBALS['xmlrpcerr']['unknown_method']=1; + $GLOBALS['xmlrpcstr']['unknown_method']='Unknown method'; + $GLOBALS['xmlrpcerr']['invalid_return']=2; + $GLOBALS['xmlrpcstr']['invalid_return']='Invalid return payload: enable debugging to examine incoming payload'; + $GLOBALS['xmlrpcerr']['incorrect_params']=3; + $GLOBALS['xmlrpcstr']['incorrect_params']='Incorrect parameters passed to method'; + $GLOBALS['xmlrpcerr']['introspect_unknown']=4; + $GLOBALS['xmlrpcstr']['introspect_unknown']="Can't introspect: method unknown"; + $GLOBALS['xmlrpcerr']['http_error']=5; + $GLOBALS['xmlrpcstr']['http_error']="Didn't receive 200 OK from remote server."; + $GLOBALS['xmlrpcerr']['no_data']=6; + $GLOBALS['xmlrpcstr']['no_data']='No data received from server.'; + $GLOBALS['xmlrpcerr']['no_ssl']=7; + $GLOBALS['xmlrpcstr']['no_ssl']='No SSL support compiled in.'; + $GLOBALS['xmlrpcerr']['curl_fail']=8; + $GLOBALS['xmlrpcstr']['curl_fail']='CURL error'; + $GLOBALS['xmlrpcerr']['invalid_request']=15; + $GLOBALS['xmlrpcstr']['invalid_request']='Invalid request payload'; + $GLOBALS['xmlrpcerr']['no_curl']=16; + $GLOBALS['xmlrpcstr']['no_curl']='No CURL support compiled in.'; + $GLOBALS['xmlrpcerr']['server_error']=17; + $GLOBALS['xmlrpcstr']['server_error']='Internal server error'; + $GLOBALS['xmlrpcerr']['multicall_error']=18; + $GLOBALS['xmlrpcstr']['multicall_error']='Received from server invalid multicall response'; + + $GLOBALS['xmlrpcerr']['multicall_notstruct'] = 9; + $GLOBALS['xmlrpcstr']['multicall_notstruct'] = 'system.multicall expected struct'; + $GLOBALS['xmlrpcerr']['multicall_nomethod'] = 10; + $GLOBALS['xmlrpcstr']['multicall_nomethod'] = 'missing methodName'; + $GLOBALS['xmlrpcerr']['multicall_notstring'] = 11; + $GLOBALS['xmlrpcstr']['multicall_notstring'] = 'methodName is not a string'; + $GLOBALS['xmlrpcerr']['multicall_recursion'] = 12; + $GLOBALS['xmlrpcstr']['multicall_recursion'] = 'recursive system.multicall forbidden'; + $GLOBALS['xmlrpcerr']['multicall_noparams'] = 13; + $GLOBALS['xmlrpcstr']['multicall_noparams'] = 'missing params'; + $GLOBALS['xmlrpcerr']['multicall_notarray'] = 14; + $GLOBALS['xmlrpcstr']['multicall_notarray'] = 'params is not an array'; + + $GLOBALS['xmlrpcerr']['cannot_decompress']=103; + $GLOBALS['xmlrpcstr']['cannot_decompress']='Received from server compressed HTTP and cannot decompress'; + $GLOBALS['xmlrpcerr']['decompress_fail']=104; + $GLOBALS['xmlrpcstr']['decompress_fail']='Received from server invalid compressed HTTP'; + $GLOBALS['xmlrpcerr']['dechunk_fail']=105; + $GLOBALS['xmlrpcstr']['dechunk_fail']='Received from server invalid chunked HTTP'; + $GLOBALS['xmlrpcerr']['server_cannot_decompress']=106; + $GLOBALS['xmlrpcstr']['server_cannot_decompress']='Received from client compressed HTTP request and cannot decompress'; + $GLOBALS['xmlrpcerr']['server_decompress_fail']=107; + $GLOBALS['xmlrpcstr']['server_decompress_fail']='Received from client invalid compressed HTTP request'; + + // The charset encoding used by the server for received messages and + // by the client for received responses when received charset cannot be determined + // or is not supported + $GLOBALS['xmlrpc_defencoding']='UTF-8'; + + // The encoding used internally by PHP. + // String values received as xml will be converted to this, and php strings will be converted to xml + // as if having been coded with this + $GLOBALS['xmlrpc_internalencoding']='ISO-8859-1'; + + $GLOBALS['xmlrpcName']='XML-RPC for PHP'; + $GLOBALS['xmlrpcVersion']='2.1'; + + // let user errors start at 800 + $GLOBALS['xmlrpcerruser']=800; + // let XML parse errors start at 100 + $GLOBALS['xmlrpcerrxml']=100; + + // formulate backslashes for escaping regexp + // Not in use anymore since 2.0. Shall we remove it? + /// @deprecated + $GLOBALS['xmlrpc_backslash']=chr(92).chr(92); + + // used to store state during parsing + // quick explanation of components: + // ac - used to accumulate values + // isf - used to indicate a parsing fault (2) or xmlrpcresp fault (1) + // isf_reason - used for storing xmlrpcresp fault string + // lv - used to indicate "looking for a value": implements + // the logic to allow values with no types to be strings + // params - used to store parameters in method calls + // method - used to store method name + // stack - array with genealogy of xml elements names: + // used to validate nesting of xmlrpc elements + $GLOBALS['_xh']=null; + + /** + * Convert a string to the correct XML representation in a target charset + * To help correct communication of non-ascii chars inside strings, regardless + * of the charset used when sending requests, parsing them, sending responses + * and parsing responses, an option is to convert all non-ascii chars present in the message + * into their equivalent 'charset entity'. Charset entities enumerated this way + * are independent of the charset encoding used to transmit them, and all XML + * parsers are bound to understand them. + * Note that in the std case we are not sending a charset encoding mime type + * along with http headers, so we are bound by RFC 3023 to emit strict us-ascii. + * + * @todo do a bit of basic benchmarking (strtr vs. str_replace) + * @todo make usage of iconv() or recode_string() or mb_string() where available + */ + function xmlrpc_encode_entitites($data, $src_encoding='', $dest_encoding='') + { + if ($src_encoding == '') + { + // lame, but we know no better... + $src_encoding = $GLOBALS['xmlrpc_internalencoding']; + } + + switch(strtoupper($src_encoding.'_'.$dest_encoding)) + { + case 'ISO-8859-1_': + case 'ISO-8859-1_US-ASCII': + $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); + $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data); + break; + case 'ISO-8859-1_UTF-8': + $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); + $escaped_data = utf8_encode($escaped_data); + break; + case 'ISO-8859-1_ISO-8859-1': + case 'US-ASCII_US-ASCII': + case 'US-ASCII_UTF-8': + case 'US-ASCII_': + case 'US-ASCII_ISO-8859-1': + case 'UTF-8_UTF-8': + $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); + break; + case 'UTF-8_': + case 'UTF-8_US-ASCII': + case 'UTF-8_ISO-8859-1': + // NB: this will choke on invalid UTF-8, going most likely beyond EOF + $escaped_data = ''; + // be kind to users creating string xmlrpcvals out of different php types + $data = (string) $data; + $ns = strlen ($data); + for ($nn = 0; $nn < $ns; $nn++) + { + $ch = $data[$nn]; + $ii = ord($ch); + //1 7 0bbbbbbb (127) + if ($ii < 128) + { + /// @todo shall we replace this with a (supposedly) faster str_replace? + switch($ii){ + case 34: + $escaped_data .= '"'; + break; + case 38: + $escaped_data .= '&'; + break; + case 39: + $escaped_data .= '''; + break; + case 60: + $escaped_data .= '<'; + break; + case 62: + $escaped_data .= '>'; + break; + default: + $escaped_data .= $ch; + } // switch + } + //2 11 110bbbbb 10bbbbbb (2047) + else if ($ii>>5 == 6) + { + $b1 = ($ii & 31); + $ii = ord($data[$nn+1]); + $b2 = ($ii & 63); + $ii = ($b1 * 64) + $b2; + $ent = sprintf ('&#%d;', $ii); + $escaped_data .= $ent; + } + //3 16 1110bbbb 10bbbbbb 10bbbbbb + else if ($ii>>4 == 14) + { + $b1 = ($ii & 31); + $ii = ord($data[$nn+1]); + $b2 = ($ii & 63); + $ii = ord($data[$nn+2]); + $b3 = ($ii & 63); + $ii = ((($b1 * 64) + $b2) * 64) + $b3; + $ent = sprintf ('&#%d;', $ii); + $escaped_data .= $ent; + } + //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb + else if ($ii>>3 == 30) + { + $b1 = ($ii & 31); + $ii = ord($data[$nn+1]); + $b2 = ($ii & 63); + $ii = ord($data[$nn+2]); + $b3 = ($ii & 63); + $ii = ord($data[$nn+3]); + $b4 = ($ii & 63); + $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4; + $ent = sprintf ('&#%d;', $ii); + $escaped_data .= $ent; + } + } + break; + default: + $escaped_data = ''; + error_log("Converting from $src_encoding to $dest_encoding: not supported..."); + } + return $escaped_data; + } + + /// xml parser handler function for opening element tags + function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false) + { + // if invalid xmlrpc already detected, skip all processing + if ($GLOBALS['_xh']['isf'] < 2) + { + // check for correct element nesting + // top level element can only be of 2 types + /// @todo optimization creep: save this check into a bool variable, instead of using count() every time: + /// there is only a single top level element in xml anyway + if (count($GLOBALS['_xh']['stack']) == 0) + { + if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && ( + $name != 'VALUE' && !$accept_single_vals)) + { + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = 'missing top level xmlrpc element'; + return; + } + else + { + $GLOBALS['_xh']['rt'] = strtolower($name); + } + } + else + { + // not top level element: see if parent is OK + $parent = end($GLOBALS['_xh']['stack']); + if (!array_key_exists($name, $GLOBALS['xmlrpc_valid_parents']) || !in_array($parent, $GLOBALS['xmlrpc_valid_parents'][$name])) + { + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "xmlrpc element $name cannot be child of $parent"; + return; + } + } + + switch($name) + { + // optimize for speed switch cases: most common cases first + case 'VALUE': + /// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element + $GLOBALS['_xh']['vt']='value'; // indicator: no value found yet + $GLOBALS['_xh']['ac']=''; + $GLOBALS['_xh']['lv']=1; + $GLOBALS['_xh']['php_class']=null; + break; + case 'I4': + case 'INT': + case 'STRING': + case 'BOOLEAN': + case 'DOUBLE': + case 'DATETIME.ISO8601': + case 'BASE64': + if ($GLOBALS['_xh']['vt']!='value') + { + //two data elements inside a value: an error occurred! + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value"; + return; + } + $GLOBALS['_xh']['ac']=''; // reset the accumulator + break; + case 'STRUCT': + case 'ARRAY': + if ($GLOBALS['_xh']['vt']!='value') + { + //two data elements inside a value: an error occurred! + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value"; + return; + } + // create an empty array to hold child values, and push it onto appropriate stack + $cur_val = array(); + $cur_val['values'] = array(); + $cur_val['type'] = $name; + // check for out-of-band information to rebuild php objs + // and in case it is found, save it + if (@isset($attrs['PHP_CLASS'])) + { + $cur_val['php_class'] = $attrs['PHP_CLASS']; + } + $GLOBALS['_xh']['valuestack'][] = $cur_val; + $GLOBALS['_xh']['vt']='data'; // be prepared for a data element next + break; + case 'DATA': + if ($GLOBALS['_xh']['vt']!='data') + { + //two data elements inside a value: an error occurred! + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "found two data elements inside an array element"; + return; + } + case 'METHODCALL': + case 'METHODRESPONSE': + case 'PARAMS': + // valid elements that add little to processing + break; + case 'METHODNAME': + case 'NAME': + /// @todo we could check for 2 NAME elements inside a MEMBER element + $GLOBALS['_xh']['ac']=''; + break; + case 'FAULT': + $GLOBALS['_xh']['isf']=1; + break; + case 'MEMBER': + $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name']=''; // set member name to null, in case we do not find in the xml later on + //$GLOBALS['_xh']['ac']=''; + // Drop trough intentionally + case 'PARAM': + // clear value type, so we can check later if no value has been passed for this param/member + $GLOBALS['_xh']['vt']=null; + break; + case 'NIL': + // we do not support the extension yet, so + // drop through intentionally + default: + /// INVALID ELEMENT: RAISE ISF so that it is later recognized!!! + $GLOBALS['_xh']['isf'] = 2; + $GLOBALS['_xh']['isf_reason'] = "found not-xmlrpc xml element $name"; + break; + } + + // Save current element name to stack, to validate nesting + $GLOBALS['_xh']['stack'][] = $name; + + /// @todo optimization creep: move this inside the big switch() above + if($name!='VALUE') + { + $GLOBALS['_xh']['lv']=0; + } + } + } + + /// Used in decoding xml chunks that might represent single xmlrpc values + function xmlrpc_se_any($parser, $name, $attrs) + { + xmlrpc_se($parser, $name, $attrs, true); + } + + /// xml parser handler function for close element tags + function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true) + { + if ($GLOBALS['_xh']['isf'] < 2) + { + // push this element name from stack + // NB: if XML validates, correct opening/closing is guaranteed and + // we do not have to check for $name == $curr_elem. + // we also checked for proper nesting at start of elements... + $curr_elem = array_pop($GLOBALS['_xh']['stack']); + + switch($name) + { + case 'VALUE': + // This if() detects if no scalar was inside + if ($GLOBALS['_xh']['vt']=='value') + { + $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac']; + $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcString']; + } + + if ($rebuild_xmlrpcvals) + { + // build the xmlrpc val out of the data received, and substitute it + $temp =& new xmlrpcval($GLOBALS['_xh']['value'], $GLOBALS['_xh']['vt']); + // in case we got info about underlying php class, save it + // in the object we're rebuilding + if (isset($GLOBALS['_xh']['php_class'])) + $temp->_php_class = $GLOBALS['_xh']['php_class']; + // check if we are inside an array or struct: + // if value just built is inside an array, let's move it into array on the stack + $vscount = count($GLOBALS['_xh']['valuestack']); + if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY') + { + $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $temp; + } + else + { + $GLOBALS['_xh']['value'] = $temp; + } + } + else + { + /// @todo this needs to treat correctly php-serialized objects, + /// since std deserializing is done by php_xmlrpc_decode, + /// which we will not be calling... + if (isset($GLOBALS['_xh']['php_class'])) + { + } + + // check if we are inside an array or struct: + // if value just built is inside an array, let's move it into array on the stack + $vscount = count($GLOBALS['_xh']['valuestack']); + if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY') + { + $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $GLOBALS['_xh']['value']; + } + } + break; + case 'BOOLEAN': + case 'I4': + case 'INT': + case 'STRING': + case 'DOUBLE': + case 'DATETIME.ISO8601': + case 'BASE64': + $GLOBALS['_xh']['vt']=strtolower($name); + /// @todo: optimization creep - remove the if/elseif cycle below + /// since the case() in which we are already did that + if ($name=='STRING') + { + $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac']; + } + elseif ($name=='DATETIME.ISO8601') + { + if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $GLOBALS['_xh']['ac'])) + { + error_log('XML-RPC: invalid value received in DATETIME: '.$GLOBALS['_xh']['ac']); + } + $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcDateTime']; + $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac']; + } + elseif ($name=='BASE64') + { + /// @todo check for failure of base64 decoding / catch warnings + $GLOBALS['_xh']['value']=base64_decode($GLOBALS['_xh']['ac']); + } + elseif ($name=='BOOLEAN') + { + // special case here: we translate boolean 1 or 0 into PHP + // constants true or false. + // Strings 'true' and 'false' are accepted, even though the + // spec never mentions them (see eg. Blogger api docs) + // NB: this simple checks helps a lot sanitizing input, ie no + // security problems around here + if ($GLOBALS['_xh']['ac']=='1' || strcasecmp($GLOBALS['_xh']['ac'], 'true') == 0) + { + $GLOBALS['_xh']['value']=true; + } + else + { + // log if receiveing something strange, even though we set the value to false anyway + if ($GLOBALS['_xh']['ac']!='0' && strcasecmp($_xh[$parser]['ac'], 'false') != 0) + error_log('XML-RPC: invalid value received in BOOLEAN: '.$GLOBALS['_xh']['ac']); + $GLOBALS['_xh']['value']=false; + } + } + elseif ($name=='DOUBLE') + { + // we have a DOUBLE + // we must check that only 0123456789-. are characters here + if (!preg_match('/^[+-]?[eE0123456789 \t.]+$/', $GLOBALS['_xh']['ac'])) + { + /// @todo: find a better way of throwing an error + // than this! + error_log('XML-RPC: non numeric value received in DOUBLE: '.$GLOBALS['_xh']['ac']); + $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND'; + } + else + { + // it's ok, add it on + $GLOBALS['_xh']['value']=(double)$GLOBALS['_xh']['ac']; + } + } + else + { + // we have an I4/INT + // we must check that only 0123456789- are characters here + if (!preg_match('/^[+-]?[0123456789 \t]+$/', $GLOBALS['_xh']['ac'])) + { + /// @todo find a better way of throwing an error + // than this! + error_log('XML-RPC: non numeric value received in INT: '.$GLOBALS['_xh']['ac']); + $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND'; + } + else + { + // it's ok, add it on + $GLOBALS['_xh']['value']=(int)$GLOBALS['_xh']['ac']; + } + } + //$GLOBALS['_xh']['ac']=''; // is this necessary? + $GLOBALS['_xh']['lv']=3; // indicate we've found a value + break; + case 'NAME': + $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name'] = $GLOBALS['_xh']['ac']; + break; + case 'MEMBER': + //$GLOBALS['_xh']['ac']=''; // is this necessary? + // add to array in the stack the last element built, + // unless no VALUE was found + if ($GLOBALS['_xh']['vt']) + { + $vscount = count($GLOBALS['_xh']['valuestack']); + $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][$GLOBALS['_xh']['valuestack'][$vscount-1]['name']] = $GLOBALS['_xh']['value']; + } else + error_log('XML-RPC: missing VALUE inside STRUCT in received xml'); + break; + case 'DATA': + //$GLOBALS['_xh']['ac']=''; // is this necessary? + $GLOBALS['_xh']['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty + break; + case 'STRUCT': + case 'ARRAY': + // fetch out of stack array of values, and promote it to current value + $curr_val = array_pop($GLOBALS['_xh']['valuestack']); + $GLOBALS['_xh']['value'] = $curr_val['values']; + $GLOBALS['_xh']['vt']=strtolower($name); + if (isset($curr_val['php_class'])) + { + $GLOBALS['_xh']['php_class'] = $curr_val['php_class']; + } + break; + case 'PARAM': + // add to array of params the current value, + // unless no VALUE was found + if ($GLOBALS['_xh']['vt']) + { + $GLOBALS['_xh']['params'][]=$GLOBALS['_xh']['value']; + $GLOBALS['_xh']['pt'][]=$GLOBALS['_xh']['vt']; + } + else + error_log('XML-RPC: missing VALUE inside PARAM in received xml'); + break; + case 'METHODNAME': + $GLOBALS['_xh']['method']=preg_replace('/^[\n\r\t ]+/', '', $GLOBALS['_xh']['ac']); + break; + case 'PARAMS': + case 'FAULT': + case 'METHODCALL': + case 'METHORESPONSE': + break; + default: + // End of INVALID ELEMENT! + // shall we add an assert here for unreachable code??? + break; + } + } + } + + /// Used in decoding xmlrpc requests/responses without rebuilding xmlrpc values + function xmlrpc_ee_fast($parser, $name) + { + xmlrpc_ee($parser, $name, false); + } + + /// xml parser handler function for character data + function xmlrpc_cd($parser, $data) + { + // skip processing if xml fault already detected + if ($GLOBALS['_xh']['isf'] < 2) + { + // "lookforvalue==3" means that we've found an entire value + // and should discard any further character data + if($GLOBALS['_xh']['lv']!=3) + { + // G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2 + //if($GLOBALS['_xh']['lv']==1) + //{ + // if we've found text and we're just in a then + // say we've found a value + //$GLOBALS['_xh']['lv']=2; + //} + // we always initialize the accumulator before starting parsing, anyway... + //if(!@isset($GLOBALS['_xh']['ac'])) + //{ + // $GLOBALS['_xh']['ac'] = ''; + //} + $GLOBALS['_xh']['ac'].=$data; + } + } + } + + /// xml parser handler function for 'other stuff', ie. not char data or + /// element start/end tag. In fact it only gets called on unknown entities... + function xmlrpc_dh($parser, $data) + { + // skip processing if xml fault already detected + if ($GLOBALS['_xh']['isf'] < 2) + { + if(substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';') + { + // G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2 + //if($GLOBALS['_xh']['lv']==1) + //{ + // $GLOBALS['_xh']['lv']=2; + //} + $GLOBALS['_xh']['ac'].=$data; + } + } + return true; + } + + class xmlrpc_client + { + var $path; + var $server; + var $port=0; + var $method='http'; + var $errno; + var $errstr; + var $debug=0; + var $username=''; + var $password=''; + var $authtype=1; + var $cert=''; + var $certpass=''; + var $cacert=''; + var $cacertdir=''; + var $key=''; + var $keypass=''; + var $verifypeer=true; + var $verifyhost=1; + var $no_multicall=false; + var $proxy=''; + var $proxyport=0; + var $proxy_user=''; + var $proxy_pass=''; + var $proxy_authtype=1; + var $cookies=array(); + /** + * List of http compression methods accepted by the client for responses. + * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib + * + * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since + * in those cases it will be up to CURL to decide the compression methods + * it supports. You might check for the presence of 'zlib' in the output of + * curl_version() to determine wheter compression is supported or not + */ + var $accepted_compression = array(); + /** + * Name of compression scheme to be used for sending requests. + * Either null, gzip or deflate + */ + var $request_compression = ''; + /** + * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see: + * http://curl.haxx.se/docs/faq.html#7.3) + */ + var $xmlrpc_curl_handle = null; + /// Wheter to use persistent connections for http 1.1 and https + var $keepalive = false; + /// Charset encodings that can be decoded without problems by the client + var $accepted_charset_encodings = array(); + /// Charset encoding to be used in serializing request. NULL = use ASCII + var $request_charset_encoding = ''; + /** + * Decides the content of xmlrpcresp objects returned by calls to send() + * valid strings are 'xmlrpcvals', 'phpvals' or 'xml' + */ + var $return_type = 'xmlrpcvals'; + + /** + * @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php + * @param string $server the server name / ip address + * @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used + * @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed + */ + function xmlrpc_client($path, $server='', $port='', $method='') + { + // allow user to specify all params in $path + if($server == '' and $port == '' and $method == '') + { + $parts = parse_url($path); + $server = $parts['host']; + $path = $parts['path']; + if(isset($parts['query'])) + { + $path .= '?'.$parts['query']; + } + if(isset($parts['fragment'])) + { + $path .= '#'.$parts['fragment']; + } + if(isset($parts['port'])) + { + $port = $parts['port']; + } + if(isset($parts['scheme'])) + { + $method = $parts['scheme']; + } + if(isset($parts['user'])) + { + $this->username = $parts['user']; + } + if(isset($parts['pass'])) + { + $this->password = $parts['pass']; + } + } + if($path == '' || $path[0] != '/') + { + $this->path='/'.$path; + } + else + { + $this->path=$path; + } + $this->server=$server; + if($port != '') + { + $this->port=$port; + } + if($method != '') + { + $this->method=$method; + } + + // if ZLIB is enabled, let the client by default accept compressed responses + if(function_exists('gzinflate') || ( + function_exists('curl_init') && (($info = curl_version()) && + ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version']))) + )) + { + $this->accepted_compression = array('gzip', 'deflate'); + } + + // keepalives: enabled by default ONLY for PHP >= 4.3.8 + // (see http://curl.haxx.se/docs/faq.html#7.3) + if(version_compare(phpversion(), '4.3.8') >= 0) + { + $this->keepalive = true; + } + + // by default the xml parser can support these 3 charset encodings + $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII'); + } + + /** + * Enables/disables the echoing to screen of the xmlrpc responses received + * @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response) + * @access public + */ + function setDebug($in) + { + $this->debug=$in; + } + + /** + * Add some http BASIC AUTH credentials, used by the client to authenticate + * @param string $u username + * @param string $p password + * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth) + * @access public + */ + function setCredentials($u, $p, $t=1) + { + $this->username=$u; + $this->password=$p; + $this->authtype=$t; + } + + /** + * Add a client-side https certificate + * @param string $cert + * @param string $certpass + * @access public + */ + function setCertificate($cert, $certpass) + { + $this->cert = $cert; + $this->certpass = $certpass; + } + + /** + * Add a CA certificate to verify server with (see man page about + * CURLOPT_CAINFO for more details + * @param string $cacert certificate file name (or dir holding certificates) + * @param bool $is_dir set to true to indicate cacert is a dir. defaults to false + * @access public + */ + function setCaCertificate($cacert, $is_dir=false) + { + if ($is_dir) + { + $this->cacert = $cacert; + } + else + { + $this->cacertdir = $cacert; + } + } + + /** + * Set attributes for SSL communication: private SSL key + * @param string $key The name of a file containing a private SSL key + * @param string $keypass The secret password needed to use the private SSL key + * @access public + * NB: does not work in older php/curl installs + * Thanks to Daniel Convissor + */ + function setKey($key, $keypass) + { + $this->key = $key; + $this->keypass = $keypass; + } + + /** + * Set attributes for SSL communication: verify server certificate + * @param bool $i enable/disable verification of peer certificate + * @access public + */ + function setSSLVerifyPeer($i) + { + $this->verifypeer = $i; + } + + /** + * Set attributes for SSL communication: verify match of server cert w. hostname + * @param int $i + * @access public + */ + function setSSLVerifyHost($i) + { + $this->verifyhost = $i; + } + + /** + * Set proxy info + * @param string $proxyhost + * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS + * @param string $proxyusername Leave blank if proxy has public access + * @param string $proxypassword Leave blank if proxy has public access + * @param int $proxyauthtype set to constant CURLAUTH_MTLM to use NTLM auth with proxy + * @access public + */ + function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1) + { + $this->proxy = $proxyhost; + $this->proxyport = $proxyport; + $this->proxy_user = $proxyusername; + $this->proxy_pass = $proxypassword; + $this->proxy_autthtype = $proxyauthtype; + } + + /** + * Enables/disables reception of compressed xmlrpc responses. + * Note that enabling reception of compressed responses merely adds some standard + * http headers to xmlrpc requests. It is up to the xmlrpc server to return + * compressed responses when receiving such requests. + * @param string $compmethod either 'gzip', 'deflate', 'any' or '' + * @access public + */ + function setAcceptedCompression($compmethod) + { + if ($compmethod == 'any') + $this->accepted_compression = array('gzip', 'deflate'); + else + $this->accepted_compression = array($compmethod); + } + + /** + * Enables/disables http compression of xmlrpc request. + * Take care when sending compressed requests: servers might not support them + * (and automatic fallback to uncompressed requests is not yet implemented) + * @param string $compmethod either 'gzip', 'deflate' or '' + * @access public + */ + function setRequestCompression($compmethod) + { + $this->request_compression = $compmethod; + } + + /** + * Adds a cookie to list of cookies that will be sent to server. + * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie: + * do not do it unless you know what you are doing + * @param string $name + * @param string $value + * @param string $path + * @param string $domain + * @param int $port + * @access public + * + * @todo check correctness of urlencoding cookie value (copied from php way of doing it...) + */ + function setCookie($name, $value='', $path='', $domain='', $port=null) + { + $this->cookies[$name]['value'] = urlencode($value); + if ($path || $domain || $port) + { + $this->cookies[$name]['path'] = $path; + $this->cookies[$name]['domain'] = $domain; + $this->cookies[$name]['port'] = $port; + $this->cookies[$name]['version'] = 1; + } + else + { + $this->cookies[$name]['version'] = 0; + } + } + + /** + * Send an xmlrpc request + * @param mixed $msg The message object, or an array of messages for using multicall, or the complete xml representation of a request + * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply + * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used + * @return xmlrpcresp + * @access public + */ + function& send($msg, $timeout=0, $method='') + { + // if user deos not specify http protocol, use native method of this client + // (i.e. method set during call to constructor) + if($method == '') + { + $method = $this->method; + } + + if(is_array($msg)) + { + // $msg is an array of xmlrpcmsg's + $r = $this->multicall($msg, $timeout, $method); + return $r; + } + elseif(is_string($msg)) + { + $n =& new xmlrpcmsg(''); + $n->payload = $msg; + $msg = $n; + } + + // where msg is an xmlrpcmsg + $msg->debug=$this->debug; + + if($method == 'https') + { + $r =& $this->sendPayloadHTTPS( + $msg, + $this->server, + $this->port, + $timeout, + $this->username, + $this->password, + $this->authtype, + $this->cert, + $this->certpass, + $this->cacert, + $this->cacertdir, + $this->proxy, + $this->proxyport, + $this->proxy_user, + $this->proxy_pass, + $this->proxy_authtype, + $this->keepalive, + $this->key, + $this->keypass + ); + } + elseif($method == 'http11') + { + $r =& $this->sendPayloadCURL( + $msg, + $this->server, + $this->port, + $timeout, + $this->username, + $this->password, + $this->authtype, + null, + null, + null, + null, + $this->proxy, + $this->proxyport, + $this->proxy_user, + $this->proxy_pass, + $this->proxy_authtype, + 'http', + $this->keepalive + ); + } + else + { + $r =& $this->sendPayloadHTTP10( + $msg, + $this->server, + $this->port, + $timeout, + $this->username, + $this->password, + $this->authtype, + $this->proxy, + $this->proxyport, + $this->proxy_user, + $this->proxy_pass, + $this->proxy_authtype + ); + } + + return $r; + } + + /** + * @access private + */ + function &sendPayloadHTTP10($msg, $server, $port, $timeout=0, + $username='', $password='', $authtype=1, $proxyhost='', + $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1) + { + if($port==0) + { + $port=80; + } + + // Only create the payload if it was not created previously + if(empty($msg->payload)) + { + $msg->createPayload($this->request_charset_encoding); + } + + $payload = $msg->payload; + // Deflate request body and set appropriate request headers + if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) + { + if($this->request_compression == 'gzip') + { + $a = @gzencode($payload); + if($a) + { + $payload = $a; + $encoding_hdr = "Content-Encoding: gzip\r\n"; + } + } + else + { + $a = @gzcompress($payload); + if($a) + { + $payload = $a; + $encoding_hdr = "Content-Encoding: deflate\r\n"; + } + } + } + else + { + $encoding_hdr = ''; + } + + // thanks to Grant Rauscher for this + $credentials=''; + if($username!='') + { + $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n"; + if ($authtype != 1) + { + error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported with HTTP 1.0'); + } + } + + $accepted_encoding = ''; + if(is_array($this->accepted_compression) && count($this->accepted_compression)) + { + $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n"; + } + + $proxy_credentials = ''; + if($proxyhost) + { + if($proxyport == 0) + { + $proxyport = 8080; + } + $connectserver = $proxyhost; + $connectport = $proxyport; + $uri = 'http://'.$server.':'.$port.$this->path; + if($proxyusername != '') + { + if ($proxyauthtype != 1) + { + error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported with HTTP 1.0'); + } + $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername.':'.$proxypassword) . "\r\n"; + } + } + else + { + $connectserver = $server; + $connectport = $port; + $uri = $this->path; + } + + // Cookie generation, as per rfc2965 (version 1 cookies) or + // netscape's rules (version 0 cookies) + $cookieheader=''; + foreach ($this->cookies as $name => $cookie) + { + if ($cookie['version']) + { + $cookieheader .= 'Cookie: $Version="' . $cookie['version'] . '"; '; + $cookieheader .= $name . '="' . $cookie['value'] . '";'; + if ($cookie['path']) + $cookieheader .= ' $Path="' . $cookie['path'] . '";'; + if ($cookie['domain']) + $cookieheader .= ' $Domain="' . $cookie['domain'] . '";'; + if ($cookie['port']) + $cookieheader .= ' $Port="' . $cookie['domain'] . '";'; + $cookieheader = substr($cookieheader, 0, -1) . "\r\n"; + } + else + { + $cookieheader .= 'Cookie: ' . $name . '=' . $cookie['value'] . "\r\n"; + } + } + + $op= 'POST ' . $uri. " HTTP/1.0\r\n" . + 'User-Agent: ' . $GLOBALS['xmlrpcName'] . ' ' . $GLOBALS['xmlrpcVersion'] . "\r\n" . + 'Host: '. $server . ':' . $port . "\r\n" . + $credentials . + $proxy_credentials . + $accepted_encoding . + $encoding_hdr . + 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" . + $cookieheader . + 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " . + strlen($payload) . "\r\n\r\n" . + $payload; + + if($this->debug > 1) + { + print "
\n---SENDING---\n" . htmlentities($op) . "\n---END---\n
"; + // let the client see this now in case http times out... + flush(); + } + + if($timeout>0) + { + $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout); + } + else + { + $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr); + } + if($fp) + { + if($timeout>0 && function_exists('stream_set_timeout')) + { + stream_set_timeout($fp, $timeout); + } + } + else + { + $this->errstr='Connect error: '.$this->errstr; + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr . ' (' . $this->errno . ')'); + return $r; + } + + if(!fputs($fp, $op, strlen($op))) + { + $this->errstr='Write error'; + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr); + return $r; + } + else + { + // reset errno and errstr on succesful socket connection + $this->errstr = ''; + } + // G. Giunta 2005/10/24: close socket before parsing. + // should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects) + $ipd=''; + while($data=fread($fp, 32768)) + { + // shall we check for $data === FALSE? + // as per the manual, it signals an error + $ipd.=$data; + } + fclose($fp); + $r =& $msg->parseResponse($ipd, false, $this->return_type); + return $r; + + } + + /** + * @access private + */ + function &sendPayloadHTTPS($msg, $server, $port, $timeout=0, $username='', + $password='', $authtype=1, $cert='',$certpass='', $cacert='', $cacertdir='', + $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, + $keepalive=false, $key='', $keypass='') + { + $r =& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username, + $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport, + $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass); + return $r; + } + + /** + * Contributed by Justin Miller + * Requires curl to be built into PHP + * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers! + * @access private + */ + function &sendPayloadCURL($msg, $server, $port, $timeout=0, $username='', + $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='', + $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https', + $keepalive=false, $key='', $keypass='') + { + if(!function_exists('curl_init')) + { + $this->errstr='CURL unavailable on this install'; + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_curl'], $GLOBALS['xmlrpcstr']['no_curl']); + return $r; + } + if($method == 'https') + { + if(($info = curl_version()) && + ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version'])))) + { + $this->errstr='SSL unavailable on this install'; + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_ssl'], $GLOBALS['xmlrpcstr']['no_ssl']); + return $r; + } + } + + if($port == 0) + { + if($method == 'http') + { + $port = 80; + } + else + { + $port = 443; + } + } + + // Only create the payload if it was not created previously + if(empty($msg->payload)) + { + $msg->createPayload($this->request_charset_encoding); + } + + // Deflate request body and set appropriate request headers + $payload = $msg->payload; + if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) + { + if($this->request_compression == 'gzip') + { + $a = @gzencode($payload); + if($a) + { + $payload = $a; + $encoding_hdr = 'Content-Encoding: gzip'; + } + } + else + { + $a = @gzcompress($payload); + if($a) + { + $payload = $a; + $encoding_hdr = 'Content-Encoding: deflate'; + } + } + } + else + { + $encoding_hdr = ''; + } + + if($this->debug > 1) + { + print "
\n---SENDING---\n" . htmlentities($payload) . "\n---END---\n
"; + // let the client see this now in case http times out... + flush(); + } + + if(!$keepalive || !$this->xmlrpc_curl_handle) + { + $curl = curl_init($method . '://' . $server . ':' . $port . $this->path); + if($keepalive) + { + $this->xmlrpc_curl_handle = $curl; + } + } + else + { + $curl = $this->xmlrpc_curl_handle; + } + + // results into variable + curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); + + if($this->debug) + { + curl_setopt($curl, CURLOPT_VERBOSE, 1); + } + curl_setopt($curl, CURLOPT_USERAGENT, $GLOBALS['xmlrpcName'].' '.$GLOBALS['xmlrpcVersion']); + // required for XMLRPC: post the data + curl_setopt($curl, CURLOPT_POST, 1); + // the data + curl_setopt($curl, CURLOPT_POSTFIELDS, $payload); + + // return the header too + curl_setopt($curl, CURLOPT_HEADER, 1); + + // will only work with PHP >= 5.0 + // NB: if we set an empty string, CURL will add http header indicating + // ALL methods it is supporting. This is possibly a better option than + // letting the user tell what curl can / cannot do... + if(is_array($this->accepted_compression) && count($this->accepted_compression)) + { + //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression)); + // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?) + if (count($this->accepted_compression) == 1) + { + curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]); + } + else + curl_setopt($curl, CURLOPT_ENCODING, ''); + } + // extra headers + $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings)); + // if no keepalive is wanted, let the server know it in advance + if(!$keepalive) + { + $headers[] = 'Connection: close'; + } + // request compression header + if($encoding_hdr) + { + $headers[] = $encoding_hdr; + } + + curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); + // timeout is borked + if($timeout) + { + curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1); + } + + if($username && $password) + { + curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password); + if (defined('CURLOPT_HTTPAUTH')) + { + curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype); + } + else if ($authtype != 1) + { + error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth is supported by the current PHP/curl install'); + } + } + + if($method == 'https') + { + // set cert file + if($cert) + { + curl_setopt($curl, CURLOPT_SSLCERT, $cert); + } + // set cert password + if($certpass) + { + curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass); + } + // whether to verify remote host's cert + curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer); + // set ca certificates file/dir + if($cacert) + { + curl_setopt($curl, CURLOPT_CAINFO, $cacert); + } + if($cacertdir) + { + curl_setopt($curl, CURLOPT_CAPATH, $cacertdir); + } + // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?) + if($key) + { + curl_setopt($curl, CURLOPT_SSLKEY, $key); + } + // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?) + if($keypass) + { + curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass); + } + // whether to verify cert's common name (CN); 0 for no, 1 to verify that it exists, and 2 to verify that it matches the hostname used + curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost); + } + + // proxy info + if($proxyhost) + { + if($proxyport == 0) + { + $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080 + } + curl_setopt($curl, CURLOPT_PROXY,$proxyhost.':'.$proxyport); + //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport); + if($proxyusername) + { + curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword); + if (defined('CURLOPT_PROXYAUTH')) + { + curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype); + } + else if ($proxyauthtype != 1) + { + error_log('XML-RPC: xmlrpc_client::send: warning. Only Basic auth to proxy is supported by the current PHP/curl install'); + } + } + } + + // NB: should we build cookie http headers by hand rather than let CURL do it? + // the following code does not honour 'expires', 'path' and 'domain' cookie attributes + // set to clint obj the the user... + if (count($this->cookies)) + { + $cookieheader = ''; + foreach ($this->cookies as $name => $cookie) + { + $cookieheader .= $name . '=' . $cookie['value'] . ', '; + } + curl_setopt($curl, CURLOPT_COOKIE, substr($cookieheader, 0, -2)); + } + + $result = curl_exec($curl); + + if(!$result) + { + $this->errstr='no response'; + $resp=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['curl_fail'], $GLOBALS['xmlrpcstr']['curl_fail']. ': '. curl_error($curl)); + if(!$keepalive) + { + curl_close($curl); + } + } + else + { + if(!$keepalive) + { + curl_close($curl); + } + $resp =& $msg->parseResponse($result, true, $this->return_type); + } + return $resp; + } + + /** + * Send an array of request messages and return an array of responses. + * Unless $this->no_multicall has been set to true, it will try first + * to use one single xmlrpc call to server method system.multicall, and + * revert to sending many successive calls in case of failure. + * This failure is also stored in $this->no_multicall for subsequent calls. + * Unfortunately, there is no server error code universally used to denote + * the fact that multicall is unsupported, so there is no way to reliably + * distinguish between that and a temporary failure. + * If you are sure that server supports multicall and do not want to + * fallback to using many single calls, set the fourth parameter to FALSE. + * + * NB: trying to shoehorn extra functionality into existing syntax has resulted + * in pretty much convoluted code... + * + * @param array $msgs an array of xmlrpcmsg objects + * @param integer $timeout connection timeout (in seconds) + * @param string $method the http protocol variant to be used + * @param boolen fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted + * @return array + * @access public + */ + function multicall($msgs, $timeout=0, $method='http', $fallback=true) + { + if(!$this->no_multicall) + { + $results = $this->_try_multicall($msgs, $timeout, $method); + if(is_array($results)) + { + // System.multicall succeeded + return $results; + } + else + { + // either system.multicall is unsupported by server, + // or call failed for some other reason. + if ($fallback) + { + // Don't try it next time... + $this->no_multicall = true; + } + else + { + if (is_a($results, 'xmlrpcresp')) + { + $result = $results; + } + else + { + $result =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['multicall_error'], $GLOBALS['xmlrpcstr']['multicall_error']); + } + } + } + } + else + { + // override fallback, in case careless user tries to do two + // opposite things at the same time + $fallback = true; + } + + $results = array(); + if ($fallback) + { + // system.multicall is (probably) unsupported by server: + // emulate multicall via multiple requests + foreach($msgs as $msg) + { + $results[] =& $this->send($msg, $timeout, $method); + } + } + else + { + // user does NOT want to fallback on many single calls: + // since we should always return an array of responses, + // return an array with the same error repeated n times + foreach($msgs as $msg) + { + $results[] = $result; + } + } + return $results; + } + + /** + * Attempt to boxcar $msgs via system.multicall. + * Returns either an array of xmlrpcreponses, an xmlrpc error response + * or false (when recived response does not respect valid multiccall syntax) + * @access private + */ + function _try_multicall($msgs, $timeout, $method) + { + // Construct multicall message + $calls = array(); + foreach($msgs as $msg) + { + $call['methodName'] =& new xmlrpcval($msg->method(),'string'); + $numParams = $msg->getNumParams(); + $params = array(); + for($i = 0; $i < $numParams; $i++) + { + $params[$i] = $msg->getParam($i); + } + $call['params'] =& new xmlrpcval($params, 'array'); + $calls[] =& new xmlrpcval($call, 'struct'); + } + $multicall =& new xmlrpcmsg('system.multicall'); + $multicall->addParam(new xmlrpcval($calls, 'array')); + + // Attempt RPC call + $result =& $this->send($multicall, $timeout, $method); + + if($result->faultCode() != 0) + { + // call to system.multicall failed + return $result; + } + + // Unpack responses. + $rets = $result->value(); + + if ($this->return_type == 'xml') + { + return $rets; + } + else if ($this->return_type == 'phpvals') + { + ///@todo test this code branch... + $rets = $result->value(); + if(!is_array($rets)) + { + return false; // bad return type from system.multicall + } + $numRets = count($rets); + if($numRets != count($msgs)) + { + return false; // wrong number of return values. + } + + $response = array(); + for($i = 0; $i < $numRets; $i++) + { + $val = $rets[$i]; + if (!is_array($val)) { + return false; + } + switch(count($val)) + { + case 1: + if(!isset($val[0])) + { + return false; // Bad value + } + // Normal return value + $response[$i] =& new xmlrpcresp($val[0], 0, '', 'phpvals'); + break; + case 2: + /// @todo remove usage of @: it is apparently quite slow + $code = @$val['faultCode']; + if(!is_int($code)) + { + return false; + } + $str = @$val['faultString']; + if(!is_string($str)) + { + return false; + } + $response[$i] =& new xmlrpcresp(0, $code, $str); + break; + default: + return false; + } + } + return $response; + } + else // return type == 'xmlrpcvals' + { + $rets = $result->value(); + if($rets->kindOf() != 'array') + { + return false; // bad return type from system.multicall + } + $numRets = $rets->arraysize(); + if($numRets != count($msgs)) + { + return false; // wrong number of return values. + } + + $response = array(); + for($i = 0; $i < $numRets; $i++) + { + $val = $rets->arraymem($i); + switch($val->kindOf()) + { + case 'array': + if($val->arraysize() != 1) + { + return false; // Bad value + } + // Normal return value + $response[$i] =& new xmlrpcresp($val->arraymem(0)); + break; + case 'struct': + $code = $val->structmem('faultCode'); + if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int') + { + return false; + } + $str = $val->structmem('faultString'); + if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string') + { + return false; + } + $response[$i] =& new xmlrpcresp(0, $code->scalarval(), $str->scalarval()); + break; + default: + return false; + } + } + return $response; + } + } + } // end class xmlrpc_client + + class xmlrpcresp + { + var $val = 0; + var $valtyp; + var $errno = 0; + var $errstr = ''; + var $payload; + var $hdrs = array(); + var $_cookies = array(); + var $content_type = 'text/xml'; + var $raw_data = ''; + + /** + * @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string) + * @param integer $fcode set it to anything but 0 to create an error response + * @param string $fstr the error string, in case of an error response + * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml' + * + * @todo add check that $val / $fcode / $fstr is of correct type??? + * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain + * php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called... + */ + function xmlrpcresp($val, $fcode = 0, $fstr = '', $valtyp='') + { + if($fcode != 0) + { + // error response + $this->errno = $fcode; + $this->errstr = $fstr; + //$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later. + } + else + { + // successful response + $this->val = $val; + if ($valtyp == '') + { + // user did not declare type of response value: try to guess it + if (is_object($this->val) && is_a($this->val, 'xmlrpcval')) + { + $this->valtyp = 'xmlrpcvals'; + } + else if (is_string($this->val)) + { + $this->valtyp = 'xml'; + + } + else + { + $this->valtyp = 'phpvals'; + } + } + else + { + // user declares type of resp value: believe him + $this->valtyp = $valtyp; + } + } + } + + /** + * Returns the error code of the response. + * @return integer the error code of this response (0 for not-error responses) + * @access public + */ + function faultCode() + { + return $this->errno; + } + + /** + * Returns the error code of the response. + * @return string the error string of this response ('' for not-error responses) + * @access public + */ + function faultString() + { + return $this->errstr; + } + + /** + * Returns the value received by the server. + * @return mixed the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured xmlrpc_client objects + * @access public + */ + function value() + { + return $this->val; + } + + /** + * Returns an array with the cookies received from the server. + * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...) + * with attributes being e.g. 'expires', 'path', domain'. + * NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past) + * are still present in the array. It is up to the user-defined code to decide + * how to use the received cookies, and wheter they have to be sent back with the next + * request to the server (using xmlrpc_client::setCookie) or not + * @return array array of cookies received from the server + * @access public + */ + function cookies() + { + return $this->_cookies; + } + + /** + * Returns xml representation of the response. XML prologue not included + * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed + * @return string the xml representation of the response + * @access public + */ + function serialize($charset_encoding='') + { + if ($charset_encoding != '') + $this->content_type = 'text/xml; charset=' . $charset_encoding; + else + $this->content_type = 'text/xml'; + $result = "\n"; + if($this->errno) + { + // G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients + // by xml-encoding non ascii chars + $result .= "\n" . +"\nfaultCode\n" . $this->errno . +"\n\n\nfaultString\n" . +xmlrpc_encode_entitites($this->errstr, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "\n\n" . +"\n\n"; + } + else + { + if(!is_object($this->val) || !is_a($this->val, 'xmlrpcval')) + { + if (is_string($this->val) && $this->valtyp == 'xml') + { + $result .= "\n\n" . + $this->val . + "\n"; + } + else + { + /// @todo try to build something serializable? + die('cannot serialize xmlrpcresp objects whose content is native php values'); + } + } + else + { + $result .= "\n\n" . + $this->val->serialize($charset_encoding) . + "\n"; + } + } + $result .= "\n"; + $this->payload = $result; + return $result; + } + } + + class xmlrpcmsg + { + var $payload; + var $methodname; + var $params=array(); + var $debug=0; + var $content_type = 'text/xml'; + + /** + * @param string $meth the name of the method to invoke + * @param array $pars array of parameters to be paased to the method (xmlrpcval objects) + */ + function xmlrpcmsg($meth, $pars=0) + { + $this->methodname=$meth; + if(is_array($pars) && count($pars)>0) + { + for($i=0; $iaddParam($pars[$i]); + } + } + } + + /** + * @access private + */ + function xml_header($charset_encoding='') + { + if ($charset_encoding != '') + { + return "\n\n"; + } + else + { + return "\n\n"; + } + } + + /** + * @access private + */ + function xml_footer() + { + return ''; + } + + /** + * @access private + */ + function kindOf() + { + return 'msg'; + } + + /** + * @access private + */ + function createPayload($charset_encoding='') + { + if ($charset_encoding != '') + $this->content_type = 'text/xml; charset=' . $charset_encoding; + else + $this->content_type = 'text/xml'; + $this->payload=$this->xml_header($charset_encoding); + $this->payload.='' . $this->methodname . "\n"; + $this->payload.="\n"; + for($i=0; $iparams); $i++) + { + $p=$this->params[$i]; + $this->payload.="\n" . $p->serialize($charset_encoding) . + "\n"; + } + $this->payload.="\n"; + $this->payload.=$this->xml_footer(); + } + + /** + * Gets/sets the xmlrpc method to be invoked + * @param string $meth the method to be set (leave empty not to set it) + * @return string the method that will be invoked + * @access public + */ + function method($meth='') + { + if($meth!='') + { + $this->methodname=$meth; + } + return $this->methodname; + } + + /** + * Returns xml representation of the message. XML prologue included + * @return string the xml representation of the message, xml prologue included + * @access public + */ + function serialize($charset_encoding='') + { + $this->createPayload($charset_encoding); + return $this->payload; + } + + /** + * Add a parameter to the list of parameters to be used upon method invocation + * @param xmlrpcval $par + * @return boolean false on failure + * @access public + */ + function addParam($par) + { + // add check: do not add to self params which are not xmlrpcvals + if(is_object($par) && is_a($par, 'xmlrpcval')) + { + $this->params[]=$par; + return true; + } + else + { + return false; + } + } + + /** + * Returns the nth parameter in the message. The index zero-based. + * @param integer $i the index of the parameter to fetch (zero based) + * @return xmlrpcval the i-th parameter + * @access public + */ + function getParam($i) { return $this->params[$i]; } + + /** + * Returns the number of parameters in the messge. + * @return integer the number of parameters currently set + * @access public + */ + function getNumParams() { return count($this->params); } + + /** + * Given an open file handle, read all data available and parse it as axmlrpc response. + * NB: the file handle is not closed by this function. + * @access public + * @return xmlrpcresp + * @todo add 2nd & 3rd param to be passed to ParseResponse() ??? + */ + function &parseResponseFile($fp) + { + $ipd=''; + while($data=fread($fp, 32768)) + { + $ipd.=$data; + } + //fclose($fp); + $r =& $this->parseResponse($ipd); + return $r; + } + + /** + * Parses HTTP headers and separates them from data. + * @access private + */ + function &parseResponseHeaders(&$data, $headers_processed=false) + { + // Strip HTTP 1.1 100 Continue header if present + while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data)) + { + $pos = strpos($data, 'HTTP', 12); + // server sent a Continue header without any (valid) content following... + // give the client a chance to know it + if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5 + { + break; + } + $data = substr($data, $pos); + } + if(!preg_match('/^HTTP\/[0-9.]+ 200 /', $data)) + { + $errstr= substr($data, 0, strpos($data, "\n")-1); + error_log('XML-RPC: xmlrpcmsg::parseResponse: HTTP error, got response: ' .$errstr); + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (' . $errstr . ')'); + return $r; + } + + $GLOBALS['_xh']['headers'] = array(); + $GLOBALS['_xh']['cookies'] = array(); + + // be tolerant to usage of \n instead of \r\n to separate headers and data + // (even though it is not valid http) + $pos = strpos($data,"\r\n\r\n"); + if($pos || is_int($pos)) + { + $bd = $pos+4; + } + else + { + $pos = strpos($data,"\n\n"); + if($pos || is_int($pos)) + { + $bd = $pos+2; + } + else + { + // No separation between response headers and body: fault? + $bd = 0; + } + } + // be tolerant to line endings, and extra empty lines + $ar = split("\r?\n", trim(substr($data, 0, $pos))); + while(list(,$line) = @each($ar)) + { + // take care of multi-line headers and cookies + $arr = explode(':',$line,2); + if(count($arr) > 1) + { + $header_name = strtolower(trim($arr[0])); + /// @todo some other headers (the ones that allow a CSV list of values) + /// do allow many values to be passed using multiple header lines. + /// We should add content to $GLOBALS['_xh']['headers'][$header_name] + /// instead of replacing it for those... + if ($header_name == 'set-cookie' || $header_name == 'set-cookie2') + { + if ($header_name == 'set-cookie2') + { + // version 2 cookies: + // there could be many cookies on one line, comma separated + $cookies = explode(',', $arr[1]); + } + else + { + $cookies = array($arr[1]); + } + foreach ($cookies as $cookie) + { + // glue together all received cookies, using a comma to separate them + // (same as php does with getallheaders()) + if (isset($GLOBALS['_xh']['headers'][$header_name])) + $GLOBALS['_xh']['headers'][$header_name] .= ', ' . trim($cookie); + else + $GLOBALS['_xh']['headers'][$header_name] = trim($cookie); + // parse cookie attributes, in case user wants to coorectly honour then + // feature creep: only allow rfc-compliant cookie attributes? + $cookie = explode(';', $cookie); + foreach ($cookie as $pos => $val) + { + $val = explode('=', $val, 2); + $tag = trim($val[0]); + $val = trim(@$val[1]); + /// @todo with version 1 cookies, we should strip leading and trailing " chars + if ($pos == 0) + { + $cookiename = $tag; + $GLOBALS['_xh']['cookies'][$tag] = array(); + $GLOBALS['_xh']['cookies'][$cookiename]['value'] = urldecode($val); + } + else + { + $GLOBALS['_xh']['cookies'][$cookiename][$tag] = $val; + } + } + } + } + else + { + $GLOBALS['_xh']['headers'][$header_name] = trim($arr[1]); + } + } + elseif(isset($header_name)) + { + /// @todo version1 cookies might span multiple lines, thus breaking the parsing above + $GLOBALS['_xh']['headers'][$header_name] .= ' ' . trim($line); + } + } + + $data = substr($data, $bd); + + if($this->debug && count($GLOBALS['_xh']['headers'])) + { + print '
';
+					foreach($GLOBALS['_xh']['headers'] as $header => $value)
+					{
+						print "HEADER: $header: $value\n";
+					}
+					foreach($GLOBALS['_xh']['cookies'] as $header => $value)
+					{
+						print "COOKIE: $header={$value['value']}\n";
+					}
+					print "
\n"; + } + + // if CURL was used for the call, http headers have been processed, + // and dechunking + reinflating have been carried out + if(!$headers_processed) + { + // Decode chunked encoding sent by http 1.1 servers + if(isset($GLOBALS['_xh']['headers']['transfer-encoding']) && $GLOBALS['_xh']['headers']['transfer-encoding'] == 'chunked') + { + if(!$data = decode_chunked($data)) + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to rebuild the chunked data received from server'); + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['dechunk_fail'], $GLOBALS['xmlrpcstr']['dechunk_fail']); + return $r; + } + } + + // Decode gzip-compressed stuff + // code shamelessly inspired from nusoap library by Dietrich Ayala + if(isset($GLOBALS['_xh']['headers']['content-encoding'])) + { + $GLOBALS['_xh']['headers']['content-encoding'] = str_replace('x-', '', $GLOBALS['_xh']['headers']['content-encoding']); + if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' || $GLOBALS['_xh']['headers']['content-encoding'] == 'gzip') + { + // if decoding works, use it. else assume data wasn't gzencoded + if(function_exists('gzinflate')) + { + if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data)) + { + $data = $degzdata; + if($this->debug) + print "
---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---
"; + } + elseif($GLOBALS['_xh']['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) + { + $data = $degzdata; + if($this->debug) + print "
---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---
"; + } + else + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: errors occurred when trying to decode the deflated data received from server'); + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['decompress_fail'], $GLOBALS['xmlrpcstr']['decompress_fail']); + return $r; + } + } + else + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.'); + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['cannot_decompress'], $GLOBALS['xmlrpcstr']['cannot_decompress']); + return $r; + } + } + } + } // end of 'if needed, de-chunk, re-inflate response' + + // real stupid hack to avoid PHP 4 complaining about returning NULL by ref + $r = null; + $r =& $r; + return $r; + } + + /** + * Parse the xmlrpc response containeed in the string $data and return an xmlrpcresp object. + * @param string $data the xmlrpc response, eventually including http headers + * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding + * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals' + * @return xmlrpcresp + * @access public + */ + function &parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals') + { + if($this->debug) + { + //by maHo, replaced htmlspecialchars with htmlentities + print "
---GOT---\n" . htmlentities($data) . "\n---END---\n
"; + $start = strpos($data, '', $start); + $comments = substr($data, $start, $end-$start); + print "
---SERVER DEBUG INFO (DECODED) ---\n\t".htmlentities(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n
"; + } + } + + if($data == '') + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: no response received from server.'); + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_data'], $GLOBALS['xmlrpcstr']['no_data']); + return $r; + } + + $GLOBALS['_xh']=array(); + + $raw_data = $data; + // parse the HTTP headers of the response, if present, and separate them from data + if(substr($data, 0, 4) == 'HTTP') + { + $r =& $this->parseResponseHeaders($data, $headers_processed); + if ($r) + { + // failed processing of HTTP response headers + // save into response obj the full payload received, for debugging + $r->raw_data = $data; + return $r; + } + } + else + { + $GLOBALS['_xh']['headers'] = array(); + $GLOBALS['_xh']['cookies'] = array(); + } + + + // be tolerant of extra whitespace in response body + $data = trim($data); + + /// @todo return an error msg if $data=='' ? + + // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts) + // idea from Luca Mariano originally in PEARified version of the lib + $bd = false; + // Poor man's version of strrpos for php 4... + $pos = strpos($data, ''); + while($pos || is_int($pos)) + { + $bd = $pos+17; + $pos = strpos($data, '', $bd); + } + if($bd) + { + $data = substr($data, 0, $bd); + } + + // if user wants back raw xml, give it to him + if ($return_type == 'xml') + { + $r =& new xmlrpcresp($data, 0, '', 'xml'); + $r->hdrs = $GLOBALS['_xh']['headers']; + $r->_cookies = $GLOBALS['_xh']['cookies']; + $r->raw_data = $raw_data; + return $r; + } + + // try to 'guestimate' the character encoding of the received response + $resp_encoding = guess_encoding(@$GLOBALS['_xh']['headers']['content-type'], $data); + + $GLOBALS['_xh']['ac']=''; + //$GLOBALS['_xh']['qt']=''; //unused... + $GLOBALS['_xh']['stack'] = array(); + $GLOBALS['_xh']['valuestack'] = array(); + $GLOBALS['_xh']['isf']=0; // 0 = OK, 1 for xmlrpc fault responses, 2 = invalid xmlrpc + $GLOBALS['_xh']['isf_reason']=''; + $GLOBALS['_xh']['rt']=''; // 'methodcall or 'methodresponse' + + // if response charset encoding is not known / supported, try to use + // the default encoding and parse the xml anyway, but log a warning... + if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) + // the following code might be better for mb_string enabled installs, but + // makes the lib about 200% slower... + //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) + { + error_log('XML-RPC: xmlrpcmsg::parseResponse: invalid charset encoding of received response: '.$resp_encoding); + $resp_encoding = $GLOBALS['xmlrpc_defencoding']; + } + $parser = xml_parser_create($resp_encoding); + xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true); + // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell + // the xml parser to give us back data in the expected charset + xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']); + + if ($return_type == 'phpvals') + { + xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast'); + } + else + { + xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee'); + } + + xml_set_character_data_handler($parser, 'xmlrpc_cd'); + xml_set_default_handler($parser, 'xmlrpc_dh'); + + // first error check: xml not well formed + if(!xml_parse($parser, $data, count($data))) + { + // thanks to Peter Kocks + if((xml_get_current_line_number($parser)) == 1) + { + $errstr = 'XML error at line 1, check URL'; + } + else + { + $errstr = sprintf('XML error: %s at line %d, column %d', + xml_error_string(xml_get_error_code($parser)), + xml_get_current_line_number($parser), xml_get_current_column_number($parser)); + } + error_log($errstr); + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return'].' ('.$errstr.')'); + xml_parser_free($parser); + if($this->debug) + { + print $errstr; + } + $r->hdrs = $GLOBALS['_xh']['headers']; + $r->_cookies = $GLOBALS['_xh']['cookies']; + $r->raw_data = $raw_data; + return $r; + } + xml_parser_free($parser); + // second error check: xml well formed but not xml-rpc compliant + if ($GLOBALS['_xh']['isf'] > 1) + { + if ($this->debug) + { + /// @todo echo something for user? + } + + $r =& new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], + $GLOBALS['xmlrpcstr']['invalid_return'] . ' ' . $GLOBALS['_xh']['isf_reason']); + } + // third error check: parsing of the response has somehow gone boink. + // NB: shall we omit this check, since we trust the parsing code? + elseif ($return_type == 'xmlrpcvals' && !is_object($GLOBALS['_xh']['value'])) + { + // something odd has happened + // and it's time to generate a client side error + // indicating something odd went on + $r=&new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], + $GLOBALS['xmlrpcstr']['invalid_return']); + } + else + { + if ($this->debug) + { + print "
---PARSED---\n" ;
+					var_export($GLOBALS['_xh']['value']);
+					print "\n---END---
"; + } + + // note that using =& will raise an error if $GLOBALS['_xh']['st'] does not generate an object. + $v =& $GLOBALS['_xh']['value']; + + if($GLOBALS['_xh']['isf']) + { + /// @todo we should test here if server sent an int and a string, + /// and/or coerce them into such... + if ($return_type == 'xmlrpcvals') + { + $errno_v = $v->structmem('faultCode'); + $errstr_v = $v->structmem('faultString'); + $errno = $errno_v->scalarval(); + $errstr = $errstr_v->scalarval(); + } + else + { + $errno = $v['faultCode']; + $errstr = $v['faultString']; + } + + if($errno == 0) + { + // FAULT returned, errno needs to reflect that + $errno = -1; + } + + $r =& new xmlrpcresp(0, $errno, $errstr); + } + else + { + $r=&new xmlrpcresp($v, 0, '', $return_type); + } + } + + $r->hdrs = $GLOBALS['_xh']['headers']; + $r->_cookies = $GLOBALS['_xh']['cookies']; + $r->raw_data = $raw_data; + return $r; + } + } + + class xmlrpcval + { + var $me=array(); + var $mytype=0; + var $_php_class=null; + + /** + * @param mixed $val + * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed + */ + function xmlrpcval($val=-1, $type='') + { + /// @todo: optimization creep - do not call addXX, do it all inline. + /// downside: booleans will not be coerced anymore + if($val!==-1 || $type!='') + { + // optimization creep: inlined all work done by constructor + switch($type) + { + case '': + $this->mytype=1; + $this->me['string']=$val; + break; + case 'i4': + case 'int': + case 'double': + case 'string': + case 'boolean': + case 'dateTime.iso8601': + case 'base64': + case 'null': + $this->mytype=1; + $this->me[$type]=$val; + break; + case 'array': + $this->mytype=2; + $this->me['array']=$val; + break; + case 'struct': + $this->mytype=3; + $this->me['struct']=$val; + break; + default: + error_log("XML-RPC: xmlrpcval::xmlrpcval: not a known type ($type)"); + } + /*if($type=='') + { + $type='string'; + } + if($GLOBALS['xmlrpcTypes'][$type]==1) + { + $this->addScalar($val,$type); + } + elseif($GLOBALS['xmlrpcTypes'][$type]==2) + { + $this->addArray($val); + } + elseif($GLOBALS['xmlrpcTypes'][$type]==3) + { + $this->addStruct($val); + }*/ + } + } + + /** + * Add a single php value to an (unitialized) xmlrpcval + * @param mixed $val + * @param string $type + * @return int 1 or 0 on failure + */ + function addScalar($val, $type='string') + { + $typeof=@$GLOBALS['xmlrpcTypes'][$type]; + if($typeof!=1) + { + error_log("XML-RPC: xmlrpcval::addScalar: not a scalar type ($type)"); + return 0; + } + + // coerce booleans into correct values + // NB: we should iether do it for datetimes, integers and doubles, too, + // or just plain remove this check, implemnted on booleans only... + if($type==$GLOBALS['xmlrpcBoolean']) + { + if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false'))) + { + $val=true; + } + else + { + $val=false; + } + } + + switch($this->mytype) + { + case 1: + error_log('XML-RPC: xmlrpcval::addScalar: scalar xmlrpcval can have only one value'); + return 0; + case 3: + error_log('XML-RPC: xmlrpcval::addScalar: cannot add anonymous scalar to struct xmlrpcval'); + return 0; + case 2: + // we're adding a scalar value to an array here + //$ar=$this->me['array']; + //$ar[]=&new xmlrpcval($val, $type); + //$this->me['array']=$ar; + // Faster (?) avoid all the costly array-copy-by-val done here... + $this->me['array'][]=&new xmlrpcval($val, $type); + return 1; + default: + // a scalar, so set the value and remember we're scalar + $this->me[$type]=$val; + $this->mytype=$typeof; + return 1; + } + } + + /** + * Add an array of xmlrpcval objects to an xmlrpcval + * @param array $vals + * @return int 1 or 0 on failure + * @access public + * + * @todo add some checking for $vals to be an array of xmlrpcvals? + */ + function addArray($vals) + { + if($this->mytype==0) + { + $this->mytype=$GLOBALS['xmlrpcTypes']['array']; + $this->me['array']=$vals; + return 1; + } + elseif($this->mytype==2) + { + // we're adding to an array here + $this->me['array'] = array_merge($this->me['array'], $vals); + return 1; + } + else + { + error_log('XML-RPC: xmlrpcval::addArray: already initialized as a [' . $this->kindOf() . ']'); + return 0; + } + } + + /** + * Add an array of named xmlrpcval objects to an xmlrpcval + * @param array $vals + * @return int 1 or 0 on failure + * @access public + * + * @todo add some checking for $vals to be an array? + */ + function addStruct($vals) + { + if($this->mytype==0) + { + $this->mytype=$GLOBALS['xmlrpcTypes']['struct']; + $this->me['struct']=$vals; + return 1; + } + elseif($this->mytype==3) + { + // we're adding to a struct here + $this->me['struct'] = array_merge($this->me['struct'], $vals); + return 1; + } + else + { + error_log('XML-RPC: xmlrpcval::addStruct: already initialized as a [' . $this->kindOf() . ']'); + return 0; + } + } + + // poor man's version of print_r ??? + // DEPRECATED! + function dump($ar) + { + foreach($ar as $key => $val) + { + echo "$key => $val
"; + if($key == 'array') + { + while(list($key2, $val2) = each($val)) + { + echo "-- $key2 => $val2
"; + } + } + } + } + + /** + * Returns a string containing "struct", "array" or "scalar" describing the base type of the value + * @return string + * @access public + */ + function kindOf() + { + switch($this->mytype) + { + case 3: + return 'struct'; + break; + case 2: + return 'array'; + break; + case 1: + return 'scalar'; + break; + default: + return 'undef'; + } + } + + /** + * @access private + */ + function serializedata($typ, $val, $charset_encoding='') + { + $rs=''; + switch(@$GLOBALS['xmlrpcTypes'][$typ]) + { + case 1: + switch($typ) + { + case $GLOBALS['xmlrpcBase64']: + $rs.="<${typ}>" . base64_encode($val) . ""; + break; + case $GLOBALS['xmlrpcBoolean']: + $rs.="<${typ}>" . ($val ? '1' : '0') . ""; + break; + case $GLOBALS['xmlrpcString']: + // G. Giunta 2005/2/13: do NOT use htmlentities, since + // it will produce named html entities, which are invalid xml + $rs.="<${typ}>" . xmlrpc_encode_entitites($val, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding). ""; + break; + case $GLOBALS['xmlrpcInt']: + case $GLOBALS['xmlrpcI4']: + $rs.="<${typ}>".(int)$val.""; + break; + case $GLOBALS['xmlrpcDouble']: + $rs.="<${typ}>".(double)$val.""; + break; + case $GLOBALS['xmlrpcNull']: + $rs.=""; + break; + default: + // no standard type value should arrive here, but provide a possibility + // for xmlrpcvals of unknown type... + $rs.="<${typ}>${val}"; + } + break; + case 3: + // struct + if ($this->_php_class) + { + $rs.='\n"; + } + else + { + $rs.="\n"; + } + foreach($val as $key2 => $val2) + { + $rs.=''.xmlrpc_encode_entitites($key2, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding)."\n"; + //$rs.=$this->serializeval($val2); + $rs.=$val2->serialize($charset_encoding); + $rs.="\n"; + } + $rs.=''; + break; + case 2: + // array + $rs.="\n\n"; + for($i=0; $iserializeval($val[$i]); + $rs.=$val[$i]->serialize($charset_encoding); + } + $rs.="\n"; + break; + default: + break; + } + return $rs; + } + + /** + * Returns xml representation of the value. XML prologue not included + * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed + * @return string + * @access public + */ + function serialize($charset_encoding='') + { + // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals... + //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval'))) + //{ + reset($this->me); + list($typ, $val) = each($this->me); + return '' . $this->serializedata($typ, $val, $charset_encoding) . "\n"; + //} + } + + // DEPRECATED + function serializeval($o) + { + // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals... + //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval'))) + //{ + $ar=$o->me; + reset($ar); + list($typ, $val) = each($ar); + return '' . $this->serializedata($typ, $val) . "\n"; + //} + } + + /** + * Checks wheter a struct member with a given name is present. + * Works only on xmlrpcvals of type struct. + * @param string $m the name of the struct member to be looked up + * @return boolean + * @access public + */ + function structmemexists($m) + { + return array_key_exists($m, $this->me['struct']); + } + + /** + * Returns the value of a given struct member (an xmlrpcval object in itself). + * Will raise a php warning if struct member of given name does not exist + * @param string $m the name of the struct member to be looked up + * @return xmlrpcval + * @access public + */ + function structmem($m) + { + return $this->me['struct'][$m]; + } + + /** + * Reset internal pointer for xmlrpcvals of type struct. + * @access public + */ + function structreset() + { + reset($this->me['struct']); + } + + /** + * Return next member element for xmlrpcvals of type struct. + * @return xmlrpcval + * @access public + */ + function structeach() + { + return each($this->me['struct']); + } + + // DEPRECATED! this code looks like it is very fragile and has not been fixed + // for a long long time. Shall we remove it for 2.0? + function getval() + { + // UNSTABLE + reset($this->me); + list($a,$b)=each($this->me); + // contributed by I Sofer, 2001-03-24 + // add support for nested arrays to scalarval + // i've created a new method here, so as to + // preserve back compatibility + + if(is_array($b)) + { + @reset($b); + while(list($id,$cont) = @each($b)) + { + $b[$id] = $cont->scalarval(); + } + } + + // add support for structures directly encoding php objects + if(is_object($b)) + { + $t = get_object_vars($b); + @reset($t); + while(list($id,$cont) = @each($t)) + { + $t[$id] = $cont->scalarval(); + } + @reset($t); + while(list($id,$cont) = @each($t)) + { + @$b->$id = $cont; + } + } + // end contrib + return $b; + } + + /** + * Returns the value of a scalar xmlrpcval + * @return mixed + * @access public + */ + function scalarval() + { + reset($this->me); + list(,$b)=each($this->me); + return $b; + } + + /** + * Returns the type of the xmlrpcval. + * For integers, 'int' is always returned in place of 'i4' + * @return string + * @access public + */ + function scalartyp() + { + reset($this->me); + list($a,)=each($this->me); + if($a==$GLOBALS['xmlrpcI4']) + { + $a=$GLOBALS['xmlrpcInt']; + } + return $a; + } + + /** + * Returns the m-th member of an xmlrpcval of struct type + * @param integer $m the index of the value to be retrieved (zero based) + * @return xmlrpcval + * @access public + */ + function arraymem($m) + { + return $this->me['array'][$m]; + } + + /** + * Returns the number of members in an xmlrpcval of array type + * @return integer + * @access public + */ + function arraysize() + { + return count($this->me['array']); + } + + /** + * Returns the number of members in an xmlrpcval of struct type + * @return integer + * @access public + */ + function structsize() + { + return count($this->me['struct']); + } + } + + + // date helpers + + /** + * Given a timestamp, return the corresponding ISO8601 encoded string. + * + * Really, timezones ought to be supported + * but the XML-RPC spec says: + * + * "Don't assume a timezone. It should be specified by the server in its + * documentation what assumptions it makes about timezones." + * + * These routines always assume localtime unless + * $utc is set to 1, in which case UTC is assumed + * and an adjustment for locale is made when encoding + * + * @param int $timet (timestamp) + * @param int $utc (0 or 1) + * @return string + */ + function iso8601_encode($timet, $utc=0) + { + if(!$utc) + { + $t=strftime("%Y%m%dT%H:%M:%S", $timet); + } + else + { + if(function_exists('gmstrftime')) + { + // gmstrftime doesn't exist in some versions + // of PHP + $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet); + } + else + { + $t=strftime("%Y%m%dT%H:%M:%S", $timet-date('Z')); + } + } + return $t; + } + + /** + * Given an ISO8601 date string, return a timet in the localtime, or UTC + * @param string $idate + * @param int $utc either 0 or 1 + * @return int (datetime) + */ + function iso8601_decode($idate, $utc=0) + { + $t=0; + if(preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})/', $idate, $regs)) + { + if($utc) + { + $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]); + } + else + { + $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]); + } + } + return $t; + } + + /** + * Takes an xmlrpc value in PHP xmlrpcval object format and translates it into native PHP types. + * + * Works with xmlrpc message objects as input, too. + * + * Given proper options parameter, can rebuild generic php object instances + * (provided those have been encoded to xmlrpc format using a corresponding + * option in php_xmlrpc_encode()) + * PLEASE NOTE that rebuilding php objects involves calling their constructor function. + * This means that the remote communication end can decide which php code will + * get executed on your server, leaving the door possibly open to 'php-injection' + * style of attacks (provided you have some classes defined on your server that + * might wreak havoc if instances are built outside an appropriate context). + * Make sure you trust the remote server/client before eanbling this! + * + * @author Dan Libby (dan@libby.com) + * + * @param xmlrpcval $xmlrpc_val + * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects + * @return mixed + */ + function php_xmlrpc_decode($xmlrpc_val, $options=array()) + { + switch($xmlrpc_val->kindOf()) + { + case 'scalar': + if (in_array('extension_api', $options)) + { + reset($xmlrpc_val->me); + list($typ,$val) = each($xmlrpc_val->me); + switch ($typ) + { + case 'dateTime.iso8601': + $xmlrpc_val->scalar = $val; + $xmlrpc_val->xmlrpc_type = 'datetime'; + $xmlrpc_val->timestamp = iso8601_decode($val); + return $xmlrpc_val; + case 'base64': + $xmlrpc_val->scalar = $val; + $xmlrpc_val->type = $typ; + return $xmlrpc_val; + default: + return $xmlrpc_val->scalarval(); + } + } + return $xmlrpc_val->scalarval(); + case 'array': + $size = $xmlrpc_val->arraysize(); + $arr = array(); + for($i = 0; $i < $size; $i++) + { + $arr[] = php_xmlrpc_decode($xmlrpc_val->arraymem($i), $options); + } + return $arr; + case 'struct': + $xmlrpc_val->structreset(); + // If user said so, try to rebuild php objects for specific struct vals. + /// @todo should we raise a warning for class not found? + // shall we check for proper subclass of xmlrpcval instead of + // presence of _php_class to detect what we can do? + if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != '' + && class_exists($xmlrpc_val->_php_class)) + { + $obj = @new $xmlrpc_val->_php_class; + while(list($key,$value)=$xmlrpc_val->structeach()) + { + $obj->$key = php_xmlrpc_decode($value, $options); + } + return $obj; + } + else + { + $arr = array(); + while(list($key,$value)=$xmlrpc_val->structeach()) + { + $arr[$key] = php_xmlrpc_decode($value, $options); + } + return $arr; + } + case 'msg': + $paramcount = $xmlrpc_val->getNumParams(); + $arr = array(); + for($i = 0; $i < $paramcount; $i++) + { + $arr[] = php_xmlrpc_decode($xmlrpc_val->getParam($i)); + } + return $arr; + } + } + + // This constant left here only for historical reasons... + // it was used to decide if we have to define xmlrpc_encode on our own, but + // we do not do it anymore + if(function_exists('xmlrpc_decode')) + { + define('XMLRPC_EPI_ENABLED','1'); + } + else + { + define('XMLRPC_EPI_ENABLED','0'); + } + + /** + * Takes native php types and encodes them into xmlrpc PHP object format. + * It will not re-encode xmlrpcval objects. + * + * Feature creep -- could support more types via optional type argument + * (string => datetime support has been added, ??? => base64 not yet) + * + * If given a proper options parameter, php object instances will be encoded + * into 'special' xmlrpc values, that can later be decoded into php objects + * by calling php_xmlrpc_decode() with a corresponding option + * + * @author Dan Libby (dan@libby.com) + * + * @param mixed $php_val the value to be converted into an xmlrpcval object + * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api' + * @return xmlrpcval + */ + function &php_xmlrpc_encode($php_val, $options=array()) + { + $type = gettype($php_val); + switch($type) + { + case 'string': + if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val)) + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcDateTime']); + else + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcString']); + break; + case 'integer': + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcInt']); + break; + case 'double': + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcDouble']); + break; + // + // Add support for encoding/decoding of booleans, since they are supported in PHP + case 'boolean': + $xmlrpc_val =& new xmlrpcval($php_val, $GLOBALS['xmlrpcBoolean']); + break; + // + case 'array': + // PHP arrays can be encoded to either xmlrpc structs or arrays, + // depending on wheter they are hashes or plain 0..n integer indexed + // A shorter one-liner would be + // $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1)); + // but execution time skyrockets! + $j = 0; + $arr = array(); + $ko = false; + foreach($php_val as $key => $val) + { + $arr[$key] =& php_xmlrpc_encode($val, $options); + if(!$ko && $key !== $j) + { + $ko = true; + } + $j++; + } + if($ko) + { + $xmlrpc_val =& new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']); + } + else + { + $xmlrpc_val =& new xmlrpcval($arr, $GLOBALS['xmlrpcArray']); + } + break; + case 'object': + if(is_a($php_val, 'xmlrpcval')) + { + $xmlrpc_val = $php_val; + } + else + { + $arr = array(); + while(list($k,$v) = each($php_val)) + { + $arr[$k] = php_xmlrpc_encode($v, $options); + } + $xmlrpc_val =& new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']); + if (in_array('encode_php_objs', $options)) + { + // let's save original class name into xmlrpcval: + // might be useful later on... + $xmlrpc_val->_php_class = get_class($php_val); + } + } + break; + case 'NULL': + if (in_array('extension_api', $options)) + { + $xmlrpc_val =& new xmlrpcval('', $GLOBALS['xmlrpcString']); + } + if (in_array('null_extension', $options)) + { + $xmlrpc_val =& new xmlrpcval('', $GLOBALS['xmlrpcNull']); + } + else + { + $xmlrpc_val =& new xmlrpcval(); + } + break; + case 'resource': + if (in_array('extension_api', $options)) + { + $xmlrpc_val =& new xmlrpcval((int)$php_val, $GLOBALS['xmlrpcInt']); + } + else + { + $xmlrpc_val =& new xmlrpcval(); + } + // catch "user function", "unknown type" + default: + // giancarlo pinerolo + // it has to return + // an empty object in case, not a boolean. + $xmlrpc_val =& new xmlrpcval(); + break; + } + return $xmlrpc_val; + } + + /** + * Convert the xml representation of a method call, method request or single + * xmlrpc value into the appropriate object (a.k.a. deserialize) + * @param string $xml_val + * @param array $options + * @return mixed false on error, or an instance of either xmlrpcval, xmlrpcmsg or xmlrpcresp + */ + function php_xmlrpc_decode_xml($xml_val, $options=array()) + { + $GLOBALS['_xh'] = array(); + $GLOBALS['_xh']['ac'] = ''; + $GLOBALS['_xh']['stack'] = array(); + $GLOBALS['_xh']['valuestack'] = array(); + $GLOBALS['_xh']['params'] = array(); + $GLOBALS['_xh']['pt'] = array(); + $GLOBALS['_xh']['isf'] = 0; + $GLOBALS['_xh']['isf_reason'] = ''; + $GLOBALS['_xh']['method'] = false; + $GLOBALS['_xh']['rt'] = ''; + /// @todo 'guestimate' encoding + $parser = xml_parser_create(); + xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true); + xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']); + xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee'); + xml_set_character_data_handler($parser, 'xmlrpc_cd'); + xml_set_default_handler($parser, 'xmlrpc_dh'); + if(!xml_parse($parser, $xml_val, 1)) + { + $errstr = sprintf('XML error: %s at line %d, column %d', + xml_error_string(xml_get_error_code($parser)), + xml_get_current_line_number($parser), xml_get_current_column_number($parser)); + error_log($errstr); + xml_parser_free($parser); + return false; + } + xml_parser_free($parser); + if ($GLOBALS['_xh']['isf'] > 1) // test that $GLOBALS['_xh']['value'] is an obj, too??? + { + error_log($GLOBALS['_xh']['isf_reason']); + return false; + } + switch ($GLOBALS['_xh']['rt']) + { + case 'methodresponse': + $v =& $GLOBALS['_xh']['value']; + if ($GLOBALS['_xh']['isf'] == 1) + { + $vc = $v->structmem('faultCode'); + $vs = $v->structmem('faultString'); + $r =& new xmlrpcresp(0, $vc->scalarval(), $vs->scalarval()); + } + else + { + $r =& new xmlrpcresp($v); + } + return $r; + case 'methodcall': + $m =& new xmlrpcmsg($GLOBALS['_xh']['method']); + for($i=0; $i < count($GLOBALS['_xh']['params']); $i++) + { + $m->addParam($GLOBALS['_xh']['params'][$i]); + } + return $m; + case 'value': + return $GLOBALS['_xh']['value']; + default: + return false; + } + } + + /** + * decode a string that is encoded w/ "chunked" transfer encoding + * as defined in rfc2068 par. 19.4.6 + * code shamelessly stolen from nusoap library by Dietrich Ayala + * + * @param string $buffer the string to be decoded + * @return string + */ + function decode_chunked($buffer) + { + // length := 0 + $length = 0; + $new = ''; + + // read chunk-size, chunk-extension (if any) and crlf + // get the position of the linebreak + $chunkend = strpos($buffer,"\r\n") + 2; + $temp = substr($buffer,0,$chunkend); + $chunk_size = hexdec( trim($temp) ); + $chunkstart = $chunkend; + while($chunk_size > 0) + { + $chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size); + + // just in case we got a broken connection + if($chunkend == false) + { + $chunk = substr($buffer,$chunkstart); + // append chunk-data to entity-body + $new .= $chunk; + $length += strlen($chunk); + break; + } + + // read chunk-data and crlf + $chunk = substr($buffer,$chunkstart,$chunkend-$chunkstart); + // append chunk-data to entity-body + $new .= $chunk; + // length := length + chunk-size + $length += strlen($chunk); + // read chunk-size and crlf + $chunkstart = $chunkend + 2; + + $chunkend = strpos($buffer,"\r\n",$chunkstart)+2; + if($chunkend == false) + { + break; //just in case we got a broken connection + } + $temp = substr($buffer,$chunkstart,$chunkend-$chunkstart); + $chunk_size = hexdec( trim($temp) ); + $chunkstart = $chunkend; + } + return $new; + } + + /** + * xml charset encoding guessing helper function. + * Tries to determine the charset encoding of an XML chunk + * received over HTTP. + * NB: according to the spec (RFC 3023, if text/xml content-type is received over HTTP without a content-type, + * we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers, + * which will be most probably using UTF-8 anyway... + * + * @param string $httpheaders the http Content-type header + * @param string $xmlchunk xml content buffer + * @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled) + * + * @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!! + */ + function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null) + { + // discussion: see http://www.yale.edu/pclt/encoding/ + // 1 - test if encoding is specified in HTTP HEADERS + + //Details: + // LWS: (\13\10)?( |\t)+ + // token: (any char but excluded stuff)+ + // header: Content-type = ...; charset=value(; ...)* + // where value is of type token, no LWS allowed between 'charset' and value + // Note: we do not check for invalid chars in VALUE: + // this had better be done using pure ereg as below + + /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it? + $matches = array(); + if(preg_match('/;\s*charset=([^;]+)/i', $httpheader, $matches)) + { + return strtoupper(trim($matches[1])); + } + + // 2 - scan the first bytes of the data for a UTF-16 (or other) BOM pattern + // (source: http://www.w3.org/TR/2000/REC-xml-20001006) + // NOTE: actually, according to the spec, even if we find the BOM and determine + // an encoding, we should check if there is an encoding specified + // in the xml declaration, and verify if they match. + /// @todo implement check as described above? + /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM) + if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk)) + { + return 'UCS-4'; + } + elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk)) + { + return 'UTF-16'; + } + elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk)) + { + return 'UTF-8'; + } + + // 3 - test if encoding is specified in the xml declaration + // Details: + // SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+ + // EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]* + if (preg_match('/^<\?xml\s+version\s*=\s*'. "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))". + '\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/", + $xmlchunk, $matches)) + { + return strtoupper(substr($matches[2], 1, -1)); + } + + // 4 - if mbstring is available, let it do the guesswork + // NB: we favour finding an encoding that is compatible with what we can process + if(extension_loaded('mbstring')) + { + if($encoding_prefs) + { + $enc = mb_detect_encoding($xmlchunk, $encoding_prefs); + } + else + { + $enc = mb_detect_encoding($xmlchunk); + } + // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII... + // IANA also likes better US-ASCII, so go with it + if($enc == 'ASCII') + { + $enc = 'US-'.$enc; + } + return $enc; + } + else + { + // no encoding specified: as per HTTP1.1 assume it is iso-8859-1? + // Both RFC 2616 (HTTP 1.1) and 1945(http 1.0) clearly state that for text/xxx content types + // this should be the standard. And we should be getting text/xml as request and response. + // BUT we have to be backward compatible with the lib, which always used UTF-8 as default... + return $GLOBALS['xmlrpc_defencoding']; + } + } + + /** + * Checks if a given charset encoding is present in a list of encodings or + * if it is a valid subset of any encoding in the list + * @param string $encoding charset to be tested + * @param mixed $validlist comma separated list of valid charsets (or array of charsets) + */ + function is_valid_charset($encoding, $validlist) + { + $charset_supersets = array( + 'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4', + 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8', + 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12', + 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8', + 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN') + ); + if (is_string($validlist)) + $validlist = explode(',', $validlist); + if (@in_array(strtoupper($encoding), $validlist)) + return true; + else + { + if (array_key_exists($encoding, $charset_supersets)) + foreach ($validlist as $allowed) + if (in_array($allowed, $charset_supersets[$encoding])) + return true; + return false; + } + } + +?> \ No newline at end of file diff --git a/mozilla/webtools/testopia/testopia/dojo/DOJO_INSTALL_HELP b/mozilla/webtools/testopia/testopia/dojo/DOJO_INSTALL_HELP deleted file mode 100644 index ffa12ea48da..00000000000 --- a/mozilla/webtools/testopia/testopia/dojo/DOJO_INSTALL_HELP +++ /dev/null @@ -1,12 +0,0 @@ -This is where the Dojo libraries go. -You can get Dojo from http://dojotoolkit.org/ - -You can either intall one of the releases (such as the -kitchen-sink or widget release) or you can check it out from Subversion. - -$> cd /path/to/bugzilla/testopia -$> svn co http://svn.dojotoolkit.org/dojo/trunk/ dojo/ - -When you are done installing you should see the src folder and -the dojo.js file in this directory. Make sure they are readable -by the we server. diff --git a/mozilla/webtools/testopia/testopia/img/new.png b/mozilla/webtools/testopia/testopia/img/new.png new file mode 100644 index 0000000000000000000000000000000000000000..faa332ebdcfedf765345baa5849608a2500c8a6a GIT binary patch literal 593 zcmV-X0aq1rsvIQ&! zr$#{(f)S#iB}H6<2uUpVm6|^Bb||*-BYMVr?mhP&4p(uz-ENo5wE-xM!8A>)X?CC3 zY>rC+!!W*^=GQm1+HFWgegKe2B+dteflPy87!rv*lfAvLluAX}-VVzCzWXQO5D`QK z-Q)2%s?{p_e17}@0G5^>5s#mfPDe;4A98qT(ExqO>i~YgAHUx}F>IP9$>e8L^^&zU z8vwze&9b%iG_$_`xOQ=In^vc;1u~f<4h}-Z7BsI8P%f9r zX0s!WXJ?;ST)g46$*XJo}3sPB66(*1Ofp9fxy@e?*Yi=a+FGMSy{2s zZ2rdUeSpVfy%LdYfO{@nc0%6pM(MGgBC%-%p_Hf0NTRZBVcGJ`B0J7Jz@lQ@ME-?utaC(dh#7 zEX))J=yW=?+wGZ+s;c7i`6dNKgl@M>v)P;}plKRDpAQj{5rJZ{SO8ur%EUKMAeBn} fYBU;O?$-VQK|9t1qPWu`00000NkvXXu0mjf_d)>% literal 0 HcmV?d00001 diff --git a/mozilla/webtools/testopia/testopia/img/new.svg b/mozilla/webtools/testopia/testopia/img/new.svg new file mode 100644 index 00000000000..6f8fbd0def2 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/img/new.svg @@ -0,0 +1,131 @@ + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + diff --git a/mozilla/webtools/testopia/testopia/patch-3.0 b/mozilla/webtools/testopia/testopia/patch-3.0 index be9b15d1c0b..baa8af45ddd 100644 --- a/mozilla/webtools/testopia/testopia/patch-3.0 +++ b/mozilla/webtools/testopia/testopia/patch-3.0 @@ -14,58 +14,6 @@ diff -u -r1.141 editusers.cgi 'fielddefs READ', 'tokens WRITE', 'logincookies WRITE', -Index: enter_bug.cgi -=================================================================== -RCS file: /cvsroot/mozilla/webtools/bugzilla/enter_bug.cgi,v -retrieving revision 1.154 -diff -u -r1.154 enter_bug.cgi ---- enter_bug.cgi 14 Jan 2007 01:42:40 -0000 1.154 -+++ enter_bug.cgi 15 Jun 2007 22:57:19 -0000 -@@ -572,6 +572,8 @@ - - $vars->{'default'} = \%default; - -+$vars->{'caserun_id'} = $cgi->param('caserun_id'); -+ - my $format = $template->get_format("bug/create/create", - scalar $cgi->param('format'), - scalar $cgi->param('ctype')); -Index: Bugzilla/DB/Schema/Pg.pm -=================================================================== -RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/DB/Schema/Pg.pm,v -retrieving revision 1.13.2.1 -diff -u -r1.13.2.1 Pg.pm ---- Bugzilla/DB/Schema/Pg.pm 15 Apr 2007 01:34:58 -0000 1.13.2.1 -+++ Bugzilla/DB/Schema/Pg.pm 15 Jun 2007 22:57:20 -0000 -@@ -69,6 +69,7 @@ - INT3 => 'integer', - INT4 => 'integer', - -+ TINYSERIAL => 'serial unique', - SMALLSERIAL => 'serial unique', - MEDIUMSERIAL => 'serial unique', - INTSERIAL => 'serial unique', -Index: Bugzilla/DB/Schema/Mysql.pm -=================================================================== -RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/DB/Schema/Mysql.pm,v -retrieving revision 1.14 -diff -u -r1.14 Mysql.pm ---- Bugzilla/DB/Schema/Mysql.pm 18 Nov 2006 15:10:11 -0000 1.14 -+++ Bugzilla/DB/Schema/Mysql.pm 15 Jun 2007 22:57:20 -0000 -@@ -103,9 +103,10 @@ - INT3 => 'mediumint', - INT4 => 'integer', - -- SMALLSERIAL => 'smallint auto_increment', -- MEDIUMSERIAL => 'mediumint auto_increment', -- INTSERIAL => 'integer auto_increment', -+ TINYSERIAL => 'tinyint unsigned auto_increment', -+ SMALLSERIAL => 'smallint unsigned auto_increment', -+ MEDIUMSERIAL => 'mediumint unsigned auto_increment', -+ INTSERIAL => 'integer unsigned auto_increment', - - TINYTEXT => 'tinytext', - MEDIUMTEXT => 'mediumtext', Index: Bugzilla/WebService.pm =================================================================== RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/WebService.pm,v diff --git a/mozilla/webtools/testopia/testopia/patch-3.0.x b/mozilla/webtools/testopia/testopia/patch-3.0.x new file mode 100644 index 00000000000..29ca7012264 --- /dev/null +++ b/mozilla/webtools/testopia/testopia/patch-3.0.x @@ -0,0 +1,414 @@ +### Eclipse Workspace Patch 1.0 +#P bmo-3.0.3-testopia-mysql +Index: Bugzilla/User.pm +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/User.pm,v +retrieving revision 1.148.2.6 +diff -u -r1.148.2.6 User.pm +--- Bugzilla/User.pm 28 Nov 2007 19:33:34 -0000 1.148.2.6 ++++ Bugzilla/User.pm 29 Feb 2008 23:19:44 -0000 +@@ -330,6 +330,16 @@ + return $self->{queries_available}; + } + ++sub testopia_queries { ++ my $self = shift; ++ my $dbh = Bugzilla->dbh; ++ my $ref = $dbh->selectall_arrayref( ++ "SELECT name, query FROM test_named_queries ++ WHERE userid = ? AND isvisible = 1", ++ {'Slice' =>{}}, $self->id); ++ return $ref; ++} ++ + sub settings { + my ($self) = @_; + +@@ -627,7 +637,7 @@ + my $class_restricted = Bugzilla->params->{'useclassification'} && $class_id; + + if (!defined $self->{selectable_products}) { +- my $query = "SELECT id " . ++ my $query = "(SELECT id, name AS pname " . + " FROM products " . + "LEFT JOIN group_control_map " . + " ON group_control_map.product_id = products.id "; +@@ -637,10 +647,17 @@ + $query .= " AND group_control_map.membercontrol = " . CONTROLMAPMANDATORY; + } + $query .= " AND group_id NOT IN(" . $self->groups_as_string . ") " . +- " WHERE group_id IS NULL " . +- "ORDER BY name"; ++ " WHERE group_id IS NULL) " ; ++ + +- my $prod_ids = Bugzilla->dbh->selectcol_arrayref($query); ++ $query .= "UNION (SELECT id, tr_products.name AS pname FROM products AS tr_products ". ++ "INNER JOIN test_plans ON tr_products.id = test_plans.product_id ". ++ "INNER JOIN test_plan_permissions ON test_plan_permissions.plan_id = test_plans.plan_id ". ++ "WHERE test_plan_permissions.userid = ?)"; ++ ++ $query .= "ORDER BY pname "; ++ ++ my $prod_ids = Bugzilla->dbh->selectcol_arrayref($query,undef,$self->id); + $self->{selectable_products} = Bugzilla::Product->new_from_list($prod_ids); + } + +@@ -903,6 +920,33 @@ + $group_delete->execute($id, $group, GRANT_REGEXP) if $present; + } + } ++ # Now do the same for Testopia test plans. ++ $sth = $dbh->prepare("SELECT test_plan_permissions_regexp.plan_id, ++ user_regexp, test_plan_permissions_regexp.permissions, ++ test_plan_permissions.plan_id ++ FROM test_plan_permissions_regexp ++ LEFT JOIN test_plan_permissions ++ ON test_plan_permissions_regexp.plan_id = test_plan_permissions.plan_id ++ AND test_plan_permissions.userid = ? ++ AND test_plan_permissions.grant_type = ?"); ++ ++ $sth->execute($id, GRANT_REGEXP); ++ my $plan_insert = $dbh->prepare(q{INSERT INTO test_plan_permissions ++ (userid, plan_id, permissions, grant_type) ++ VALUES (?, ?, ?, ?)}); ++ my $plan_delete = $dbh->prepare(q{DELETE FROM test_plan_permissions ++ WHERE userid = ? ++ AND plan_id = ? ++ AND grant_type = ?}); ++ ++ while (my ($planid, $regexp, $perms, $present) = $sth->fetchrow_array()) { ++ if (($regexp ne '') && ($self->{login} =~ m/$regexp/i)) { ++ $plan_insert->execute($id, $planid, $perms, GRANT_REGEXP) unless $present; ++ } else { ++ $plan_delete->execute($id, $planid, GRANT_REGEXP) if $present; ++ } ++ } ++ + } + + sub product_responsibilities { +@@ -1547,7 +1591,8 @@ + + $dbh->bz_lock_tables('profiles WRITE', 'profiles_activity WRITE', + 'user_group_map WRITE', 'email_setting WRITE', 'groups READ', +- 'tokens READ', 'fielddefs READ'); ++ 'tokens READ', 'fielddefs READ', 'test_plan_permissions_regexp READ', ++ 'test_plan_permissions READ'); + + my $user = $class->SUPER::create(@_); + +Index: Bugzilla/Error.pm +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/Error.pm,v +retrieving revision 1.19.2.3 +diff -u -r1.19.2.3 Error.pm +--- Bugzilla/Error.pm 16 Aug 2007 20:37:43 -0000 1.19.2.3 ++++ Bugzilla/Error.pm 29 Feb 2008 23:19:44 -0000 +@@ -32,6 +32,7 @@ + use Bugzilla::WebService::Constants; + use Bugzilla::Util; + use Date::Format; ++use JSON; + + # We cannot use $^S to detect if we are in an eval(), because mod_perl + # already eval'uates everything, so $^S = 1 in all cases under mod_perl! +@@ -110,6 +111,16 @@ + } + die SOAP::Fault->faultcode($code)->faultstring($message); + } ++ elsif (Bugzilla->error_mode == ERROR_MODE_AJAX) { ++ # JSON can't handle strings across lines. ++ $message =~ s/\n/ /gm; ++ my $err; ++ $err->{'success'} = 'false'; ++ $err->{'error'} = $error; ++ $err->{'message'} = $message; ++ my $json = new JSON; ++ print $json->objToJson($err); ++ } + } + exit; + } +Index: Bugzilla/WebService.pm +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/WebService.pm,v +retrieving revision 1.5.2.1 +diff -u -r1.5.2.1 WebService.pm +--- Bugzilla/WebService.pm 26 Mar 2007 07:57:32 -0000 1.5.2.1 ++++ Bugzilla/WebService.pm 29 Feb 2008 23:19:44 -0000 +@@ -14,10 +14,12 @@ + # + # Contributor(s): Marc Schumann + # Max Kanat-Alexander ++# Dallas Harken + + package Bugzilla::WebService; + + use strict; ++use Bugzilla::Config; + use Bugzilla::WebService::Constants; + use Date::Parse; + +@@ -48,9 +50,48 @@ + Bugzilla->login; + } + ++sub login { ++ my $self = shift; ++ ++ # Check for use of iChain first ++ if (Bugzilla->params->{'user_verify_class'} ne 'iChain') ++ { ++ # ++ # Check for use of Basic Authorization ++ # ++ # WARNING - Your must modify your Apache server's configuration ++ # to allow the HTTP_AUTHORIZATION env parameter to be passed through! ++ # This requires using the rewrite module. ++ # ++ if (defined($ENV{'HTTP_AUTHORIZATION'})) ++ { ++ if ($ENV{'HTTP_AUTHORIZATION'} =~ /^Basic +(.*)$/os) ++ { ++ # HTTP Basic Authentication ++ my($login, $password) = split(/:/, MIME::Base64::decode_base64($1), 2); ++ ++ my $cgi = Bugzilla->cgi; ++ $cgi->param("Bugzilla_login", $login); ++ $cgi->param("Bugzilla_password", $password); ++ } ++ } ++ } ++ ++ Bugzilla->login; ++} ++ ++sub logout ++{ ++# Testopia's method does not persist anything so logout in unneccessary. ++# my $self = shift; ++# ++# Bugzilla->logout; ++} ++ + package Bugzilla::WebService::XMLRPC::Transport::HTTP::CGI; + + use strict; ++use Bugzilla::WebService::Constants; + eval 'use base qw(XMLRPC::Transport::HTTP::CGI)'; + + sub make_response { +@@ -65,6 +106,13 @@ + } + } + ++sub make_fault { ++ my $self = shift; ++ ++ # RPC Fault Code must be an integer ++ $self->SUPER::make_fault(ERROR_FAULT_SERVER, $_[1]); ++} ++ + 1; + + __END__ +@@ -131,4 +179,4 @@ + + Sometimes a function will throw an error that doesn't have a specific + error code. In this case, the code will be C<-32000> if it's a "fatal" +-error, and C<32000> if it's a "transient" error. ++error, and C<32000> if it's a "transient" error. +\ No newline at end of file +Index: Bugzilla/Constants.pm +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/Constants.pm,v +retrieving revision 1.68.2.11 +diff -u -r1.68.2.11 Constants.pm +--- Bugzilla/Constants.pm 9 Jan 2008 07:16:16 -0000 1.68.2.11 ++++ Bugzilla/Constants.pm 29 Feb 2008 23:19:44 -0000 +@@ -126,6 +126,7 @@ + ERROR_MODE_WEBPAGE + ERROR_MODE_DIE + ERROR_MODE_DIE_SOAP_FAULT ++ ERROR_MODE_AJAX + + INSTALLATION_MODE_INTERACTIVE + INSTALLATION_MODE_NON_INTERACTIVE +@@ -351,6 +352,7 @@ + use constant ERROR_MODE_WEBPAGE => 0; + use constant ERROR_MODE_DIE => 1; + use constant ERROR_MODE_DIE_SOAP_FAULT => 2; ++use constant ERROR_MODE_AJAX => 3; + + # The various modes that checksetup.pl can run in. + use constant INSTALLATION_MODE_INTERACTIVE => 0; +Index: template/en/default/global/header.html.tmpl +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/template/en/default/global/header.html.tmpl,v +retrieving revision 1.49.2.1 +diff -u -r1.49.2.1 header.html.tmpl +--- template/en/default/global/header.html.tmpl 29 Jul 2007 19:24:04 -0000 1.49.2.1 ++++ template/en/default/global/header.html.tmpl 29 Feb 2008 23:19:45 -0000 +@@ -96,6 +96,7 @@ + [% IF user.settings.skin.value != 'standard' %] + [% user_skin = user.settings.skin.value %] + [% END %] ++ [% style_urls.unshift('skins/standard/testopia.css') %] + [% style_urls.unshift('skins/standard/global.css') %] + + [%# CSS cascade, part 1: Standard Bugzilla stylesheet set (persistent). +Index: template/en/default/global/common-links.html.tmpl +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/template/en/default/global/common-links.html.tmpl,v +retrieving revision 1.7 +diff -u -r1.7 common-links.html.tmpl +--- template/en/default/global/common-links.html.tmpl 28 Dec 2006 16:48:06 -0000 1.7 ++++ template/en/default/global/common-links.html.tmpl 29 Feb 2008 23:19:45 -0000 +@@ -103,3 +103,4 @@ + [% END %] + [% END %] + ++[% Hook.process("links") %] +\ No newline at end of file +Index: editusers.cgi +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/editusers.cgi,v +retrieving revision 1.141.2.1 +diff -u -r1.141.2.1 editusers.cgi +--- editusers.cgi 19 Nov 2007 12:45:31 -0000 1.141.2.1 ++++ editusers.cgi 29 Feb 2008 23:19:44 -0000 +@@ -229,6 +229,8 @@ + # Lock tables during the check+update session. + $dbh->bz_lock_tables('profiles WRITE', + 'profiles_activity WRITE', ++ 'test_plan_permissions WRITE', ++ 'test_plan_permissions_regexp READ', + 'fielddefs READ', + 'tokens WRITE', + 'logincookies WRITE', +Index: votes.cgi +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/votes.cgi,v +retrieving revision 1.50.2.1 +diff -u -r1.50.2.1 votes.cgi +--- votes.cgi 10 Jun 2007 10:20:52 -0000 1.50.2.1 ++++ votes.cgi 29 Feb 2008 23:19:44 -0000 +@@ -130,8 +130,8 @@ + + my $canedit = (Bugzilla->params->{'usevotes'} && $userid == $who) ? 1 : 0; + +- $dbh->bz_lock_tables('bugs READ', 'products READ', 'votes WRITE', +- 'cc READ', 'bug_group_map READ', 'user_group_map READ', ++ $dbh->bz_lock_tables('bugs READ', 'products READ', 'products AS tr_products READ', 'votes WRITE', ++ 'cc READ', 'bug_group_map READ', 'user_group_map READ', 'test_plans READ', 'test_plan_permissions READ', + 'group_group_map READ', 'groups READ', 'group_control_map READ'); + + if ($canedit && $bug_id) { +Index: Bugzilla/WebService/User.pm +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/WebService/User.pm,v +retrieving revision 1.4.2.1 +diff -u -r1.4.2.1 User.pm +--- Bugzilla/WebService/User.pm 18 Sep 2007 23:30:20 -0000 1.4.2.1 ++++ Bugzilla/WebService/User.pm 29 Feb 2008 23:19:45 -0000 +@@ -110,6 +110,40 @@ + return { id => type('int')->value($user->id) }; + } + ++################# ++# User Lookup # ++################# ++ ++sub lookup_login_by_id { ++ my $self = shift; ++ my ($author_id) = @_; ++ ++ $self->SUPER::login; ++ ++ my $user = new Bugzilla::User($author_id); ++ ++ my $result = defined $user ? $user->login : ''; ++ ++ $self->SUPER::logout; ++ ++ # Result is user login string or empty string if failed ++ return $result; ++} ++ ++sub lookup_id_by_login { ++ my $self = shift; ++ my ($author) = @_; ++ ++ $self->SUPER::login; ++ ++ my $result = Bugzilla::User::login_to_id($author); ++ ++ $self->SUPER::logout; ++ ++ # Result is user id or 0 if failed ++ return $result; ++} ++ + 1; + + __END__ +Index: Bugzilla/WebService/Constants.pm +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/WebService/Constants.pm,v +retrieving revision 1.6.2.2 +diff -u -r1.6.2.2 Constants.pm +--- Bugzilla/WebService/Constants.pm 18 Sep 2007 23:30:20 -0000 1.6.2.2 ++++ Bugzilla/WebService/Constants.pm 29 Feb 2008 23:19:45 -0000 +@@ -21,6 +21,9 @@ + use base qw(Exporter); + + @Bugzilla::WebService::Constants::EXPORT = qw( ++ ERROR_GENERAL ++ ERROR_FAULT_SERVER ++ + WS_ERROR_CODE + ERROR_UNKNOWN_FATAL + ERROR_UNKNOWN_TRANSIENT +Index: Bugzilla/Install/Filesystem.pm +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/Install/Filesystem.pm,v +retrieving revision 1.18.2.2 +diff -u -r1.18.2.2 Filesystem.pm +--- Bugzilla/Install/Filesystem.pm 17 Aug 2007 21:13:29 -0000 1.18.2.2 ++++ Bugzilla/Install/Filesystem.pm 29 Feb 2008 23:19:45 -0000 +@@ -110,6 +110,8 @@ + 'runtests.pl' => { perms => $owner_executable }, + 'testserver.pl' => { perms => $ws_executable }, + 'whine.pl' => { perms => $ws_executable }, ++ 'tr_csv2xml.pl' => { perms => $ws_executable }, ++ 'tr_importxml.pl' => { perms => $ws_executable }, + 'customfield.pl' => { perms => $owner_executable }, + 'email_in.pl' => { perms => $ws_executable }, + +@@ -151,6 +153,8 @@ + dirs => $ws_dir_readable }, + "$libdir/Bugzilla" => { files => $ws_readable, + dirs => $ws_dir_readable }, ++ "$libdir/testopia" => { files => $ws_readable, ++ dirs => $ws_dir_readable }, + $templatedir => { files => $ws_readable, + dirs => $ws_dir_readable }, + images => { files => $ws_readable, +Index: Bugzilla/DB/Mysql.pm +=================================================================== +RCS file: /cvsroot/mozilla/webtools/bugzilla/Bugzilla/DB/Mysql.pm,v +retrieving revision 1.49 +diff -u -r1.49 Mysql.pm +--- Bugzilla/DB/Mysql.pm 4 Feb 2007 16:59:30 -0000 1.49 ++++ Bugzilla/DB/Mysql.pm 29 Feb 2008 23:19:44 -0000 +@@ -613,6 +613,9 @@ + if ($table eq 'bugs' && $name eq 'short_desc') { + $self->bz_drop_index('bugs', 'bugs_short_desc_idx'); + } ++ if ($table eq 'test_runs' && $name eq 'summary') { ++ $self->bz_drop_index('test_runs', 'test_runs_summary_idx'); ++ } + + print "Converting $table.$name to be stored as UTF-8...\n"; + my $col_info =