1618

Committed 30 Jul 2026 07:56PM UTC coverage: 62.907%. First build

Build # 1618

Build Type

Pull #863

github

Committed by

web-flow

Commit Message

Merge d1c7842f6 into de8b8fd22

Pull Request Pull Request #863: Add an option to set the degree of separation limit

Coverage Stats

69 of 142 branches covered (48.59%)

Branch coverage included in aggregate %.

4 of 5 new or added lines in 2 files covered. (80.0%)

182 of 257 relevant lines covered (70.82%)

1.42 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

72.64

/src/main/java/com/wakaleo/schemaspy/SchemaSpyReport.java

package com.wakaleo.schemaspy;

import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;

/**
 * The SchemaSpy Maven plugin report.
 *
 * <p>This plugin is designed to generate SchemaSpy report for a Maven website. SchemaSpy also may
 * need the Graphviz tool (https://www.graphviz.org/) in order to generate graphical representations
 * of the table/view relationships, so this needs to be installed on your machine.
 *
 * <p>The SchemaSpy goal invokes the SchemaSpy command-line tool. SchemaSpy generates a graphical
 * and HTML report describing a given relational database.
 *
 * @author John Smart
 * @author mprins
 */
@Mojo(name = "schemaspy", defaultPhase = LifecyclePhase.SITE)
public class SchemaSpyReport extends AbstractMavenReport {

  @Parameter(property = "vizjs", defaultValue = "true")
  protected boolean vizjs = false;

  /**
   * Limit the degree of separation (1 shows less, 2 is default), 1 is a good option for large databases with
   * lots of relationships.
   */
  @Parameter(property = "degree", defaultValue = "2")
  protected int degree = 2;

  /**
   * Whether to create the report only on the execution root of a multi-module project.
   *
   * @since 5.0.4
   */
  @Parameter(property = "runOnExecutionRoot", defaultValue = "false")
  protected boolean runOnExecutionRoot = false;

  /** The output directory for the intermediate report. */
  @Parameter(property = "targetDirectory", defaultValue = "${project.build.directory}")
  private File targetDirectory;

  /** The name of the database being analysed. */
  @Parameter(property = "database", required = true)
  private String database;

  /** The host address of the database being analysed. */
  @Parameter(property = "host")
  private String host;

  /** The port, required by some drivers. */
  @Parameter(property = "port")
  private String port;

  /** The type of database being analysed — defaults to ora. */
  @Parameter(property = "databaseType")
  private String databaseType;

  /** Connect to the database with this user id. */
  @Parameter(property = "user")
  private String user;

  /** Database schema to use — defaults to the specified user. */
  @Parameter(property = "schema")
  private String schema;

  /** Database password to use — defaults to none. */
  @Parameter(property = "password")
  private String password;

  /**
   * If specified, SchemaSpy will look for JDBC drivers on this path, rather than using the
   * application classpath. Useful if your database has a non-O/S driver not bundled with the
   * plugin.
   */
  @Parameter(property = "pathToDrivers")
  private String pathToDrivers;

  /**
   * Schema description. Displays the specified textual description on summary pages. If your
   * description includes an equals sign then escape it with a backslash. NOTE: This field doesn't
   * seem to be used by SchemaSpy in the current version.
   */
  @Parameter(property = "schemaDescription")
  private String schemaDescription;

  /**
   * Only include matching tables/views. This is a regular expression that's used to determine which
   * tables/views to include. For example: -i "(.*book.*)|(library.*)" includes only those
   * tables/views with 'book' in their names or that start with 'library'. You might want to use
   * "description" with this option to describe the subset of tables.
   */
  @Parameter(property = "includeTableNamesRegex")
  private String includeTableNamesRegex;

  /**
   * Exclude matching columns from relationship analysis to simplify the generated graphs. This is a
   * regular expression that's used to determine which columns to exclude. It must match table name,
   * followed by a dot, followed by column name. For example: -x "(book.isbn)|(borrower.address)"
   * Note that each column name regular expression must be surrounded by ()'s and separated from other
   * column names by a |.
   */
  @Parameter(property = "excludeColumnNamesRegex")
  private String excludeColumnNamesRegex;

  /**
   * Allow HTML In Comments. Any HTML embedded in comments normally gets encoded so that it's
   * rendered as text. This option allows it to be rendered as HTML.
   */
  @Parameter(property = "allowHtmlInComments")
  private Boolean allowHtmlInComments;

