The Ruby Spec Suite

The Ruby Spec Suite, abbreviated ruby/spec, is a test suite for the behavior of the Ruby programming language.

Description and Motivation

It is not a standardized specification like the ISO one, and does not aim to become one. Instead, it is a practical tool to describe and test the behavior of Ruby with code.

Every example code has a textual description, which presents several advantages:

It is easier to understand the intent of the author
It documents how recent versions of Ruby should behave
It helps Ruby implementations to agree on a common behavior

The specs are written with syntax similar to RSpec 2. They are run with MSpec, the purpose-built framework for running the Ruby Spec Suite. For more information, see the MSpec project.

The specs describe the language syntax, the core library, the standard library, the C API for extensions and the command line flags. The language specs are grouped by keyword while the core and standard library specs are grouped by class and method.

ruby/spec is known to be tested in these implementations for every commit:

MRI on 30 platforms and 4 versions
JRuby for both 1.7 and 9.x
TruffleRuby
Opal
Artichoke

ruby/spec describes the behavior of Ruby 3.0 and more recent Ruby versions. More precisely, every latest stable MRI release should pass all specs of ruby/spec (3.0.x, 3.1.x, 3.2.x, etc), and those are tested in CI.

Synchronization with Ruby Implementations

The specs are synchronized both ways around once a month by @eregon between ruby/spec, MRI, JRuby and TruffleRuby, using this script. Each of these repositories has a full copy of the specs under spec/ruby to ease editing specs. Any of these repositories can be used to add or edit specs, use what is most convenient for you.

For testing the development version of a Ruby implementation, one should always test against that implementation's copy of the specs under spec/ruby, as that's what the Ruby implementation tests against in their CI. Also, this repository doesn't always contain the latest spec changes from MRI (it's synchronized monthly), and does not contain tags (specs marked as failing on that Ruby implementation). Running specs on a Ruby implementation can be done with:

$ cd ruby_implementation/spec/ruby
# Add ../ruby_implementation/bin in PATH, or pass -t /path/to/bin/ruby
$ ../mspec/bin/mspec

Specs for old Ruby versions

For older specs try these commits:

Ruby 2.0.0-p647 - Suite using MSpec (may encounter 2 failures)
Ruby 2.1.9 - Suite using MSpec
Ruby 2.2.10 - Suite using MSpec
Ruby 2.3.8 - Suite using MSpec
Ruby 2.4.10 - Suite using MSpec
Ruby 2.5.9 - Suite using MSpec
Ruby 2.6.10 - Suite using MSpec
Ruby 2.7.8 - Suite using MSpec

Running the specs

First, clone this repository:

$ git clone https://github.com/ruby/spec.git

Then move to it:

$ cd spec

Clone MSpec:

$ git clone https://github.com/ruby/mspec.git ../mspec

And run the spec suite:

$ ../mspec/bin/mspec

This will execute all the specs using the executable named ruby on your current PATH.

Running Specs with a Specific Ruby Implementation

Use the -t option to specify the Ruby implementation with which to run the specs. The argument is either a full path to the Ruby binary, or an executable in $PATH.

$ ../mspec/bin/mspec -t /path/to/some/bin/ruby

Running Selected Specs

To run a single spec file, pass the filename to mspec:

$ ../mspec/bin/mspec core/kernel/kind_of_spec.rb

You can also pass a directory, in which case all specs in that directories will be run:

$ ../mspec/bin/mspec core/kernel

Finally, you can also run them per group as defined in default.mspec. The following command will run all language specs:

$ ../mspec/bin/mspec :language

In similar fashion, the following commands run the respective specs:

$ ../mspec/bin/mspec :core
$ ../mspec/bin/mspec :library
$ ../mspec/bin/mspec :capi

Sanity Checks When Running Specs

A number of checks for various kind of "leaks" (file descriptors, temporary files, threads, subprocesses, ENV, ARGV, global encodings, top-level constants) can be enabled with CHECK_LEAKS=true:

$ CHECK_LEAKS=true ../mspec/bin/mspec

New top-level constants should only be introduced when needed or follow the pattern <ClassBeingTested>Specs such as module StringSpecs. Other constants used for testing should be nested under such a module.

Exceptions to these rules are contained in the file .mspec.constants. MSpec can automatically add new top-level constants in this file with:

$ CHECK_LEAKS=save mspec ../mspec/bin/mspec file

Running Specs on S390x CPU Architecture

Run the specs with DFLTCC=0 if you see failing specs related to the zlib library on s390x CPU architecture. The failures can happen with the zlib library applying the patch madler/zlib#410 to enable the deflate algorithm producing a different compressed byte stream.

$ DFLTCC=0 ../mspec/bin/mspec

Contributing and Writing Specs

See CONTRIBUTING.md for documentation about contributing and writing specs (guards, matchers, etc).

Dependencies

These command-line executables are needed to run the specs.

echo
stat for core/file/*time_spec.rb
find for core/file/fixtures/file_types.rb (package findutils, not needed on Windows)

The file /etc/services is required for socket specs (package netbase on Debian, not needed on Windows).

Socket specs from rubysl-socket

Most specs under library/socket were imported from the rubysl-socket project (which is no longer on GitHub). The 3 copyright holders of rubysl-socket, Yorick Peterse, Chuck Remes and Brian Shirai, agreed to relicense those specs under the MIT license in ruby/spec.

History and RubySpec

This project was originally born from Rubinius tests being converted to the spec style. The revision history of these specs is available here. These specs were later extracted to their own project, RubySpec, with a specific vision and principles. At the end of 2014, Brian Shirai, the creator of RubySpec, decided to end RubySpec. A couple months later, the different repositories were merged and the project was revived. On 12 January 2016, the name was changed to "The Ruby Spec Suite" for clarity and to let the RubySpec ideology rest in peace.

takaram/spec