Skip to content

Commit

Permalink
Final review
Browse files Browse the repository at this point in the history
  • Loading branch information
javiertuya committed Jul 27, 2023
1 parent 9ef1db6 commit 501f66e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This is an example of the summary report of a test session:
Example for Java:

- Add the dependency
[`qacover-core`](https://central.sonatype.com/artifact/io.github.giis-uniovi/qacover-core/1.5.0/overview) to your pom.xml
[`qacover-core`](https://central.sonatype.com/artifact/io.github.giis-uniovi/qacover-core) to your pom.xml
- Copy the files
[`qacover.properties`](qacover-core/qacover.properties) and
[`spy.properties`](qacover-core/spy.properties) from the `qacover-core` folder to the root of your project.
Expand All @@ -59,11 +59,10 @@ To generate an html report:
- Download the *the standalone reporter jar file*
[`qacover-model-<VERSION>-report.jar`](https://central.sonatype.com/artifact/io.github.giis-uniovi/qacover-model)
from Maven Central (go to Versions and then Browse the selected version to download).
- Run
- Run this command from the root of your workspace:
```bash
java -jar qacover-model-<VERSION>-report.jar target/qacover/rules target/qacover/reports
```
from the root of your workspace.
- Open the `index.html` that you will found in the `target/qacover/reports` folder.

If you find that the class names are not the ones at the interaction point that executes the query,
Expand Down Expand Up @@ -98,15 +97,15 @@ There are two different artifacts:
Each of them has another downloadable jar that includes additional qualifier:

- [`qacover-core` uber jar](https://central.sonatype.com/artifact/io.github.giis-uniovi/qacover-core).
It includes all needed dependencies (excluding `slf4j``) and they are *shaded*
It includes all needed dependencies (excluding `slf4j`) and they are *shaded*
(i.e. renamed in a different namespace to avoid dependency conflicts):
- Download the artifact with the `-uber` qualifier if for any reason you cannot use it as a dependency in your application
(e.g. to deploy in an application server).
You simply need to put the jar in your server library and set the configuration to use QACover.
- Use the uber jar as a dependency declared in your pom.xml if you experiment conflicts with versions:
Add `<qualifier>uber</qualifier>` to the dependency declaration.
- [`qacover-model` standalone reporter](https://central.sonatype.com/artifact/io.github.giis-uniovi/qacover-model):
Download the artifact with the `-report` qualifier to generate the reports from the command line as shown in the [quick start].(#quick-start)
Download the artifact with the `-report` qualifier to generate the reports from the command line as shown in the [quick start](#quick-start).

### .NET Packages in NuGet

Expand Down Expand Up @@ -140,7 +139,7 @@ inclusion and exclusion criteria.

When a line of a method in your application executes a SQL query (*interaction point*),
a chain of calls to methods of your framework
is executed until the reaching driver method that actually executes the query.
is executed until reaching the driver method that actually executes the query.
Here is the point in which the actual execution of the query is detected,
but what we want is to determine the interaction point in the application.
To achieve this, QACover checks the call stack at the point of the actual execution
Expand Down
6 changes: 3 additions & 3 deletions qacover-core/qacover.properties
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@

# Root folder
# Default: project folder (java) or solution folder (.NET)
qacover.store.root=.
# qacover.store.root=.

# Folder to store the generated rules (relative to the root folder)
# Default: target/qacover/rules (java), reports/qacover/rules (.NET)
qacover.store.rules=target/qacover/rules
# qacover.store.rules=target/qacover/rules

# Folder to store the generated reports (relative to the root folder)
# Default: target/qacover/reports (java), reports/qacover/reports (.NET)
qacover.store.reports=target/qacover/reports
# qacover.store.reports=target/qacover/reports

# Prefix of the packages/classes that must be ignored to detect the
# interaction point (class, method and line in the application that executes the query)
Expand Down

0 comments on commit 501f66e

Please sign in to comment.