Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Version info and info command in cli #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pesse merged 11 commits into from
Jun 13, 2018
Merged

Version info and info command in cli #87

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
fbbef6d
Minimal viable (and ugly) solution to add version info to cli
pesse May 31, 2018
2772add
First set of refactorings around ConnectionInfo
pesse Jun 5, 2018
457625d
Refactoring around commands.
pesse Jun 5, 2018
3236087
Improved tests for VersionInfoCommand
pesse Jun 7, 2018
6326514
Updated help
pesse Jun 7, 2018
feff4a3
Added another command: reporters <ConnectionUrl>
pesse Jun 7, 2018
52d4368
Added documentation
pesse Jun 7, 2018
808a2d6
Some improvements to documentation
pesse Jun 8, 2018
554c71b
Refactoring of ReportersCommand
pesse Jun 12, 2018
93c8e5d
Some more minor refactoring
pesse Jun 12, 2018
d402718
Switch table-like to 4-space intendation
pesse Jun 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added documentation
  • Loading branch information
@pesse
pesse committed Jun 7, 2018
commit 52d4368d16d79f38ae05663cfb6d27bc7146b2c7
75 changes: 65 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ The charset-part of LC_ALL is ignored.
Currently, utPLSQL-cli knows the following commands:
Copy link
Copy Markdown
Member

@jgebal jgebal Jun 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Supports souds better than knows

Copy link
Copy Markdown
Member Author

@pesse pesse Jun 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, thanks

- run
- info
- reporters

### run
`utplsql run <ConnectionURL> [<options>]`
Expand All @@ -68,7 +69,7 @@ Currently, utPLSQL-cli knows the following commands:

-f=format - A reporter to be used for reporting.
If no -f option is provided, the default ut_documentation_reporter is used.
See reporters list for possible values
See reporters command for possible values
-o=output - Defines file name to save the output from the specified reporter.
If defined, the output is not displayed on screen by default. This can be changed with the -s parameter.
If not defined, then output will be displayed on screen, even if the parameter -s is not specified.
Expand Down Expand Up @@ -115,7 +116,7 @@ Sonar and Coveralls reporter will only provide valid reports, when source_path a
#### Examples

```
utplsql run hr/hr@xe -p=hr_test -f=ut_documentation_reporter -o=run.log -s -f=ut_coverage_html_reporter -o=coverage.html -source_path=source
> utplsql run hr/hr@xe -p=hr_test -f=ut_documentation_reporter -o=run.log -s -f=ut_coverage_html_reporter -o=coverage.html -source_path=source
```

Invokes all Unit tests from schema/package "hr_test" with two reporters:
Expand All @@ -124,7 +125,7 @@ Invokes all Unit tests from schema/package "hr_test" with two reporters:
* ut_coverage_html_reporter - will report only on database objects that are mapping to file structure from "source" folder and save output to file "coverage.html"

```
utplsql run hr/hr@xe
> utplsql run hr/hr@xe
```

Invokes all unit test suites from schema "hr". Results are displayed to screen using default ut_documentation_reporter.
Expand All @@ -145,19 +146,73 @@ Invokes all unit test suites from schema "hr". Results are displayed to screen u
#### Examples

```
utplsql info
> utplsql info

> cli 3.1.1-SNAPSHOT.local
> utPLSQL-java-api 3.1.1-SNAPSHOT.123
cli 3.1.1-SNAPSHOT.local
utPLSQL-java-api 3.1.1-SNAPSHOT.123
```
```
utplsql info app/app@localhost:1521/ORCLPDB1
> utplsql info app/app@localhost:1521/ORCLPDB1

> cli 3.1.1-SNAPSHOT.local
> utPLSQL-java-api 3.1.1-SNAPSHOT.123
> utPLSQL 3.1.2.1913
cli 3.1.1-SNAPSHOT.local
utPLSQL-java-api 3.1.1-SNAPSHOT.123
utPLSQL 3.1.2.1913
```

### reporters
`utplsql info <ConnectionURL>`
Copy link
Copy Markdown
Member

@jgebal jgebal Jun 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it info or reporters ?
The examples show different command.

Copy link
Copy Markdown
Member Author

@pesse pesse Jun 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was definitely too late :) Thanks for finding - it's reporters


