[thirdparty/cups.git] / doc / help / spec-stp.html

<HTML>
<!-- SECTION: Specifications -->
<HEAD>
	<TITLE>CUPS Software Test Plan</TITLE>
</HEAD>
<BODY>

<P>This software test plan provides detailed tests that are used
to evaluate the stability and compliance of the Common UNIX
Printing System ("CUPS") Version 1.2.</P>


<H2 CLASS="title"><A NAME="PROCEDURE">Test Procedure</A></H2>

<P>The test software and data files are located in the
<VAR>test</VAR> subdirectory of the source distribution. A script
is provided to compile the <CODE>ipptest</CODE> program and run
all of the tests that follow, producing a success/fail
report.</P>

<P>The <CODE>test</CODE> target of the top-level makefile can be
used to run this script:</P>

<PRE CLASS="command">
make test
</PRE>

<P>or you can run the test script directly:</P>

<PRE CLASS="command">
cd test
./run-stp-tests
</PRE>

<P>A Software Test Report is stored in a HTML file in the
<VAR>test</VAR> subdirectory at the conclusion of the test.</P>


<H2 CLASS="title"><A NAME="IPP">IPP Compliance Tests</A></H2>

<P>This section describes the tests used to validate the IPP
standards compliance of the CUPS server.</P>

<H3>Request Tests</H3>

<P>These tests verify that the CUPS scheduler only accepts valid
IPP requests that start with the <CODE>attributes-charset</CODE>
and <CODE>attributes-natural-language</CODE> attributes and also
contain a <CODE>printer-uri</CODE> or <CODE>job-uri</CODE>
attribute.</P>

<P>It also verifies that the CUPS scheduler always responds with
<CODE>attributes-charset</CODE> and
<CODE>attributes-natural-language</CODE> attributes, using
default values if they are not provided by the client.</P>

<H3>CUPS Printer Operation Tests</H3>

<P>These tests verify that the CUPS printer operations are
supported and function properly. Two printers called
<CODE>Test1</CODE> and <CODE>Test2</CODE> are created, one as a
PostScript printer and one as a raster printer.</P>

<H3>Job Operation Tests</H3>

<P>These test verify that the CUPS scheduler accepts print jobs
for all supported file formats and that the
<CODE>cancel-job</CODE>, <CODE>hold-job</CODE>, and
<CODE>resume-job</CODE> operations work.</P>

<H3>Subscription Operation Tests</H3>

<P>These test verify that the CUPS scheduler accepts
subscriptions with print jobs and that all subscription
operations work as required by the IPP notification and mailto
specifications.</P>


<H2 CLASS="title"><A NAME="COMMAND">Command Tests</A></H2>

<P>This section describes the tests used to validate the Berkeley
and System V commands included with CUPS.</P>

<H3>lpadmin</H3>

<P>This test verifies that printers can be added, modified, and
defaulted using the <CODE>lpadmin</CODE> command.</P>

<H3>lpc</H3>

<P>This test verifies that the <CODE>lpc</CODE> command can show
the current status of all print queues.</P>

<H3>lpq</H3>

<P>This test verifies that the <CODE>lpq</CODE> command lists
any jobs in the queue.</P>

<H3>lpstat</H3>

<P>This test verifies that the <CODE>lpstat</CODE> command works
with all reports using the "<CODE>-t</CODE>" option.</P>

<H3>lp</H3>

<P>This test verifies that the <CODE>lp</CODE> command works with
both the default destination and a specific destination.</P>

<H3>lpr</H3>

<P>This test verifies that the <CODE>lpr</CODE> command works
with both the default destination and a specific destination.</P>

<H3>lprm</H3>

<P>This test verifies that the <CODE>lprm</CODE> command can
properly cancel a job.</P>

<H3>cancel</H3>

<P>This test verifies that the <CODE>cancel</CODE> command can
properly cancel a job or all jobs.</P>

<H3>lpinfo</H3>

<P>This test verifies that the <CODE>lpinfo</CODE> command
returns a list of available printer drivers and devices.</P>