  /**
   * Comments Initially Displayed. Column comments are normally hidden by default. This option
   * displays them by default.
   *
   * @deprecated this seems to no longer be a supported option in SchemaSpy
   */
  @Deprecated
  @Parameter(property = "commentsInitiallyDisplayed")
  private Boolean commentsInitiallyDisplayed;

  /** Don't include implied foreign key relationships in the generated table details. */
  @Parameter(property = "noImplied")
  private Boolean noImplied;

  /** Only generate files needed for insertion/deletion of data (e.g. for scripts). */
  @Parameter(property = "noHtml")
  private Boolean noHtml;

  /** Detail of execution logging. */
  @Parameter(property = "logLevel")
  private String logLevel;

  /**
   * Some databases, like Derby, will crash if you use the old driver object to establish a
   * connection (eg "connection = driver.connect(...)"). In this case, set useDriverManager to true
   * to use the DriverManager.getConnection() method instead (eg "connection =
   * java.sql.DriverManager.getConnection(...)"). Other databases (e.g. MySQL) seem to only work with
   * the first method, so don't use this parameter unless you have to.
   */
  @Parameter(property = "useDriverManager")
  private Boolean useDriverManager;

  /** The CSS Stylesheet. Allows you to override the default SchemaSpyCSS stylesheet. */
  @Parameter(property = "cssStylesheet")
  private String cssStylesheet;

  /**
   * Single Sign-On. Don't require a user to be specified with -user to simplify configuration when
   * running in a single sign-on environment.
   */
  @Parameter(property = "singleSignOn")
  private Boolean singleSignOn;

  /**
   * Generate lower-quality diagrams. Various installations of Graphviz (depending on OS and/or
   * version) will default to generating either higher or lower quality images. That is, some might
   * not have the "lower quality" libraries and others might not have the "higher quality"
   * libraries.
   */
  @Parameter(property = "lowQuality")
  private Boolean lowQuality;

  /**
   * Generate higher-quality diagrams. Various installations of Graphviz (depending on OS and/or
   * version) will default to generating either higher or lower quality images. That is, some might
   * not have the "lower quality" libraries and others might not have the "higher quality"
   * libraries.
   */
  @Parameter(property = "highQuality")
  private Boolean highQuality;

  /**
   * Evaluate all schemas in a database. Generates a high-level index of the schemas evaluated and
   * allows for traversal of cross-schema foreign key relationships. Use with -schemaSpec
   * "schemaRegularExpression" to narrow-down the schemas to include.
   */
  @Parameter(property = "showAllSchemas")
  private Boolean showAllSchemas;

  /**
   * Evaluate specified schemas. Similar to -showAllSchemas, but explicitly specifies which schema
   * to evaluate without interrogating the database's metadata. Can be used with databases like
   * MySQL where a database isn't composed of multiple schemas.
   */
  @Parameter(property = "schemas")
  private String schemas;

  /** No schema required for this database (e.g. derby). */
  @Parameter(property = "noSchema")
  private Boolean noSchema;

  /** Don't query or display row counts. */
  @Parameter(property = "noRows")
  private Boolean noRows;

  /** Don't query or display row counts. */
  @Parameter(property = "noViews")
  private Boolean noViews;

  /**
   * Specifies additional properties to be used when connecting to the database. Specify the entries
   * directly, escaping the ='s with \= and separating each key\=value pair with a ;.
   *
   * <p>May also be a file name, useful for hiding connection properties from public logs.
   */
  @Parameter(property = "connprops")
  private String connprops;

  /**
   * Don't generate ads in reports.
   *
   * @deprecated will be removed
   */
  @Deprecated
  @Parameter(property = "noAds", defaultValue = "true")
  private Boolean noAds;

  /**
   * Don't generate sourceforge logos in reports.
   *
   * @deprecated will be removed
   */
  @Deprecated
  @Parameter(property = "noLogo", defaultValue = "true")
  private Boolean noLogo;

  @Parameter(property = "catalog", defaultValue = "%")
  private String catalog;

  /**
   * The SchemaSpy analyser that generates the actual report. Can be overridden for testing
   * purposes.
   */
  private MavenSchemaAnalyzer analyzer;

