Skip to content

Commit fd1c823

Browse files
author
Tom Maher
committed
doc tweak
1 parent 381fdf4 commit fd1c823

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

README.rdoc

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,9 @@ This task will run the test suite and the
5252

5353
rake rubotest
5454

55-
To run the integration tests against an LDAP server:
56-
57-
cd test/support/vm/openldap
58-
vagrant up
59-
cd ../../../..
60-
INTEGRATION=openldap bundle exec rake rubotest
55+
CI takes too long? If your local box supports
56+
{Vagrant}(https://www.vagrantup.com/), you can run most of the tests
57+
in a VM on your local box. For more details and setup instructions, see {test/support/vm/openldap/README.md}(https://github.com/ruby-ldap/ruby-net-ldap/tree/master/test/support/vm/openldap/README.md)
6158

6259
== Release
6360

test/support/vm/openldap/README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,27 @@
11
# Local OpenLDAP Integration Testing
22

3-
Set up a [Vagrant](http://www.vagrantup.com/) VM to run integration tests against OpenLDAP locally.
3+
Set up a [Vagrant](http://www.vagrantup.com/) VM to run integration
4+
tests against OpenLDAP locally. *NOTE*: To support some of the SSL tests,
5+
Vagrant forwards localhost port 9389 to VM host port 9389. The port mapping
6+
goes away when you run `vagrant destroy`.
47

5-
To run integration tests locally:
8+
## Install Vagrant
9+
10+
*NOTE*: The Vagrant gem (`gem install vagrant`) is
11+
[no longer supported](https://www.vagrantup.com/docs/installation/)
12+
13+
If you use Homebrew on macOS:
14+
``` bash
15+
$ brew update
16+
$ brew cask install virtualbox
17+
$ brew cask install vagrant
18+
$ brew cask install vagrant-manager
19+
```
20+
21+
Installing Vagrant and virtualbox on other operating systems is left
22+
as an exercise to the reader.
23+
24+
## Run the tests
625

726
``` bash
827
# start VM (from the correct directory)
@@ -27,6 +46,10 @@ $ export INTEGRATION_HOST=$ip
2746

2847
# now run tests without having to set ENV variables
2948
$ time bundle exec rake
49+
50+
# Once you're all done
51+
$ cd test/support/vm/openldap
52+
$ vagrant destroy
3053
```
3154

3255
You may need to `gem install vagrant` first in order to provision the VM.

0 commit comments

Comments
 (0)