</BODY>
</HTML>
Commit	Line	Data
4744bd90	1	<HTML>
	2	<!-- SECTION: Specifications -->
	3	<HEAD>
	4	<TITLE>CUPS Software Test Plan</TITLE>
	5	</HEAD>
	6	<BODY>
	7
	8	<P>This software test plan provides detailed tests that are used
	9	to evaluate the stability and compliance of the Common UNIX
	10	Printing System ("CUPS") Version 1.2.</P>
	11
	12
	13	<H2 CLASS="title"><A NAME="PROCEDURE">Test Procedure</A></H2>
	14
	15	<P>The test software and data files are located in the
	16	<VAR>test</VAR> subdirectory of the source distribution. A script
	17	is provided to compile the <CODE>ipptest</CODE> program and run
	18	all of the tests that follow, producing a success/fail
	19	report.</P>
	20
	21	<P>The <CODE>test</CODE> target of the top-level makefile can be
	22	used to run this script:</P>
	23
	24	<PRE CLASS="command">
	25	make test
	26	</PRE>
	27
	28	<P>or you can run the test script directly:</P>
	29
	30	<PRE CLASS="command">
	31	cd test
	32	./run-stp-tests
	33	</PRE>
	34
	35	<P>A Software Test Report is stored in a HTML file in the
	36	<VAR>test</VAR> subdirectory at the conclusion of the test.</P>
	37
	38
	39	<H2 CLASS="title"><A NAME="IPP">IPP Compliance Tests</A></H2>
	40
	41	<P>This section describes the tests used to validate the IPP
	42	standards compliance of the CUPS server.</P>
	43
	44	<H3>Request Tests</H3>
	45
	46	<P>These tests verify that the CUPS scheduler only accepts valid
	47	IPP requests that start with the <CODE>attributes-charset</CODE>
	48	and <CODE>attributes-natural-language</CODE> attributes and also
	49	contain a <CODE>printer-uri</CODE> or <CODE>job-uri</CODE>
	50	attribute.</P>
	51
	52	<P>It also verifies that the CUPS scheduler always responds with
	53	<CODE>attributes-charset</CODE> and
	54	<CODE>attributes-natural-language</CODE> attributes, using
	55	default values if they are not provided by the client.</P>
	56
	57	<H3>CUPS Printer Operation Tests</H3>
	58
	59	<P>These tests verify that the CUPS printer operations are
	60	supported and function properly. Two printers called
	61	<CODE>Test1</CODE> and <CODE>Test2</CODE> are created, one as a
	62	PostScript printer and one as a raster printer.</P>
	63
	64	<H3>Job Operation Tests</H3>
65
66	<P>These test verify that the CUPS scheduler accepts print jobs
67	for all supported file formats and that the
68	<CODE>cancel-job</CODE>, <CODE>hold-job</CODE>, and
69	<CODE>resume-job</CODE> operations work.</P>
70
71	<H3>Subscription Operation Tests</H3>
72
73	<P>These test verify that the CUPS scheduler accepts
74	subscriptions with print jobs and that all subscription
75	operations work as required by the IPP notification and mailto
76	specifications.</P>
77
78
79	<H2 CLASS="title"><A NAME="COMMAND">Command Tests</A></H2>
80
81	<P>This section describes the tests used to validate the Berkeley
82	and System V commands included with CUPS.</P>
83
84	<H3>lpadmin</H3>
85
86	<P>This test verifies that printers can be added, modified, and
87	defaulted using the <CODE>lpadmin</CODE> command.</P>
88
89	<H3>lpc</H3>
90
91	<P>This test verifies that the <CODE>lpc</CODE> command can show
92	the current status of all print queues.</P>
93
94	<H3>lpq</H3>
95
96	<P>This test verifies that the <CODE>lpq</CODE> command lists
97	any jobs in the queue.</P>
98
99	<H3>lpstat</H3>
100
101	<P>This test verifies that the <CODE>lpstat</CODE> command works
102	with all reports using the "<CODE>-t</CODE>" option.</P>
103
104	<H3>lp</H3>
105
106	<P>This test verifies that the <CODE>lp</CODE> command works with
107	both the default destination and a specific destination.</P>
108
109	<H3>lpr</H3>
110
111	<P>This test verifies that the <CODE>lpr</CODE> command works
112	with both the default destination and a specific destination.</P>
113
114	<H3>lprm</H3>
115
116	<P>This test verifies that the <CODE>lprm</CODE> command can
117	properly cancel a job.</P>
118
119	<H3>cancel</H3>
120
121	<P>This test verifies that the <CODE>cancel</CODE> command can
122	properly cancel a job or all jobs.</P>
123
124	<H3>lpinfo</H3>
125
126	<P>This test verifies that the <CODE>lpinfo</CODE> command
127	returns a list of available printer drivers and devices.</P>
128
129	</BODY>
130	</HTML>