Skip to content

Commit d74cbb4

Browse files
Update README.md
1 parent 37d4591 commit d74cbb4

1 file changed

Lines changed: 94 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,96 @@
11
# utPLSQL-maven-plugin
22
A maven plugin for running Unit Tests with utPLSQL v3+
3+
4+
5+
### Configuration
6+
7+
* `url`
8+
* URL of the Connection to the database
9+
* Default: `jdbc:oracle:thin:@localhost:1521:ut3`
10+
* `user`
11+
* Credential of the connection to the database
12+
* Default: `ut3`
13+
* `password`
14+
* Password of the connection to the database
15+
* Default: `XNtxj8eEgA6X6b6f`
16+
* `ignoreFailure`
17+
* Ignore or continue when a test fail
18+
* Default: `${maven.test.failure.ignore}`
19+
* `colorConsole`
20+
* Colors in the console
21+
* `true` | `false` (default: `false`)
22+
* `skipCompatibilityCheck`
23+
* Skip the Compatibility Checks
24+
* `true` | `false` (default: `false`)
25+
* `reporters`
26+
* List of the Reporters
27+
* Enumeration:
28+
* `paths`
29+
* Paths of the resources
30+
* Default:
31+
* `sources`
32+
* Sources of the scripts at the style of the maven resources
33+
* `tests`
34+
* Test fo the scripts at the style of the maven resources
35+
* `targetDir`
36+
* Target dir, this is a readonly property
37+
* Default: `${project.build.directory}`
38+
* `includeObject`
39+
* Include Object
40+
* `excludeObject`
41+
* Exclude Objects
42+
43+
44+
45+
### Example
46+
```xml
47+
<plugin>
48+
<groupId>${pom.groupId}</groupId>
49+
<artifactId>utplsql-maven-plugin</artifactId>
50+
<version>${pom.version}</version>
51+
<goals>
52+
<goal>test</goal>
53+
</goals>
54+
<configuration>
55+
<!-- Mandatory Attributes -->
56+
<url>url_of_connection</url>
57+
<user>user</user>
58+
<password>password</password>
59+
60+
<failOnErrors>false</failOnErrors>
61+
<colorConsole>true</colorConsole>
62+
63+
<reporters>
64+
<reporter>UT_COVERAGE_SONAR_REPORTER</reporter>
65+
<reporter>UT_SONAR_TEST_REPORTER</reporter>
66+
</reporters>
67+
68+
<sources>
69+
<source>
70+
<directory>SampleDirectory</directory>
71+
<includes>
72+
<include>**/*pkg</include>
73+
<include>**/*pkb</include>
74+
</includes>
75+
</source>
76+
<source>
77+
<directory>SampleDirectory2</directory>
78+
<includes>
79+
<include>**/*pkb</include>
80+
</includes>
81+
</source>
82+
</sources>
83+
84+
<tests>
85+
<test>
86+
<directory>src/main/test/test1</directory>
87+
<includes>
88+
<include>**/*pkg</include>
89+
</includes>
90+
</test>
91+
</tests>
92+
93+
</configuration>
94+
</plugin>
95+
```
96+

0 commit comments

Comments
 (0)