Skip to content

Commit 8de19cc

Browse files
author
Jacek Gębal
committed
Small refresh of project setup scripts and documentation.
1 parent e872b30 commit 8de19cc

File tree

4 files changed

+24
-23
lines changed

4 files changed

+24
-23
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ To get started with development, follow the below steps.
5757

5858
_If you're using Windows, run the shell scripts using `GIT bash` - Windows-based bash command line._
5959

60-
**Caution**: If you are using jetBrains DataGrip, don't use the ingegrated console to run the shell scripts (not even with GIT bash configured). It might disconnect from oracle randomly during script-run.
60+
**Caution**: If you are using jetBrains DataGrip, don't use the integrated console to run the shell scripts (not even with GIT bash configured). It might disconnect from oracle randomly during script-run.
6161

6262
### Clone your fork of utPLSQL git repository
6363

@@ -94,13 +94,13 @@ export ORACLE_PWD=oracle # Adjust your local SYS password
9494

9595
The below script is fetching latest release version from utPLSQL repository. Latest release version is used for self-testing.
9696
```bash
97-
development/refresh_sources.sh
97+
./development/refresh_sources.sh
9898
```
9999

100100
### Setup local database for utPLSQL development
101101

102102
```bash
103-
development/install.sh
103+
./development/install.sh
104104
```
105105

106106
### That's it
@@ -135,18 +135,18 @@ Whenever a new version of utPLSQL or a new version of utPLSQL-cli is available,
135135

136136
utPLSQL v3 unit tests are located in the `test` directory
137137

138-
Before you push any changes and create a pull request to the utPLSQL project repository, make sure that all of the tests are executing successfully in your local environment.
138+
Before you push any changes and create a pull request to the utPLSQL project repository, make sure that all the tests are executing successfully in your local environment.
139139

140-
Every new functionality needs to be documented by unit tests that cover both happy-path scenarios as well as edge-cases and exception paths.
140+
Every new functionality needs to be documented by unit tests that cover happy-path scenarios as well as edge-cases and exception paths.
141141

142142
> **Important notice:**
143143
> We do our best to keep utPLSQL covered with unit tests.
144144
> Lack of sufficient unit testing is a perfect reason for PR to be rejected.
145145
146146
To run a full suite of unit tests execute:
147147
```bash
148-
development/env.sh
149-
test/install_and_run_tests.sh
148+
. ./development/env.sh
149+
./test/install_and_run_tests.sh
150150
```
151151

152152
You can review the results of tests as well as see information about code coverage in `./coverage.html` file.
@@ -189,18 +189,17 @@ docker build --force-rm --no-cache --squash -t oracle/db-prebuilt .
189189

190190
Travis will use your Docker Hub credentials to pull the private images, and the following secure environment variables must be defined.
191191

192-
Variable | Description
193-
---------|------------
194-
**DOCKER_USER**<br />**DOCKER_PASSWORD** | _Your Docker Hub website credentials. They will be used to pull the private database images._
192+
| Variable | Description |
193+
|------------------------------------------|-----------------------------------------------------------------------------------------------|
194+
| **DOCKER_USER**<br />**DOCKER_PASSWORD** | _Your Docker Hub website credentials. They will be used to pull the private database images._ |
195195

196196
### SQLCL
197197

198198
Our build configuration uses SQLCL to run the scripts, and you need to configure a few additional secure environment variables. After the first build, the downloaded file will be cached.
199199

200-
Variable | Description
201-
---------|------------
202-
**ORACLE_OTN_USER<br />ORACLE_OTN_PASSWORD** | _Your Oracle website credentials. They will be used to download SQLCL._
203-
200+
| Variable | Description |
201+
|----------------------------------------------|-------------------------------------------------------------------------|
202+
| **ORACLE_OTN_USER<br />ORACLE_OTN_PASSWORD** | _Your Oracle website credentials. They will be used to download SQLCL._ |
204203

205204
## New to GIT
206205

development/template.env.sh

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#!/bin/bash
22

3-
export SQLCLI=sql # For sqlcl client
4-
#export SQLCLI=sqlplus # For sqlplus client
5-
export CONNECTION_STR=127.0.0.1:1521/xe ORACLE_VERSION=11g-r2-xe# Adjust the connect string
6-
export ORACLE_PWD=oracle # Adjust your local SYS password
7-
export UTPLSQL_CLI_VERSION="3.1.6"
3+
export SQLCLI=sql # For sqlcl client
4+
#export SQLCLI=sqlplus # For sqlplus client
5+
export CONNECTION_STR=127.0.0.1:1521/xe # Adjust the connect string
6+
export ORACLE_PWD=oracle # Adjust your local SYS password
7+
export UTPLSQL_CLI_VERSION="v3.1.8"
88
export SELFTESTING_BRANCH=develop
99

1010
export UTPLSQL_DIR="utPLSQL_latest_release"

readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
[![twitter](https://img.shields.io/twitter/follow/utPLSQL.svg?style=social&label=Follow)](https://twitter.com/utPLSQL)
1010

1111
[![build](https://github.com/utPLSQL/utPLSQL/actions/workflows/build.yml/badge.svg)](https://github.com/utPLSQL/utPLSQL/actions/workflows/build.yml)
12-
[![QualityGate](https://sonarcloud.io/api/project_badges/measure?project=utPLSQL&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=utPLSQL)
13-
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=utPLSQL&metric=coverage)](https://sonarcloud.io/summary/new_code?id=utPLSQL)
12+
[![QualityGate](https://sonarcloud.io/api/project_badges/measure?project=utPLSQL_utPLSQL&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=utPLSQL)
13+
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=utPLSQL_utPLSQL&metric=coverage)](https://sonarcloud.io/summary/new_code?id=utPLSQL_utPLSQL)
1414

1515
----------
1616
utPLSQL version 3 is a complete rewrite of utPLSQL v2 from scratch.

test/install_and_run_tests.sh

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
#!/bin/bash
22
set -ev
33

4+
. ./development/env.sh
5+
46
#goto git root directory
57
git rev-parse && cd "$(git rev-parse --show-cdup)"
68
cd test
79

8-
time . ./${DIR}/install_tests.sh
9-
time . ./${DIR}/run_tests.sh
10+
time . ./install_tests.sh
11+
time . ./run_tests.sh

0 commit comments

Comments
 (0)