  protected void setSchemaAnalyzer(final MavenSchemaAnalyzer analyzer) {
    this.analyzer = analyzer;
  }

  /**
   * Convenience method used to build the SchemaSpy command line parameters.
   *
   * @param argList the current list of SchemaSpy parameter options.
   * @param parameter a new parameter to add
   * @param value the value for this parameter
   */
  private void addToArguments(
      final List<String> argList, final String parameter, final Boolean value) {
    if (value != null && value) {
      argList.add(parameter);
      argList.add(String.valueOf(true));
    }
  }

  /**
   * Convenience method used to build the SchemaSpy command line parameters.
   *
   * @param argList the current list of SchemaSpy parameter options.
   * @param parameter a new parameter to add
   * @param value the value for this parameter
   */
  private void addFlagToArguments(
      final List<String> argList, final String parameter, final Boolean value) {
    if (value != null && value) {
      argList.add(parameter);
    }
  }

  /**
   * Convenience method used to build the SchemaSpy command line parameters.
   *
   * @param argList the current list of SchemaSpy parameter options.
   * @param parameter a new parameter to add
   * @param value the value for this parameter
   */
  private void addToArguments(
      final List<String> argList, final String parameter, final String value) {
    if (value != null) {
      argList.add(parameter);
      argList.add(value);
    }
  }

  /**
   * Generate the SchemaSpy report.
   *
   * @throws MavenReportException if SchemaSpy crashes
   * @param locale the language of the report — currently ignored.
   */
  @Override
  protected void executeReport(final Locale locale) throws MavenReportException {
    File outputDir;
    if (outputDirectory == null) {
      // targetDirectory should be set by the maven framework. This is just for unit testing
      // purposes
      if (targetDirectory == null) {
        targetDirectory = new File("target");
      }
      File siteDir = new File(targetDirectory, "site");
      outputDir = new File(siteDir, "schemaspy");
    } else {
      outputDir = new File(outputDirectory, "schemaspy");
    }
    outputDir.mkdirs();

    String schemaSpyDirectory = outputDir.getAbsolutePath();
    getLog().debug("SchemaSpy output directory: " + schemaSpyDirectory);

    List<String> argList = new ArrayList<>();

    addToArguments(argList, "-dp", pathToDrivers);
    addToArguments(argList, "-db", database);
    addToArguments(argList, "-host", host);
    addToArguments(argList, "-port", port);
    addToArguments(argList, "-t", databaseType);
    addToArguments(argList, "-u", user);
    addToArguments(argList, "-p", password);
    if (null != schema && schema.contains(",")) {
      addToArguments(argList, "-schemas", schema);
    } else {
      addToArguments(argList, "-s", schema);
    }
    addToArguments(argList, "-o", schemaSpyDirectory);
    addToArguments(argList, "-desc", schemaDescription);
    addToArguments(argList, "-i", includeTableNamesRegex);
    addToArguments(argList, "-x", excludeColumnNamesRegex);
    addFlagToArguments(argList, "-ahic", allowHtmlInComments);
    addFlagToArguments(argList, "-noimplied", noImplied);
    addFlagToArguments(argList, "-nohtml", noHtml);
    addToArguments(argList, "-loglevel", logLevel);
    addFlagToArguments(argList, "-norows", noRows);
    addFlagToArguments(argList, "-noviews", noViews);
    addFlagToArguments(argList, "-noschema", noSchema);
    addFlagToArguments(argList, "-all", showAllSchemas);
    addToArguments(argList, "-schemas", schemas);
    addToArguments(argList, "-useDriverManager", useDriverManager);
    addToArguments(argList, "-css", cssStylesheet);
    addFlagToArguments(argList, "-sso", singleSignOn);
    addFlagToArguments(argList, "-lq", lowQuality);
    addFlagToArguments(argList, "-hq", highQuality);
    addToArguments(argList, "-connprops", connprops);
    addFlagToArguments(argList, "-cid", commentsInitiallyDisplayed);
    addFlagToArguments(argList, "-noads", noAds);
    addFlagToArguments(argList, "-nologo", noLogo);
    addToArguments(argList, "-cat", catalog);
    addFlagToArguments(argList, "-vizjs", vizjs);
    addToArguments(argList, "-degree", String.valueOf(degree));
    if (getLog().isDebugEnabled()) {
      addFlagToArguments(argList, "-debug", true);
    }
    getLog().debug("SchemaSpy arguments: " + argList);

    try {
      if (analyzer == null) {
        analyzer = new MavenSchemaAnalyzer();
      }
      analyzer.applyConfiguration(argList);
      analyzer.analyze();
    } catch (Exception e) {
      throw new MavenReportException(e.getMessage(), e);
    }
  }

