Comment out test that all title-terms are in the general-term list,
[ZOOM-Perl-moved-to-github.git] / t / 15-scan.t
1 # Before `make install' is performed this script should be runnable with
2 # `make test'. After `make install' it should work as `perl 15-scan.t'
3
4 use strict;
5 use warnings;
6 use Test::More tests => 81;
7
8 BEGIN { use_ok('Net::Z3950::ZOOM') };
9
10 my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
11
12 my $host = "z3950.indexdata.com/gils";
13 my $conn = Net::Z3950::ZOOM::connection_new($host, 0);
14 $errcode = Net::Z3950::ZOOM::connection_error($conn, $errmsg, $addinfo);
15 ok($errcode == 0, "connection to '$host'");
16
17 Net::Z3950::ZOOM::connection_option_set($conn, number => 10);
18 my($ss, $n) = scan($conn, 0, "w", 10);
19
20 my @terms = ();
21 my($occ, $len) = (0, 0);
22
23 my $previous = "";              # Sorts before all legitimate terms
24 foreach my $i (1 .. $n) {
25     my $term = Net::Z3950::ZOOM::scanset_term($ss, $i-1, $occ, $len);
26     ok(defined $term && $len eq length($term),
27        "got term $i of $n: '$term' ($occ occurences)");
28     ok($term ge $previous, "term '$term' ge previous '$previous'");
29     $previous = $term;
30     push @terms, $term;
31     my $disp = Net::Z3950::ZOOM::scanset_display_term($ss, $i-1, $occ, $len);
32     ok(defined $disp && $len eq length($disp),
33        "display term $i of $n: '$disp' ($occ occurences)");
34     ok(lc($disp) eq lc($term),
35        "display term $i ($disp) equivalent to term ($term)");
36 }
37
38 Net::Z3950::ZOOM::scanset_destroy($ss);
39 ok(1, "destroyed scanset");
40 ok(1, "(can't re-destroy scanset)"); # Only meaningful in OO API.
41
42 # Now re-scan, but only for words that occur in the title
43 # This time, use a Query object for the start-term
44 my $q = Net::Z3950::ZOOM::query_create();
45 Net::Z3950::ZOOM::query_prefix($q, '@attr 1=4 w');
46 ($ss, $n) = scan($conn, 1, $q, 6);
47
48 $previous = "";         # Sorts before all legitimate terms
49 foreach my $i (1 .. $n) {
50     my $term = Net::Z3950::ZOOM::scanset_term($ss, $i-1, $occ, $len);
51     ok(defined $term && $len eq length($term),
52        "got title term $i of $n: '$term' ($occ occurences)");
53     ok($term ge $previous, "title term '$term' ge previous '$previous'");
54     $previous = $term;
55     # See comment in 25-scan.t
56     #ok((grep { $term eq $_ } @terms), "title term ($term) was in term list (@terms)");
57 }
58
59 Net::Z3950::ZOOM::scanset_destroy($ss);
60 ok(1, "destroyed second scanset");
61
62 # Now re-do the same scan, but limiting the results to four terms at a
63 # time.  This time, use a CQL query
64 Net::Z3950::ZOOM::connection_option_set($conn, number => 4);
65 Net::Z3950::ZOOM::connection_option_set($conn, cqlfile =>
66                                         "samples/cql/pqf.properties");
67
68 $q = Net::Z3950::ZOOM::query_create();
69 Net::Z3950::ZOOM::query_cql2rpn($q, 'title=w', $conn);
70 ($ss, $n) = scan($conn, 1, $q, 4);
71 # Get last term and use it as seed for next scan
72 my $term = Net::Z3950::ZOOM::scanset_term($ss, $n-1, $occ, $len);
73 ok(Net::Z3950::ZOOM::scanset_option_get($ss, "position") == 1,
74    "seed-term is start of returned list");
75 ok(defined $term && $len eq length($term),
76    "got last title term '$term' to use as seed");
77
78 Net::Z3950::ZOOM::scanset_destroy($ss);
79 ok(1, "destroyed third scanset");
80
81 # Now using CCL
82 $q = Net::Z3950::ZOOM::query_create();
83 my($ccl_errcode, $ccl_errstr, $ccl_errpos) = (0, "", 0);
84 Net::Z3950::ZOOM::query_ccl2rpn($q, 'ti=w', "ti u=4 s=pw",
85                                 $ccl_errcode, $ccl_errstr, $ccl_errpos);
86 ($ss, $n) = scan($conn, 1, $q, 4);
87 # Get last term and use it as seed for next scan
88 $term = Net::Z3950::ZOOM::scanset_term($ss, $n-1, $occ, $len);
89 ok(Net::Z3950::ZOOM::scanset_option_get($ss, "position") == 1,
90    "seed-term is start of returned list");
91 ok(defined $term && $len eq length($term),
92    "got last title term '$term' to use as seed");
93
94 Net::Z3950::ZOOM::scanset_destroy($ss);
95 ok(1, "destroyed fourth scanset");
96
97 # We want the seed-term to be in "position zero", i.e. just before the start
98 Net::Z3950::ZOOM::connection_option_set($conn, position => 0);
99 ($ss, $n) = scan($conn, 0, "\@attr 1=4 $term", 2);
100 ok(Net::Z3950::ZOOM::scanset_option_get($ss, "position") == 0,
101    "seed-term before start of returned list");
102
103 # Silly test of option setting and getting
104 Net::Z3950::ZOOM::scanset_option_set($ss, position => "fruit");
105 ok(Net::Z3950::ZOOM::scanset_option_get($ss, "position") eq "fruit",
106    "option setting/getting works");
107
108 Net::Z3950::ZOOM::scanset_destroy($ss);
109 ok(1, "destroyed fifth scanset");
110
111 # There is no obvious use for scanset_option_set(), and little to be
112 # done with scanset_option_get(); and I can't find a server that
113 # returns display terms different from its terms.
114
115
116 sub scan {
117     my($conn, $startterm_is_query, $startterm, $nexpected) = @_;
118
119     my $ss;
120     if ($startterm_is_query) {
121         $ss = Net::Z3950::ZOOM::connection_scan1($conn, $startterm);
122     } else {
123         $ss = Net::Z3950::ZOOM::connection_scan($conn, $startterm);
124     }
125
126     $errcode = Net::Z3950::ZOOM::connection_error($conn, $errmsg, $addinfo);
127     ok($errcode == 0, "scan for '$startterm'");
128
129     my $n = Net::Z3950::ZOOM::scanset_size($ss);
130     ok(defined $n, "got size");
131     ok($n == $nexpected, "got $n terms '$startterm' (expected $nexpected)");
132     return ($ss, $n);
133 }