javahelp/jhMaster/JavaHelp/test/QATests.html at master · javaee/javahelp

This repository was archived by the owner on Jan 30, 2019. It is now read-only.

History

1098 lines (1003 loc) · 24.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML EXPERIMENTAL 970324//EN">

<HTML>

<HEAD>

<TITLE>JavaHelp Quality Assurance Tests</TITLE>

</HEAD>

JavaHelp Quality Assurance Test Plan and Tests

</H1>

<P>

06/11/11 12:57:35

</P>

<P>

(Updated for V1.1.1)

</P>

<H2 >

Overview

</H2>

<p>

This is the test plan for JavaHelp V1.1.1. It is a comprehensive

document to insure the quality of the bundles that are released on

java.sun.com as well as the Solaris packages that are distributed for

the Solaris installation CD. As such it includes additional test

requirement for java.sun.com JavaHelp web pages.

</p>

<p>

Bundles and Solaris packages are initially tested after a

release engineer has successfully completed a build. They are

not forwarded to java.sun.com or to the java consolidation until

all the tests have been successfully completed. Once available

on java.sun.com or in the Solaris Operating System the packages

are retested.

</p>

<H2>

External Testing

</H2>

<P>

JavaHelp V1.1.1 was provided in beta form and has been released

on the web since September 2000. At the time of it's web release

there were no P1 or P2 bugs filed against JavaHelp. There is

currently one P2 bug filed against V1.1.1.

</p>

<H2>

Overall

</H2>

<P>

The main bundles to test are the "fool-proof"

bundles."Fool-prof" bundles have a JRE included. The

"small" bundles will be tested only by content and by short

tests on a few platforms since a "fool-proof" bundle is

based on the small bundle. The Solaris packages will be tested as a

main bundle

</P>

<p>

Each bundle or package will have at least one of the following tests

executed.

</p>

<TR>

<TH><b>Description</b></th>

</TR>

<TR>

<TD>Documentation Review</TD>

<TD>Full review of the product Documentation</TD>

</TR>

<TR>

<TD>JavaHelp Technical Compatibility Kit for

JavaHelp 1.0 Specification

</TD>

</TR>

<TR>

<TD>Contents Verification</TD>

<TD>Verification of a bundles/packages contents</td>

</TR>

<TR>

<TD>Installation Verification</TD>

<TD>Verification package installs correctly</td>

</tr>

<TR>

<TD>Full Functionality</TD>

<TD>A complete test of functionality of JavaHelp via the demos</td>

</tr>

<tr>

<td>Short Functionality</TD>

<TD>A shorten version of the Full Functionality tests</td>

</tr>

<tr>

<td>Web Pages</td>

<td>A comprehensive test of the Web pages</td>

</tr>

</TABLE>

<p>

The tests executed on a given package are described in

<a href="#configurations">Testing Configurations</a>.

</p>

<H2>

Bundles and Packages</H2>

<P>

The release of JavaHelp V1.1.1 comes in 4 different

packages, as indicated below:

</P>

<P>

<b>Bundles for JH V1.1.1</b>

</CAPTION>

<TR>

Name</TH>

Platform</TH>

Approx Size

</TH>

JRE included

</TH>

</TR>

<TR>

javahelp1_1_1-solsparc-rt.bin

</TD>

Solaris/SPARC

</TD>

23,356,630

</TD>

1.2.2

</TD>

</TR>

<TR>

javahelp1_1_1-win-rt.exe

</TD>

win32

</TD>

17,056,357

</TD>

1.2

</TD>

</TR>

<TR>

javahelp1_1_1-unix-no_rt.bin

</TD>

Unix platform

</TD>

8,291,388

</TD>

None

</TD>

</TR>

<TR>

javahelp1_1_1-win-no_rt.exe

</TD>

win32

</TD>

8,672,334

</TD>

None

</TD>

</TR>

</TABLE>

<P>

The JavaHelp V1.1.1 Solaris install packages comes in 4

different packages, as indicated below. The packages are

designed to be installed against the Java1.2 and Java2 Solaris

packages.

</P>

<P>

<b>JH V1.1.1 Solaris Packages</b>

</CAPTION>

<TR>

Name</TH>

Description</TH>

Size</TH>

</TR>

<TR>

SUNWjhrt

</TD>

JavaHelp runtime

