-[Fix conflicts in database migrations if you use the same db for CE and EE](#fix-conflicts-in-database-migrations-if-you-use-the-same-db-for-ce-and-ee)
-['LoadError: dlopen' when starting Ruby apps](#loaderror-dlopen-when-starting-ruby-apps)
-['bundle install' fails due to permission problems](#bundle-install-fails-due-to-permission-problems)
-['bundle install' fails while compiling eventmachine gem](#bundle-install-fails-while-compiling-eventmachine-gem)
-['Invalid reference name' when creating a new tag](#invalid-reference-name-when-creating-a-new-tag)
-[Other problems](#other-problems)
-[Executables](#executables)
-[mount-slow-fs](#mount-slow-fs)
-[License](#license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Overview
GitLab Development Kit (GDK) provides a collection of scripts and other resources to install and manage a GitLab installation for development purposes. The source code of GitLab is spread over multiple repositories and it requires Ruby, Go, Postgres/MySQL, Redis and more to run. GDK helps you install and configure all these different components, and start/stop them when you work on GitLab.
Loading
Loading
@@ -94,50 +38,6 @@ To start using GDK follow these three steps:
## Development
### Running the tests
In order to run the test you can use the following commands:
-`rake spinach` to run the spinach suite
-`rake spec` to run the rspec suite
-`rake teaspoon` to run the teaspoon test suite
-`rake gitlab:test` to run all the tests
Note: Both `rake spinach` and `rake spec` takes significant time to pass.
Instead of running full test suite locally you can save a lot of time by running
a single test or directory related to your changes. After you submit merge request
CI will run full test suite for you. Green CI status in the merge request means
full test suite is passed.
Note: You can't run `rspec .` since this will try to run all the `_spec.rb`
files it can find, also the ones in `/tmp`
To run a single test file you can use:
-`bundle exec rspec spec/controllers/commit_controller_spec.rb` for a rspec test
-`bundle exec spinach features/project/issues/milestones.feature` for a spinach test
To run several tests inside one directory:
-`bundle exec rspec spec/requests/api/` for the rspec tests if you want to test API only
-`bundle exec spinach features/profile/` for the spinach tests if you want to test only profile pages
If you want to use [Spring](https://github.com/rails/spring) set
`ENABLE_SPRING=1` in your environment.
### Simulating Broken Storage Devices
To test how GitLab behaves when the underlying storage system is not working
you can simply change your local GitLab instance to use an empty directory for
the repositories. To do so edit your `config/gitlab.yml` configuration file so
that the `gitlab_shell.repos_path` option for your environment (e.g.
"development") points to an empty directory.
### Simulating Slow Filesystems
To simulate a slow filesystem you can use the script `bin/mount-flow-fs`. This
script can be used to mount a local directory via SSHFS and slow down access to
the files in this directory. For more information see
[mount-slow-fs](#mount-slow-fs).
### Local Network Binding
Loading
Loading
@@ -628,78 +528,7 @@ gem install nokogiri
Please open an issue on the [GDK issue tracker](https://gitlab.com/gitlab-org/gitlab-development-kit/issues).
## Executables
A collection of executables can be found in the `bin/` directory. You can use
these executables by adding this directory to your shell's executable path. For
example, when using Bash:
export PATH="${PATH}:path/to/gdk/bin"
### mount-slow-fs
This script can be used to mount a source directory at a given mount point via
SSHFS and slow down network traffic as a way of replicating a slow NFS. Usage of