  @Override
  public boolean canGenerateReport() {
    return !runOnExecutionRoot || project.isExecutionRoot();
  }

  @Override
  public String getDescription(final Locale locale) {
    return "SchemaSpy database documentation";
  }

  @Override
  public String getName(final Locale locale) {
    return "SchemaSpy";
  }

  /**
   * @deprecated use {@link #getOutputPath()} instead.
   * @return the output path of the report
   */
  @Override
  @Deprecated (since = "4.0.0")
  public String getOutputName() {
    return this.getOutputPath();
  }

  @Override
  public String getOutputPath() {
    return "schemaspy/index";
  }

  /**
   * Always return {@code true} as we're using the report generated by SchemaSpy rather than
   * creating our own report.
   *
   * @return {@code true}
   */
  @Override
  public boolean isExternalReport() {
    return true;
  }
}

1	package com.wakaleo.schemaspy;
2
3	import java.io.File;
4	import java.util.ArrayList;
5	import java.util.List;
6	import java.util.Locale;
7	import org.apache.maven.plugins.annotations.LifecyclePhase;
8	import org.apache.maven.plugins.annotations.Mojo;
9	import org.apache.maven.plugins.annotations.Parameter;
10	import org.apache.maven.reporting.AbstractMavenReport;
11	import org.apache.maven.reporting.MavenReportException;
12
13	/**
14	* The SchemaSpy Maven plugin report.
15	*
16	* <p>This plugin is designed to generate SchemaSpy report for a Maven website. SchemaSpy also may
17	* need the Graphviz tool (https://www.graphviz.org/) in order to generate graphical representations
18	* of the table/view relationships, so this needs to be installed on your machine.
19	*
20	* <p>The SchemaSpy goal invokes the SchemaSpy command-line tool. SchemaSpy generates a graphical
21	* and HTML report describing a given relational database.
22	*
23	* @author John Smart
24	* @author mprins
25	*/
26	@Mojo(name = "schemaspy", defaultPhase = LifecyclePhase.SITE)
27	public class SchemaSpyReport extends AbstractMavenReport {	2✔
28
29	@Parameter(property = "vizjs", defaultValue = "true")	2✔
30	protected boolean vizjs = false;
31
32	/**
33	* Limit the degree of separation (1 shows less, 2 is default), 1 is a good option for large databases with
34	* lots of relationships.
35	*/
36	@Parameter(property = "degree", defaultValue = "2")	2✔
37	protected int degree = 2;
38
39	/**
40	* Whether to create the report only on the execution root of a multi-module project.
41	*
42	* @since 5.0.4
43	*/
44	@Parameter(property = "runOnExecutionRoot", defaultValue = "false")	2✔
45	protected boolean runOnExecutionRoot = false;
46
47	/** The output directory for the intermediate report. */
48	@Parameter(property = "targetDirectory", defaultValue = "${project.build.directory}")
49	private File targetDirectory;
50
51	/** The name of the database being analysed. */
52	@Parameter(property = "database", required = true)
53	private String database;
54
55	/** The host address of the database being analysed. */
56	@Parameter(property = "host")
57	private String host;
58
59	/** The port, required by some drivers. */
60	@Parameter(property = "port")
61	private String port;
62
63	/** The type of database being analysed — defaults to ora. */
64	@Parameter(property = "databaseType")
65	private String databaseType;
66
67	/** Connect to the database with this user id. */
68	@Parameter(property = "user")
69	private String user;
70
71	/** Database schema to use — defaults to the specified user. */
72	@Parameter(property = "schema")
73	private String schema;
74
75	/** Database password to use — defaults to none. */
76	@Parameter(property = "password")
77	private String password;
78
79	/**
80	* If specified, SchemaSpy will look for JDBC drivers on this path, rather than using the
81	* application classpath. Useful if your database has a non-O/S driver not bundled with the
82	* plugin.
83	*/
84	@Parameter(property = "pathToDrivers")
85	private String pathToDrivers;
86
87	/**
88	* Schema description. Displays the specified textual description on summary pages. If your
89	* description includes an equals sign then escape it with a backslash. NOTE: This field doesn't
90	* seem to be used by SchemaSpy in the current version.
91	*/
92	@Parameter(property = "schemaDescription")
93	private String schemaDescription;
94
95	/**
96	* Only include matching tables/views. This is a regular expression that's used to determine which
97	* tables/views to include. For example: -i "(.book.)\|(library.*)" includes only those
98	* tables/views with 'book' in their names or that start with 'library'. You might want to use
99	* "description" with this option to describe the subset of tables.
100	*/
101	@Parameter(property = "includeTableNamesRegex")
102	private String includeTableNamesRegex;
103
104	/**
105	* Exclude matching columns from relationship analysis to simplify the generated graphs. This is a
106	* regular expression that's used to determine which columns to exclude. It must match table name,
107	* followed by a dot, followed by column name. For example: -x "(book.isbn)\|(borrower.address)"
108	* Note that each column name regular expression must be surrounded by ()'s and separated from other
109	* column names by a \|.
110	*/
111	@Parameter(property = "excludeColumnNamesRegex")
112	private String excludeColumnNamesRegex;
113
114	/**
115	* Allow HTML In Comments. Any HTML embedded in comments normally gets encoded so that it's
116	* rendered as text. This option allows it to be rendered as HTML.
117	*/
118	@Parameter(property = "allowHtmlInComments")
119	private Boolean allowHtmlInComments;
120
121	/**
122	* Comments Initially Displayed. Column comments are normally hidden by default. This option
123	* displays them by default.
124	*
125	* @deprecated this seems to no longer be a supported option in SchemaSpy
126	*/
127	@Deprecated
128	@Parameter(property = "commentsInitiallyDisplayed")
129	private Boolean commentsInitiallyDisplayed;
130
131	/** Don't include implied foreign key relationships in the generated table details. */
132	@Parameter(property = "noImplied")
133	private Boolean noImplied;
134
135	/** Only generate files needed for insertion/deletion of data (e.g. for scripts). */
136	@Parameter(property = "noHtml")
137	private Boolean noHtml;
138
139	/** Detail of execution logging. */
140	@Parameter(property = "logLevel")
141	private String logLevel;
142
143	/**
144	* Some databases, like Derby, will crash if you use the old driver object to establish a
145	* connection (eg "connection = driver.connect(...)"). In this case, set useDriverManager to true
146	* to use the DriverManager.getConnection() method instead (eg "connection =
147	* java.sql.DriverManager.getConnection(...)"). Other databases (e.g. MySQL) seem to only work with
148	* the first method, so don't use this parameter unless you have to.
149	*/
150	@Parameter(property = "useDriverManager")
151	private Boolean useDriverManager;
152
153	/** The CSS Stylesheet. Allows you to override the default SchemaSpyCSS stylesheet. */
154	@Parameter(property = "cssStylesheet")
155	private String cssStylesheet;
156
157	/**
158	* Single Sign-On. Don't require a user to be specified with -user to simplify configuration when
159	* running in a single sign-on environment.
160	*/
161	@Parameter(property = "singleSignOn")
162	private Boolean singleSignOn;
163
164	/**
165	* Generate lower-quality diagrams. Various installations of Graphviz (depending on OS and/or
166	* version) will default to generating either higher or lower quality images. That is, some might
167	* not have the "lower quality" libraries and others might not have the "higher quality"
168	* libraries.
169	*/
170	@Parameter(property = "lowQuality")
171	private Boolean lowQuality;
172
173	/**
174	* Generate higher-quality diagrams. Various installations of Graphviz (depending on OS and/or
175	* version) will default to generating either higher or lower quality images. That is, some might
176	* not have the "lower quality" libraries and others might not have the "higher quality"
177	* libraries.
178	*/
179	@Parameter(property = "highQuality")
180	private Boolean highQuality;
181
182	/**
183	* Evaluate all schemas in a database. Generates a high-level index of the schemas evaluated and
184	* allows for traversal of cross-schema foreign key relationships. Use with -schemaSpec
185	* "schemaRegularExpression" to narrow-down the schemas to include.
186	*/
187	@Parameter(property = "showAllSchemas")
188	private Boolean showAllSchemas;
189
190	/**
191	* Evaluate specified schemas. Similar to -showAllSchemas, but explicitly specifies which schema
192	* to evaluate without interrogating the database's metadata. Can be used with databases like
193	* MySQL where a database isn't composed of multiple schemas.
194	*/
195	@Parameter(property = "schemas")
196	private String schemas;
197
198	/** No schema required for this database (e.g. derby). */
199	@Parameter(property = "noSchema")
200	private Boolean noSchema;
201
202	/** Don't query or display row counts. */
203	@Parameter(property = "noRows")
204	private Boolean noRows;
205
206	/** Don't query or display row counts. */
207	@Parameter(property = "noViews")
208	private Boolean noViews;
209
210	/**
211	* Specifies additional properties to be used when connecting to the database. Specify the entries
212	* directly, escaping the ='s with \= and separating each key\=value pair with a ;.
213	*
214	* <p>May also be a file name, useful for hiding connection properties from public logs.
215	*/
216	@Parameter(property = "connprops")
217	private String connprops;
218
219	/**
220	* Don't generate ads in reports.
221	*
222	* @deprecated will be removed
223	*/
224	@Deprecated
225	@Parameter(property = "noAds", defaultValue = "true")
226	private Boolean noAds;
227
228	/**
229	* Don't generate sourceforge logos in reports.
230	*
231	* @deprecated will be removed
232	*/
233	@Deprecated
234	@Parameter(property = "noLogo", defaultValue = "true")
235	private Boolean noLogo;
236
237	@Parameter(property = "catalog", defaultValue = "%")
238	private String catalog;
239
240	/**
241	* The SchemaSpy analyser that generates the actual report. Can be overridden for testing
242	* purposes.
243	*/
244	private MavenSchemaAnalyzer analyzer;
245
246	protected void setSchemaAnalyzer(final MavenSchemaAnalyzer analyzer) {
247	this.analyzer = analyzer;	2✔
248	}	2✔
249
250	/**
251	* Convenience method used to build the SchemaSpy command line parameters.
252	*
253	* @param argList the current list of SchemaSpy parameter options.
254	* @param parameter a new parameter to add
255	* @param value the value for this parameter
256	*/
257	private void addToArguments(
258	final List<String> argList, final String parameter, final Boolean value) {
259	if (value != null && value) {	2!
260	argList.add(parameter);	×
261	argList.add(String.valueOf(true));	×
262	}
263	}	2✔
264
265	/**
266	* Convenience method used to build the SchemaSpy command line parameters.
267	*
268	* @param argList the current list of SchemaSpy parameter options.
269	* @param parameter a new parameter to add
270	* @param value the value for this parameter
271	*/
272	private void addFlagToArguments(
273	final List<String> argList, final String parameter, final Boolean value) {
274	if (value != null && value) {	2✔
275	argList.add(parameter);	2✔
276	}
277	}	2✔
278
279	/**
280	* Convenience method used to build the SchemaSpy command line parameters.
281	*
282	* @param argList the current list of SchemaSpy parameter options.
283	* @param parameter a new parameter to add
284	* @param value the value for this parameter
285	*/
286	private void addToArguments(
287	final List<String> argList, final String parameter, final String value) {
288	if (value != null) {	2✔
289	argList.add(parameter);	2✔
290	argList.add(value);	2✔
291	}
292	}	2✔
293
294	/**
295	* Generate the SchemaSpy report.
296	*
297	* @throws MavenReportException if SchemaSpy crashes
298	* @param locale the language of the report — currently ignored.
299	*/
300	@Override
301	protected void executeReport(final Locale locale) throws MavenReportException {
302	File outputDir;
303	if (outputDirectory == null) {	2!
304	// targetDirectory should be set by the maven framework. This is just for unit testing
305	// purposes
306	if (targetDirectory == null) {	×
307	targetDirectory = new File("target");	×
308	}
309	File siteDir = new File(targetDirectory, "site");	×
310	outputDir = new File(siteDir, "schemaspy");	×
311	} else {	×
312	outputDir = new File(outputDirectory, "schemaspy");	2✔
313	}
314	outputDir.mkdirs();	2✔
315
316	String schemaSpyDirectory = outputDir.getAbsolutePath();	2✔
317	getLog().debug("SchemaSpy output directory: " + schemaSpyDirectory);	2✔
318
319	List<String> argList = new ArrayList<>();	2✔
320
321	addToArguments(argList, "-dp", pathToDrivers);	2✔
322	addToArguments(argList, "-db", database);	2✔
323	addToArguments(argList, "-host", host);	2✔
324	addToArguments(argList, "-port", port);	2✔
325	addToArguments(argList, "-t", databaseType);	2✔
326	addToArguments(argList, "-u", user);	2✔
327	addToArguments(argList, "-p", password);	2✔
328	if (null != schema && schema.contains(",")) {	2!
329	addToArguments(argList, "-schemas", schema);	×
330	} else {
331	addToArguments(argList, "-s", schema);	2✔
332	}
333	addToArguments(argList, "-o", schemaSpyDirectory);	2✔
334	addToArguments(argList, "-desc", schemaDescription);	2✔
335	addToArguments(argList, "-i", includeTableNamesRegex);	2✔
336	addToArguments(argList, "-x", excludeColumnNamesRegex);	2✔
337	addFlagToArguments(argList, "-ahic", allowHtmlInComments);	2✔
338	addFlagToArguments(argList, "-noimplied", noImplied);	2✔
339	addFlagToArguments(argList, "-nohtml", noHtml);	2✔
340	addToArguments(argList, "-loglevel", logLevel);	2✔
341	addFlagToArguments(argList, "-norows", noRows);	2✔
342	addFlagToArguments(argList, "-noviews", noViews);	2✔
343	addFlagToArguments(argList, "-noschema", noSchema);	2✔
344	addFlagToArguments(argList, "-all", showAllSchemas);	2✔
345	addToArguments(argList, "-schemas", schemas);	2✔
346	addToArguments(argList, "-useDriverManager", useDriverManager);	2✔
347	addToArguments(argList, "-css", cssStylesheet);	2✔
348	addFlagToArguments(argList, "-sso", singleSignOn);	2✔
349	addFlagToArguments(argList, "-lq", lowQuality);	2✔
350	addFlagToArguments(argList, "-hq", highQuality);	2✔
351	addToArguments(argList, "-connprops", connprops);	2✔
352	addFlagToArguments(argList, "-cid", commentsInitiallyDisplayed);	2✔
353	addFlagToArguments(argList, "-noads", noAds);	2✔
354	addFlagToArguments(argList, "-nologo", noLogo);	2✔
355	addToArguments(argList, "-cat", catalog);	2✔
356	addFlagToArguments(argList, "-vizjs", vizjs);	2✔
357	addToArguments(argList, "-degree", String.valueOf(degree));	2✔
358	if (getLog().isDebugEnabled()) {	2!
359	addFlagToArguments(argList, "-debug", true);	×
360	}
361	getLog().debug("SchemaSpy arguments: " + argList);	2✔
362
363	try {
364	if (analyzer == null) {	2✔
365	analyzer = new MavenSchemaAnalyzer();	2✔
366	}
367	analyzer.applyConfiguration(argList);	2✔
368	analyzer.analyze();	2✔
369	} catch (Exception e) {	×
370	throw new MavenReportException(e.getMessage(), e);	×
371	}	2✔
372	}	2✔
373
374	@Override
375	public boolean canGenerateReport() {
376	return !runOnExecutionRoot \|\| project.isExecutionRoot();	×
377	}
378
379	@Override
380	public String getDescription(final Locale locale) {
381	return "SchemaSpy database documentation";	×
382	}
383
384	@Override
385	public String getName(final Locale locale) {
386	return "SchemaSpy";	×
387	}
388
389	/**
390	* @deprecated use {@link #getOutputPath()} instead.
391	* @return the output path of the report
392	*/
393	@Override
394	@Deprecated (since = "4.0.0")
395	public String getOutputName() {
NEW 396	return this.getOutputPath();	×
397	}
398
399	@Override
400	public String getOutputPath() {
401	return "schemaspy/index";	×
402	}
403
404	/**
405	* Always return {@code true} as we're using the report generated by SchemaSpy rather than
406	* creating our own report.
407	*
408	* @return {@code true}
409	*/
410	@Override
411	public boolean isExternalReport() {
412	return true;	×
413	}
414	}

GeoDienstenCentrum / schemaspy-maven-plugin / 1618

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous