Added Dev Container CLI to run the tests (#1149)

Author: aidanharan

.devcontainer/Dockerfile

@@ -0,0 +1,30 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/ruby/.devcontainer/base.Dockerfile
+
+# [Choice] Ruby version: 3, 3.0, 2, 2.7, 2.6
+ARG VARIANT="3"
+FROM mcr.microsoft.com/devcontainers/ruby:${VARIANT}
+
+# TinyTDS
+RUN apt-get -y install libc6-dev \
+    && wget http://www.freetds.org/files/stable/freetds-1.1.32.tar.gz \
+    && tar -xzf freetds-1.1.32.tar.gz \
+    && cd freetds-1.1.32 \
+    && ./configure --prefix=/usr/local --with-tdsver=7.3 \
+    && make \
+    && make install
+
+# Install the SQL Server command-line tools
+RUN curl https://packages.microsoft.com/keys/microsoft.asc | sudo tee /etc/apt/trusted.gpg.d/microsoft.asc \
+    && curl https://packages.microsoft.com/config/ubuntu/22.04/prod.list | sudo tee /etc/apt/sources.list.d/mssql-release.list \
+    && apt-get update \
+    && ACCEPT_EULA=Y apt-get install -y mssql-tools18 unixodbc-dev \
+    && echo 'export PATH="$PATH:/opt/mssql-tools18/bin"' >> ~/.bashrc \
+    && echo 'export PATH="$PATH:/opt/mssql-tools18/bin"' >> /root/.bashrc
+
+# Add the SQL Server main Gemfile and install the gems.
+RUN mkdir -p /tmp/activerecord-sqlserver-adapter
+COPY Gemfile VERSION activerecord-sqlserver-adapter.gemspec /tmp/activerecord-sqlserver-adapter/
+RUN cd /tmp/activerecord-sqlserver-adapter \
+    && bundle install \
+    && rm -rf /tmp/activerecord-sqlserver-adapter
+RUN chown -R vscode:vscode /usr/local/rvm

.devcontainer/boot.sh

@@ -0,0 +1,22 @@
+sudo chown -R vscode:vscode /usr/local/bundle
+
+# Wait for 5 seconds to make sure SQL Server came up.
+sleep 5
+
+# Setup test databases and users.
+/opt/mssql-tools18/bin/sqlcmd -C -S sqlserver -U sa -P "MSSQLadmin!" <<SQL
+CREATE DATABASE [activerecord_unittest];
+CREATE DATABASE [activerecord_unittest2];
+GO
+CREATE LOGIN [rails] WITH PASSWORD = '', CHECK_POLICY = OFF, DEFAULT_DATABASE = [activerecord_unittest];
+GO
+USE [activerecord_unittest];
+CREATE USER [rails] FOR LOGIN [rails];
+GO
+EXEC sp_addrolemember N'db_owner', N'rails';
+EXEC master..sp_addsrvrolemember @loginame = N'rails', @rolename = N'sysadmin';
+GO
+SQL
+
+# Mark directory as safe in Git so that commands run without warnings.
+git config --global --add safe.directory /workspaces/activerecord-sqlserver-adapter

.devcontainer/devcontainer.json

@@ -0,0 +1,38 @@
+// For format details, see https://aka.ms/devcontainer.json.
+{
+	"name": "ActiveRecord SQL Server Adapter project development",
+	"dockerComposeFile": "docker-compose.yml",
+	"service": "activerecord-sqlserver-adapter",
+	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {
+			"version": "latest"
+		}
+	},
+
+	"containerEnv": {
+    "ACTIVERECORD_UNITTEST_HOST": "sqlserver"
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// This can be used to network with other containers or the host.
+	// "forwardPorts": [3000, 5432],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": ".devcontainer/boot.sh",
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"Shopify.ruby-lsp"
+			]
+		}
+	},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,35 @@
+version: '3'
+
+services:
+  activerecord-sqlserver-adapter:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+
+    volumes:
+      - ../..:/workspaces:cached
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
+    networks:
+      - default
+
+    depends_on:
+      - sqlserver
+
+    # Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
+    # (Adding the "ports" property to this file will not forward from a Codespace.)
+
+  sqlserver:
+    image: mcr.microsoft.com/mssql/server:2022-latest
+    restart: unless-stopped
+    networks:
+      - default
+    environment:
+      MSSQL_SA_PASSWORD: MSSQLadmin!
+      ACCEPT_EULA: Y
+
+networks:
+  default:

README.md

@@ -183,11 +183,49 @@ gem 'activerecord-sqlserver-adapter'
 
 ## Contributing
 
-If you would like to contribute a feature or bugfix, thanks! To make sure your fix/feature has a high chance of being added, please read the following guidelines. First, ask on the Gitter, or post a ticket on github issues. Second, make sure there are tests! We will not accept any patch that is not tested. Please read the [`RUNNING_UNIT_TESTS`](RUNNING_UNIT_TESTS.md) file for the details of how to run the unit tests.
+Please contribute to the project by submitting bug fixes and features. To make sure your fix/feature has
+a high chance of being added, please include tests in your pull request. To run the tests you will need to
+setup your development environment.
 
-* Github: http://github.com/rails-sqlserver/activerecord-sqlserver-adapter
-* Gitter: https://gitter.im/rails-sqlserver/activerecord-sqlserver-adapter
+## Setting Up Your Development Environment
 
+To run the test suite you can use any of the following methods below. See [RUNNING_UNIT_TESTS](RUNNING_UNIT_TESTS.md) for
+more detailed information on running unit tests.
+
+### Dev Container CLI
+
+With [Docker](https://www.docker.com) and [npm](https://github.com/npm/cli) installed, you can run [Dev Container CLI](https://github.com/devcontainers/cli) to
+utilize the [`.devcontainer`](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/main/.devcontainer) configuration from the command line.
+
+```bash
+$ npm install -g @devcontainers/cli
+$ cd rails
+$ devcontainer up --workspace-folder .
+$ devcontainer exec --workspace-folder . bash
+```
+
+From within the container, you can run the tests using the following command:
+
+```bash
+$ bundle install
+$ bundle exec rake test
+```
+
+_Note: The setup we use is based on the [Rails Dev Container setup.](https://guides.rubyonrails.org/contributing_to_ruby_on_rails.html#using-dev-container-cli)_
+
+### VirtualBox & Vagrant
+
+The [activerecord-sqlserver-adapter-dev-box](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter-dev-box)
+is a Vagrant/VirtualBox virtual machine that has MS SQL Server installed. However, the
+activerecord-sqlserver-adapter-dev-box uses Vagrant and Virtual Box which will not work on Macs with Apple silicon.
+
+### Local Development
+
+See the [RUNNING_UNIT_TESTS](RUNNING_UNIT_TESTS.md) file for the details of how to run the unit tests locally.
+
+## Community
+
+There is a [Gitter channel](https://gitter.im/rails-sqlserver/activerecord-sqlserver-adapter) for the project where you are free to ask questions about the project.
 
 ## Credits & Contributions
 

RUNNING_UNIT_TESTS.md

@@ -1,9 +1,8 @@
+# How To Run The Tests Locally
 
-# How To Run The Test!
+The following is a description of how to run the tests for the SQL Server adapter on a local environment.
 
-This process is much easier than it has been before!
-
-## MS SQL SERVER
+## MS SQL Server instance
 
 If you don't have easy access to MS SQL Server, you can set up a Vagrant/VirtualBox virtual machine with MS SQL Server. [Here's how](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter-dev-box).