```
<ConnectionURL> - accepted formats:
<user>/<password>@//<host>[:<port>]/<service>
<user>/<password>@<host>:<port>:<SID>
<user>/<password>@<TNSName>
To connect using TNS, you need to have the ORACLE_HOME environment variable set.
The file tnsnames.ora must exist in path %ORACLE_HOME%/network/admin
The file tnsnames.ora must contain valid TNS entries.
```

#### Examples
```
> utplsql reporters app/app@localhost:1521/ORCLPDB1

UT_COVERAGE_COBERTURA_REPORTER (SQL): Generates a Cobertura coverage report providing information on code coverage with line numbers.
Copy link
Copy Markdown
Member

@jgebal jgebal Jun 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does (SQL) / (SQL_with_Java) mean?
I find it confusing.
Do we need some extra actions for one or another?

Copy link
Copy Markdown
Member Author

@pesse pesse Jun 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the concept needs more explanation, still struggling of how to do so.
With 3.1.0 ReporterFactory in cli/java-api you can have

  • Reporters solely implemented on the database (most core reporters) -> SQL
  • Reporters solely implemented on the client. You could for example write a Reporter which uses ut_documentation_reporter internally but modifies the output excessively and is registered via a different name (so not overwriting ut_documentation_reporter but just using it internally). -> JAVA
  • Reporters who are implemented on the database but also have some kind of addition on the client. Best example is the ut_coverage_html_reporter: It's basically the database implemented reporter but has this client-side addition that the assets are written to a specific folder. -> SQL_WITH_JAVA

Copy link
Copy Markdown
Member

@jgebal jgebal Jun 8, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think users can implement reporters in cli.
We (as dev team) would have to do that.
I would refrain from implementing reporters (based on existing PLSQL reporters) in java.

Can you remove that info?
I'd like to avoid questions/confusinon from users.

If needed, we can add this info to documentation.
The comment seems a good explanation.

Designed for Jenkins and TFS to report coverage.
Cobertura Document Type Definition can be found: http://cobertura.sourceforge.net/xml/coverage-04.dtd.
Sample file: https://github.com/leobalter/testing-examples/blob/master/solutions/3/report/cobertura-coverage.xml.

UT_COVERAGE_HTML_REPORTER (SQL_WITH_JAVA): Generates a HTML coverage report with summary and line by line information on code coverage.
Based on open-source simplecov-html coverage reporter for Ruby.
Includes source code in the report.
Will copy all necessary assets to a folder named after the Output-File

UT_COVERAGE_SONAR_REPORTER (SQL): Generates a JSON coverage report providing information on code coverage with line numbers.
Designed for [SonarQube](https://about.sonarqube.com/) to report coverage.
JSON format returned conforms with the Sonar specification: https://docs.sonarqube.org/display/SONAR/Generic+Test+Data

UT_COVERALLS_REPORTER (SQL): Generates a JSON coverage report providing information on code coverage with line numbers.
Designed for [Coveralls](https://coveralls.io/).
JSON format conforms with specification: https://docs.coveralls.io/api-introduction

UT_DOCUMENTATION_REPORTER (SQL_WITH_JAVA): A textual pretty-print of unit test results (usually use for console output)
Provides additional properties lvl and failed

UT_JUNIT_REPORTER (SQL): Provides outcomes in a format conforming with JUnit 4 and above as defined in: https://gist.github.com/kuzuha/232902acab1344d6b578

UT_SONAR_TEST_REPORTER (SQL): Generates a JSON report providing detailed information on test execution.
Designed for [SonarQube](https://about.sonarqube.com/) to report test execution.
JSON format returned conforms with the Sonar specification: https://docs.sonarqube.org/display/SONAR/Generic+Test+Data

UT_TEAMCITY_REPORTER (SQL): Provides the TeamCity (a CI server by jetbrains) reporting-format that allows tracking of progress of a CI step/task as it executes.
https://confluence.jetbrains.com/display/TCD9/Build+Script+Interaction+with+TeamCity

UT_TFS_JUNIT_REPORTER (SQL): Provides outcomes in a format conforming with JUnit version for TFS / VSTS.
As defined by specs :https://docs.microsoft.com/en-us/vsts/build-release/tasks/test/publish-test-results?view=vsts
Version is based on windy road junit https://github.com/windyroad/JUnit-Schema/blob/master/JUnit.xsd.

UT_XUNIT_REPORTER (SQL): Depracated reporter. Please use Junit.
Provides outcomes in a format conforming with JUnit 4 and above as defined in: https://gist.github.com/kuzuha/232902acab1344d6b578
```

## Enabling Color Outputs on Windows

Expand Down