Skip to content

Commit 08e730e

Browse files
committed
Move TESTS section to CONTRIBUTING.md and trim contributors list
Migrate the manual database setup, dependency install, and test invocation steps from README's TESTS section into CONTRIBUTING.md (under a new "Manual setup (without devcontainer)" section) and replace the README section with a pointer. The README's hand-maintained CONTRIBUTORS list is replaced with a thank-you note plus a link to github.com/rsim/ruby-plsql/graphs/contributors so the canonical list lives on GitHub instead of drifting in the repo.
1 parent bdde7be commit 08e730e

2 files changed

Lines changed: 38 additions & 44 deletions

File tree

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,3 +108,39 @@ BUNDLE_ONLY=rubocop bundle exec rubocop --parallel
108108
```
109109

110110
These are the same commands CI runs (`.github/workflows/rubocop.yml`).
111+
112+
## Manual setup (without devcontainer)
113+
114+
If you prefer to develop against an existing Oracle Database, review
115+
`spec/spec_helper.rb` for the default schema/user names and database
116+
names (override via environment variables as needed).
117+
118+
### Prepare the database
119+
120+
Use any reachable Oracle Database and create the test schemas:
121+
122+
```sql
123+
CREATE USER hr IDENTIFIED BY hr;
124+
GRANT unlimited tablespace, create session, create table,
125+
create sequence, create procedure, create type,
126+
create view, create synonym TO hr;
127+
128+
CREATE USER arunit IDENTIFIED BY arunit;
129+
GRANT create session TO arunit;
130+
```
131+
132+
The CI helper `ci/setup_accounts.sh` performs the equivalent setup
133+
against `${DATABASE_NAME}` using `${DATABASE_SYS_PASSWORD}`.
134+
135+
### Prepare dependencies
136+
137+
```sh
138+
gem install bundler
139+
bundle install
140+
```
141+
142+
### Run the suite
143+
144+
```sh
145+
bundle exec rake spec
146+
```

README.md

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -180,43 +180,7 @@ Make sure you use correct version of Oracle client for database you're connectin
180180
TESTS
181181
-----
182182

183-
Review `spec/spec_helper.rb` to see default schema/user names and database names (use environment variables to override defaults)
184-
185-
##### Prepare database
186-
187-
* With local [Vagrant](https://www.vagrantup.com) based Oracle XE database.
188-
189-
Download Oracle XE database ```oracle-xe-11.2.0-1.0.x86_64.rpm.zip``` from [Oracle Home page](http://www.oracle.com/technetwork/database/database-technologies/express-edition/downloads/index.html) and put it into project home directory.
190-
191-
From project home directory run ```vagrant up``` command to build fully functioning **Centos 6.6** virtual machine with installed Oracle XE database.
192-
193-
* Within other Oracle Database create Oracle database schema for test purposes.
194-
195-
SQL> CREATE USER hr IDENTIFIED BY hr;
196-
SQL> GRANT unlimited tablespace, create session, create table, create sequence, create procedure, create type, create view, create synonym TO hr;
197-
198-
SQL> CREATE USER arunit IDENTIFIED BY arunit;
199-
SQL> GRANT create session TO arunit;
200-
201-
##### Prepare dependencies
202-
203-
* Install bundler with
204-
205-
gem install bundler
206-
207-
* Install necessary gems with
208-
209-
bundle install
210-
211-
##### Run tests
212-
213-
* Run tests with local Vagrant based Oracle XE database
214-
215-
USE_VM_DATABASE=Y rake spec
216-
217-
* Run tests with other Oracle database
218-
219-
rake spec
183+
See [CONTRIBUTING.md](CONTRIBUTING.md) for how to set up a development environment and run the spec suite.
220184

221185
LINKS
222186
-----
@@ -228,13 +192,7 @@ LINKS
228192
CONTRIBUTORS
229193
------------
230194

231-
* Raimonds Simanovskis
232-
* Edgars Beigarts
233-
* Oleh Mykytyuk
234-
* Wiehann Matthysen
235-
* Dayle Larson
236-
* Yasuo Honda
237-
* Yavor Nikolov
195+
Thanks to everyone who has contributed to ruby-plsql over the years. The up-to-date list is maintained on GitHub: https://github.com/rsim/ruby-plsql/graphs/contributors
238196

239197
LICENSE
240198
-------

0 commit comments

Comments
 (0)