</TD>

407,552

</TD>

</TR>

<TR>

SUNWjhdev

</TD>

JavaHelp developer tools

</TD>

391,680

</TD>

</TR>

<TR>

SUNWjhdoc

</TD>

JavaHelp documentation

</TD>

2,944,512

</TD>

</TR>

<TR>

SUNWjhdem

</TD>

JavaHelp demos

</TD>

5,427,712

</TD>

</TR>

</TABLE>

<p>

<H2>

Testing Configurations: Priorities</H2>

</a>

Descending Priority Order</H6>

</CAPTION>

<TR>

</TH>

Install Bundle

</TH>

TYPE

</TH>

</TR>

<TR>

N/A

</TD>

javahelp1_1_1-win-no_rt.exe

<P>

javahelp1_1_1-unix-no_rt.bin

</P>

</TD>

Documentation Review

<P>

TCK Test

</P>

</TD>

</TR>

<TR>

Win95

</TD>

javahelp1_1_1-win-rt.exe

</TD>

Full Functionality

</TD>

</TR>

<TR>

Solaris 2.7

</TD>

javahelp1_1_1-solsparc-rt.bin

</TD>

Full Functionality

</TD>

</TR>

<TR>

NT4.0

</TD>

javahelp1_1_1-win-rt.exe

</TD>

Full Functionality

</TD>

</TR>

<TR>

Win98

</TD>

javahelp1_1_1-win-rt.exe

</TD>

Full Functionality

</TD>

</TR>

<TR>

Solaris 2.8

</TD>

Solaris install packages

</TD>

Contents Verification

<p>

Installation Verification

</p>

<p>

Full Functionality

</P>

</TD>

</TR>

<TR>

Solaris 2.9

</TD>

Solaris install packages

</TD>

Contents Verification

<p>

Installation Verification

</p>

<p>

Full Functionality

</p>

</TD>

</TR>

<TR>

Any Solaris<A HREF="#footnote2"> 2</A>

</TD>

javahelp1_1_1-unix-no_rt.bin

</TD>

Contents Verification

<P>

Installation Verification

</P>

</TD>

</TR>

<TR>

Any Win32

</TD>

javahelp1_1_1-win-no_rt.exe

</TD>

Contents Verification

<P>

Installation Verification

</P>

</TD>

</TR>

<TR>

Any win32

</TD>

javahelp1_1_1-win-rt.exe

</TD>

Contents Verification

<P>

Installation Verification

</P>

</TD>

</TR>

<TR>

Any Solaris

</P>

</TD>

javahelp1_1_1-solsparc-rt.bin

</TD>

Contents Verification

<P>

Installation Verification

</P>

</TD>

</TR>

<TR>

N/A

</TD>

N/A

</TD>

Web Pages

</TD>

</TR>

</TABLE>

<H2>Documentation Review</H2>

<p>

Proof read manuals for technical accuracy. All examples

and procedures will be tested.

</p>

<H2>Technical Compatibility Kit Tests</H2>

<P>

Execute the JavaHelp TCK tests against a given

installation.

</p>

<H2>Contents Verification</H2>

<p>

Verify that doc/welcome/content.html and

doc/welcome/CONTENS.html matches what is in the release.

</P>

<H2>Installation verification</H2>

<p>

Including installation instructions, product documents,

and Release Notes.

</P>

<p>

