blob: 163d9d9dd6561c0060c82656ac275105aa8d1b85 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
package org.apache.maven.cli;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import org.apache.commons.cli.Option;
import org.codehaus.plexus.PlexusTestCase;
import org.codehaus.plexus.util.FileUtils;
/**
* Pseudo test to generate documentation fragment about supported CLI options.
* TODO such documentation generation code should not be necessary as unit test but should be run
* during site generation (Velocity? Doxia macro?)
*/
public class CLIManagerTest
extends PlexusTestCase
{
private final static String LS = System.getProperty( "line.separator" );
private static class OptionComparator
implements Comparator<Option>
{
public int compare( Option opt1, Option opt2 )
{
return opt1.getOpt().compareToIgnoreCase( opt2.getOpt() );
}
}
private static class CLIManagerExtension
extends CLIManager
{
public Collection<Option> getOptions()
{
@SuppressWarnings( "unchecked" )
List<Option> optList = new ArrayList<Option>( options.getOptions() );
Collections.sort( optList, new OptionComparator() );
return optList;
}
}
public String getOptionsAsHtml()
{
StringBuilder sb = new StringBuilder();
boolean a = true;
sb.append( "<table border='1' class='zebra-striped'><tr class='a'><th><b>Options</b></th><th><b>Description</b></th></tr>" );
for ( Option option : new CLIManagerExtension().getOptions() )
{
a = !a;
sb.append( "<tr class='" ).append( a ? 'a' : 'b' ).append( "'><td><code>-<a name='" );
sb.append( option.getOpt() );
sb.append( "'>" );
sb.append( option.getOpt() );
sb.append( "</a>,--<a name='" );
sb.append( option.getLongOpt() );
sb.append( "'>" );
sb.append( option.getLongOpt() );
sb.append( "</a>" );
if ( option.hasArg() )
{
if ( option.hasArgName() )
{
sb.append( " <" ).append( option.getArgName() ).append( ">" );
}
else
{
sb.append( ' ' );
}
}
sb.append( "</code></td><td>" );
sb.append( option.getDescription() );
sb.append( "</td></tr>" );
sb.append( LS );
}
sb.append( "</table>" );
return sb.toString();
}
public void testOptionsAsHtml()
throws IOException
{
File options = getTestFile( "target/test-classes/options.html" );
FileUtils.fileWrite( options, "UTF-8", getOptionsAsHtml() );
}
}
|
