You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-41Lines changed: 16 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ To get started with development, follow the below steps.
57
57
58
58
_If you're using Windows, run the shell scripts using `GIT bash` - Windows-based bash command line._
59
59
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.
61
61
62
62
### Clone your fork of utPLSQL git repository
63
63
@@ -94,13 +94,13 @@ export ORACLE_PWD=oracle # Adjust your local SYS password
94
94
95
95
The below script is fetching latest release version from utPLSQL repository. Latest release version is used for self-testing.
96
96
```bash
97
-
development/refresh_sources.sh
97
+
./development/refresh_sources.sh
98
98
```
99
99
100
100
### Setup local database for utPLSQL development
101
101
102
102
```bash
103
-
development/install.sh
103
+
./development/install.sh
104
104
```
105
105
106
106
### That's it
@@ -135,18 +135,18 @@ Whenever a new version of utPLSQL or a new version of utPLSQL-cli is available,
135
135
136
136
utPLSQL v3 unit tests are located in the `test` directory
137
137
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.
139
139
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.
141
141
142
142
> **Important notice:**
143
143
> We do our best to keep utPLSQL covered with unit tests.
144
144
> Lack of sufficient unit testing is a perfect reason for PR to be rejected.
145
145
146
146
To run a full suite of unit tests execute:
147
147
```bash
148
-
development/env.sh
149
-
test/install_and_run_tests.sh
148
+
. ./development/env.sh
149
+
./test/install_and_run_tests.sh
150
150
```
151
151
152
152
You can review the results of tests as well as see information about code coverage in `./coverage.html` file.
@@ -162,45 +162,20 @@ Dependencies to `ut_util` are not shown as most of modules are depending on it.
162
162
163
163
## Build Environment
164
164
165
-
We are using private docker images to test utPLSQL for our Travis CI builds. The following versions of Oracle Database are being used.
165
+
We are using a combination of private and publicly available docker images to test utPLSQL. The following versions of Oracle Database are used for testing:
166
166
167
-
* 11g XE R2
168
-
* 12c SE R1
169
-
* 12c SE R2
170
-
* 18c SE
167
+
* 19c-Standard Edition (private image)
168
+
* 21-free
169
+
* 23-free
171
170
172
-
These images are based on the slimmed versions [official dockerfiles released by Oracle](https://github.com/utPLSQL/docker-scripts), but due to licensing restrictions, we can't make the images public.
173
-
You can build your own and use it locally, or push to a private docker repository.
174
-
175
-
The build steps are simple if you already have some experience using Docker. You can find detailed information about how to build your own image with a running database in: [example of creating an image with pre-built DB](https://github.com/oracle/docker-images/blob/master/OracleDatabase/samples/prebuiltdb/README.md)
176
-
177
-
> You can find more info about the official Oracle images on the [Oracle Database on Docker](https://github.com/oracle/docker-images/tree/master/OracleDatabase) GitHub page.
178
-
179
-
> If you are new to Docker, you can start by reading the [Getting Started With Docker](https://docs.docker.com/engine/getstarted/) docs.
180
-
181
-
### Docker Build Notes
182
-
183
-
* You need to comment out the VOLUME line. This step is required, because volumes are not saved when using `docker commit` command.
184
-
* When the build process is complete, you will run the container to install the database. Once everything is set up and you see the message "DATABASE IS READY!", you may change the password and stop the running container. After the container is stopped, you can safely commit the container.
185
-
* You can use the --squash experimental docker tag to reduce the image size. Example:
Travis will use your Docker Hub credentials to pull the private images, and the following secure environment variables must be defined.
191
-
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._
171
+
The Free varsions are publicly available and you can set up your local development environment to use one of from [here](https://github.com/gvenzl/oci-oracle-free)
195
172
196
-
### SQLCL
173
+
These [private image]((https://github.com/utPLSQL/docker-scripts) is a slimmed version of [the official Oracle database dockerfiles](https://github.com/oracle/docker-images/tree/master/OracleDatabase) . Due to licensing restrictions, the image cannot be public.
197
174
198
-
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.
199
-
200
-
Variable | Description
201
-
---------|------------
202
-
**ORACLE_OTN_USER<br />ORACLE_OTN_PASSWORD** | _Your Oracle website credentials. They will be used to download SQLCL._
175
+
You can build your own and use it locally, or push to a private docker repository.
176
+
The build steps are simple if you already have some experience using Docker. You can find detailed information about how to build your own image with a running database in: [example of creating an image with pre-built DB](https://github.com/oracle/docker-images/blob/master/OracleDatabase/samples/prebuiltdb/README.md)
203
177
178
+
> If you are new to Docker, you can start by reading the [Getting Started With Docker](https://docs.docker.com/get-started/) docs.
0 commit comments