(Review documentation from a user's perspective)

</P>

<H4>

Verifying "JRE (aka VM)" Installation on Solaris

</H4>

<OL>

Install the JRE-full release (InstallAnywhere script)

</LI>

Verify the version of the JRE installed as:</LI>

<installdir&gt/jre/bin/java -fullversion

</P>

java full version "JDK-1.2-V"

</P>

Test demo programs activation.</LI>

Test jhindexer.</LI>

</OL>

<H4>

Verifying "JRE (aka VM)" Installation on Win32

</H4>

<OL>

Install the JRE-full release (InstallAnywhere script)

</LI>

Verify the version of the JRE installed from the MSDOS prompt as:

</LI>

<installdir>/jre/bin/java -fullversion

</P>

java full version "JDK-1.2-V"

</P>

Test demo programs activation for installed program group.

</LI>

Test jhindexer.

</LI>

</OL>

<H4>Verifying NoVm Installation</H4>

<P>

Do this in one win32 and one Solaris machine.</P>

<OL>

Verify the version of the JRE installed as:

</LI>

java -fullversion

</P>

java full version "JDK-1.2-V" [or 1.1.8]

</P>

Install the NoVM release.

</LI>

Adjust CLASSPATH and PATH as XXXX. Verify as YYYY.

</LI>

Execute short tests.

</LI>

</OL>

<P>

Do a content difference between the small and the full releases.

Changes should be limited to:

</P>

<OL>

jre/ directory is missing

</LI>

README_small file is new

</LI>

</OL>

<H4>Verifying Solaris Package Installation</H4>

<P>

Do this in on Solaris 8 update 5 and Solaris 9.

</P>

<OL>

Verify the version of the JRE installed as:

</LI>

java -fullversion

</P>

java full version "JDK-1.2.2-W"

</P>

Install the four JavaHelp Solaris packages.

Verify proper installation against:

<UL>

<LI>

No JDK package installed

</LI>

<LI>

JAVA1.2 Solaris package installed

</li>

<LI>

JAVA2 Solaris package installed

</li>

</UL>

</P>

</LI>

Test demo programs activation for installed program group.

</LI>

Test jhindexer.

</LI>

</OL>

<h2 CLASS="HEADING1">Full Functionality Tests</H2>

<p>

These tests are a complete test of the functionality of

JavaHelp. They rely heavily on the JavaHelp demos as the

testing mechanism.

</p>

<OL>

Test hsviewer. (short)

</LI>

Test hsviewer. (full)

</LI>

Test apiviewer.

</LI>

Test IdeDemo.

</LI>

Test merge.

</LI>

Test object.

</LI>

Test jhindexer.

</LI>

Rebuild IdeDemo

</LI>

</OL>

<h2 CLASS="HEADING1">Short Functionality Tests</H2>

<p>

These tests are an abbreviated test of the functionality of

JavaHelp. They rely heavily on the JavaHelp demos as the testing

mechanism. Short Functionality tests are executed as a sanity check that the

installation proceeded correctly. They test only a minimal amount of

the functionality. In all cases the Full Functionality test has already been

executed on the platform and it is only necessary to retest with

the short test.

</p>

<OL>

Test hsviewer. (short)

</LI>

Test apiviewer.

</LI>

Test jhindexer.

</LI>

</OL>

<H2>

Short Test for HSViewer (JavaHelp User's Guide)

</H2>

<p>

This tests that the main information available to the

users in the release is available. It also tests that the

basic JavaHelp machinery is OK.

</P>

<OL>

Start HSViewer with no arguments: you should get the

JavaHelp User's Guide HelpSet up. There are three

navigators: TOC, Index and Search

</LI>

Try all the entries in the JHUG TOC navigator.

</LI>

Collapse/expand some nodes.

</LI>

Check its contents, including LICENSE and COPYRIGHT.

</LI>

Verify that FORWARD and BACKWARD arrows work as desired

(should not be active until there is something that can

be done with them).

</LI>

Try some entries in the JHUG Index navigator.

</LI>

Try some queries in the JHUG Search navigator.

</LI>

Click on some returned values

</LI>

Exit hsviewer

</LI>

</OL>

<H2>Long Test for HSViewer</H2>

<p>

This tests that different ways of locating and accessing

at HelpSet information are working. Most of these tests

could be done using the "Merge" application, but

this application came quite late, so we are sticking to

this mechanism.

</P>

<P>

The welcome documentation lists a number of other helpsets

that can be tried, some of them are given as JAR files,

some of them as directories. Each entry should be tested.

Here is the list:

</P>

<TABLE>

<TR>

welcome.hs

</TD>

doc\welcome

</TD>

</TR>

<TR>

HolidayHistory.hs

</TD>

demos\hsjar\holidays.jar

</TD>

</TR>

<TR>

HolidayHistory.hs

</TD>

demos\hs\holidays

</TD>

</TR>

<TR>

IdeHelp.hs

</TD>

demo\hsjar\idehelp.jar

</TD>

</TR>

<TR>

api.hs

</TD>

demos\hsjar\apidoc.jar;demos\lib\classviewer.jar

</TD>

</TR>

<TR>

HolidayHistory.hs

</TD>

demos\lib\jhsearch.jar

</TD>

</TR>

</TABLE>

<P>

Go to File|Open Page and look at some .html page.

</P>

<H2>Testing APIViewer</H2>

<P>

This tests the extension mechanism for navigators. It

also tests that the users can navigate through the API

documentation.

</P>

<OL>

You should get API viewer.

</LI>

There may be an issue with the vertical separator

between the Navigators and the content.

</LI>

Select a class, select some methods/constructors

</LI>

Repeat for a few classes and interfaces.

</LI>

Test with Index navigator

</LI>

Search on the Full-Text Search.

</LI>

Exit APIViewer

</LI>

</OL>

<H2>Testing IdeDemo</H2>

<p>

This tests Context-Sensitive Help, Embedded Help, multiple

independent Help viewers.

</P>

<OL>

Launch IdeDemo. There should be one Frame split into

two panes. The Frame has a toolbar.

</LI>

Select Help->Demo JDE - Help. After a few seconds

the HelpViewer on the IdeHelp HelpSet will show up.

Check that the TOC is alive by collapsing and

compressing some; check that the search database is

working by querying on "breakpoints"; there

should be around 25 hits.

</LI>

Close the viewer.

</LI>

Try again; it should appear much faster.

</LI>

Now try Help->API Reference. Should open a new

viewer. Check that it is alive by expanding and

collapsing the TOC.

</LI>

Close the viewer.

</LI>

Click on the "?" button. The cursor should

change to one including a ?. A known bug in Solaris

makes this happen only the first time; it does not

happen at all on win32. Now click on the Save Icon in

the toolbar; the Help viewer for IdeHelp will show on

the JDE Main Toolbar.

</LI>

Now try Window->Class inspector. A TOC-like

Navigator (actually the ClassViewer Navigator) without

the Viewer will show in the Desktop pane. Select a

class, select a method. The content will be shown in

the tabbed lower pane.

</LI>

Now select the Search Navigator. Type in the phrase

compiling a java source file, you should get a hit.

</LI>

File->Exit. Click on Help. Should show help.

</LI>

File->Exit again. Click OK and exit.

</LI>

</OL>

<H2>Testing Merge</H2>

<p>

This tests Merging HelpSets. Also it provides an

interface to locating HelpSets and the such.

</P>

<OL>

Start Merge.

</LI>

Click on Locate HelpSet. This will locate HolidayHistory.hs

</LI>

Click on AddHelpSet

</LI>

Click on show MasterHelp. This should show a HelpSet

viewer that has TOC, Index, and Search corresponding to

the "master" helpset, plus the holidays.

</LI>

On the TOC, expand and contract some nodes.

</LI>

Select some nodes. Beware of selecting the intro of the

HolidayHistory since there is a bug somewhere that

raises an exception.

</LI>

Select the Index, do the same.

</LI>

Select the Search, search for holidays; search for helpset

</LI>

Back to the main Window, change the HelpSet name to say

"IdeHelp.hs". Locate the Help Set, then add

it.

</LI>

The HelpSet viewer should show how the HelpSet for

IdeHelp is added dynamically.

</LI>

Collapse, expand, and select an entry in the new portion

of the TOC and in the old one.

</LI>

Back to the main Window, select the holidays helpset from the

list; then click on "Show Selected HelpSet".

</LI>

A new HelpSet viewer will be shown with the content only

of the Holidays helpset. Navigations on both viewers

should be independent.

</LI>

Exit Merge

</LI>

</OL>

<H2>Testing Object</H2>

<p>

This tests components within HTML content.

</p>

<OL>

Start Object.

</LI>

Click on Text Flyover Demo. This will bring up the

flyover demo

</LI>

Place the cursor over the work object

</LI>

Click on Popup Window Demo in the TOC. This will bring

up the popup demo

</LI>

Click on the Help Button. The HTML text appears in a popup.

</LI>

Exit Object

</LI>

</OL>

<H2>Testing JHIndexer</H2>

<p>

This tests building a Full Text Search.

</P>

<OL>

cd to doc/jhug directory

</LI>

Delete the directory JavaHelpIndex if it exists.

</LI>

Execute jhindexer with the command

<P>

"../../javahelp/bin/jhindexer -verbose -db

JavaHelpIndex2 .".

</P>

</LI>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

QATests.html

Latest commit

History

QATests.html

File metadata and controls