Skip to content

Commit 12ae488

Browse files
hayschshacharPash
haysch
and
shacharPash
authored
Add devcontainer development environment (#169)
* Add devcontainer * Add test tasks for the different Redis versions. Specify default .NET solution. * Minor clarification by moving initialization to constructor * Update devcontainer setup, and vscode tasks, to match updated Redis versions from CI pipeline. * Include section on DevContainers * Include section on DevContainers Signed-off-by: haysch <36488481+haysch@users.noreply.github.com> * Fix "spelling mistakes" * add explenation about dev containers * wordlist --------- Signed-off-by: haysch <36488481+haysch@users.noreply.github.com> Co-authored-by: shacharPash <93581407+shacharPash@users.noreply.github.com> Co-authored-by: shacharPash <shachar.pashchur@redis.com>
1 parent c99124b commit 12ae488

File tree

9 files changed

+183
-10
lines changed

9 files changed

+183
-10
lines changed

‎.devcontainer/Dockerfile

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# base development image on .NET 7.0
2+
FROM mcr.microsoft.com/devcontainers/dotnet:0-7.0-bullseye AS build
3+
4+
# fetch the .NET 6.0 SDK for use in testing
5+
COPY --from=mcr.microsoft.com/dotnet/sdk:6.0 /usr/share/dotnet/shared /usr/share/dotnet/shared

‎.devcontainer/devcontainer.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"name": "NRedisStack (.NET)",
3+
4+
"dockerComposeFile": "docker-compose.yml",
5+
"service": "devcontainer",
6+
"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
7+
"customizations": {
8+
"vscode": {
9+
"extensions": [
10+
"ms-dotnettools.csharp",
11+
"ms-dotnettools.csdevkit",
12+
"ms-dotnettools.vscodeintellicode-csharp"
13+
]
14+
}
15+
}
16+
}

‎.devcontainer/docker-compose.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
version: "3.8"
3+
services:
4+
devcontainer:
5+
build:
6+
context: .
7+
dockerfile: Dockerfile
8+
volumes:
9+
- ../..:/workspaces:cached
10+
networks:
11+
- redis
12+
command: sleep infinity
13+
environment:
14+
REDIS: "redis-stack-edge:6379" # default targeted Redis version
15+
REDIS__7_2_0: "redis-stack-7.2.0:6379"
16+
REDIS__6_2_6: "redis-stack-6.2.6:6379"
17+
REDIS__edge: "redis-stack-edge:6379"
18+
19+
redis-stack-7.2.0:
20+
image: redis/redis-stack-server:7.2.0-RC3
21+
restart: unless-stopped
22+
networks:
23+
- redis
24+
25+
redis-stack-6.2.6:
26+
image: redis/redis-stack-server:6.2.6-v9
27+
restart: unless-stopped
28+
networks:
29+
- redis
30+
31+
redis-stack-edge:
32+
image: redis/redis-stack-server:edge
33+
restart: unless-stopped
34+
networks:
35+
- redis
36+
37+
networks:
38+
# defines shared network for communicating with Redis
39+
redis:

‎.github/wordlist.txt

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
cli
22
codecov
33
Codecov
4+
Dev
5+
DevContainer
46
dotnet
57
firsttimersonly
68
github

‎.vscode/settings.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
22
"dotnet-test-explorer.testArguments": "/p:CollectCoverage=true /p:CoverletOutputFormat=lcov /p:CoverletOutput=./lcov.info",
3-
"dotnet-test-explorer.testProjectPath": "**/*NRedisStack.Tests.csproj"
3+
"dotnet-test-explorer.testProjectPath": "**/*NRedisStack.Tests.csproj",
4+
"dotnet.defaultSolution": "NRedisStack.sln"
45
}

‎.vscode/tasks.json

+54-1
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,13 @@
3838
"problemMatcher": "$msCompile"
3939
},
4040
{
41-
"label": "test",
41+
"label": "test 6.2.6",
4242
"dependsOn": [],
43+
"options": {
44+
"env": {
45+
"REDIS": "${env:REDIS__6_2_6}"
46+
}
47+
},
4348
"command": "dotnet",
4449
"type": "process",
4550
"args": [
@@ -49,6 +54,54 @@
4954
"/p:CoverletOutputFormat=lcov",
5055
"/p:CoverletOutput=./lcov.info"
5156
],
57+
"problemMatcher": "$msCompile"
58+
},
59+
{
60+
"label": "test 7.2.0",
61+
"dependsOn": [],
62+
"options": {
63+
"env": {
64+
"REDIS": "${env:REDIS__7_2_0}"
65+
}
66+
},
67+
"command": "dotnet",
68+
"type": "process",
69+
"args": [
70+
"test",
71+
"${workspaceFolder}/tests/NRedisStack.Tests/NRedisStack.Tests.csproj",
72+
"/p:CollectCoverage=true",
73+
"/p:CoverletOutputFormat=lcov",
74+
"/p:CoverletOutput=./lcov.info"
75+
],
76+
"problemMatcher": "$msCompile"
77+
},
78+
{
79+
"label": "test edge",
80+
"dependsOn": [],
81+
"options": {
82+
"env": {
83+
"REDIS": "${env:REDIS__edge}"
84+
}
85+
},
86+
"command": "dotnet",
87+
"type": "process",
88+
"args": [
89+
"test",
90+
"${workspaceFolder}/tests/NRedisStack.Tests/NRedisStack.Tests.csproj",
91+
"/p:CollectCoverage=true",
92+
"/p:CoverletOutputFormat=lcov",
93+
"/p:CoverletOutput=./lcov.info"
94+
],
95+
"problemMatcher": "$msCompile"
96+
},
97+
{
98+
"label": "test all",
99+
"dependsOrder": "sequence",
100+
"dependsOn": [
101+
"test 6.2.6",
102+
"test 7.2.0",
103+
"test edge"
104+
],
52105
"problemMatcher": "$msCompile",
53106
"group": {
54107
"kind": "test",

‎CONTRIBUTING.md

+58-2
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,67 @@ Here's how to get started with your code contribution:
3434
2. Do the changes in your fork
3535
3. Write your tests
3636

37-
4. Use the `docker run -p 6379:6379 -it redis/redis-stack-server:edge` as your local environment for running the functional tests.
38-
5. Make sure your tests pass using `dotnet test'
37+
4. Use the `docker run -p 6379:6379 -it redis/redis-stack-server:edge` as your local environment for running the functional tests. You can also use Development Container as described below.
38+
5. Make sure your tests pass using `dotnet test`
3939
6. Push your changes to GitHub
4040
7. Open a pull request
4141

42+
## Development Container
43+
44+
Development Containers are an easy way to define and setup a reproducible development environment by using containers.
45+
NRedisStack provides a [development container environment](https://containers.dev/) that can be used to get running relatively fast without focusing on the different Redis deployments.
46+
47+
The development container comes packed with .NET 6 and 7, required by the testing suite, as well as the currently supported Redis versions that are run as part of the CI pipeline.
48+
49+
Development containers are supported in a few [editors](https://containers.dev/supporting#editors) or by using the [`devcontainer-cli` tool](https://github.com/devcontainers/cli).
50+
51+
This guide explains how to use the existing development container setup for this project.
52+
53+
### Prerequisites
54+
55+
Before you start, make sure you have the following installed:
56+
57+
- [Visual Studio Code](https://code.visualstudio.com/)
58+
- [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for VS Code
59+
60+
### Steps to Use the Existing Development Container Setup
61+
62+
1. **Clone the Project:** Start by cloning the project's repository to your local machine using Git.
63+
64+
2. **Install Prerequisites:** Ensure you have Visual Studio Code and the Dev Containers extension installed.
65+
66+
3. **Open in Development Container:**
67+
68+
a. Open the cloned project directory using Visual Studio Code.
69+
70+
b. VS Code should detect the `.devcontainer` folder and the associated configuration files.
71+
72+
c. You will likely see a notification suggesting reopening the project in a development container:
73+
![devcontainer notification](./docs/devcontainerNotification.png)
74+
75+
Click on this notification or press `Ctrl + Shift + P` (or `Cmd + Shift + P` on Mac) and type _"Dev Containers: Reopen in Container"_. Select the suggestion that appears.
76+
77+
d. Visual Studio Code will build the Docker image according to the configuration and start a container using the specified setup.
78+
79+
4. **Develop Inside the DevContainer:**
80+
81+
You're now working within the development container environment. Access extensions, dependencies, and settings specified in `devcontainer.json`. Edit code, use the integrated terminal, and run commands as usual.
82+
83+
5. **Save and Commit:**
84+
85+
Changes made within the development container will be saved to your local repository. Use Git within the container to manage changes, create branches, commit, and push code.
86+
87+
6. **Stop the DevContainer:**
88+
89+
Close the development container by clicking the "Close Remote Connection" button in the bottom-left corner of the VS Code window. This stops the container while preserving changes.
90+
91+
7. **Resume Work:**
92+
93+
Reopen the project in the development container to work on it again using the same steps.
94+
95+
By using the existing `.devcontainer` setup, you benefit from a consistent development environment tailored to the project's requirements. For specific configuration details or issues, consult the project documentation or ask maintainers for assistance.
96+
97+
4298
## Testing
4399

44100
Call `dotnet test` to run all tests

‎docs/devcontainerNotification.png

20.1 KB
Loading

‎tests/NRedisStack.Tests/RedisFixture.cs

+7-6
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@ namespace NRedisStack.Tests
44
{
55
public class RedisFixture : IDisposable
66
{
7-
8-
9-
// Set the enviroment variable to specify your own alternet host and port:
10-
string redis = Environment.GetEnvironmentVariable("REDIS") ?? "localhost:6379";
11-
public RedisFixture() => Redis = ConnectionMultiplexer.Connect($"{redis}");
7+
public RedisFixture()
8+
{
9+
// Set the enviroment variable to specify your own alternet host and port:
10+
var redisConnectionString = Environment.GetEnvironmentVariable("REDIS") ?? "localhost:6379";
11+
Redis = ConnectionMultiplexer.Connect(redisConnectionString);
12+
}
1213

1314
public void Dispose()
1415
{
1516
Redis.Close();
1617
}
1718

18-
public ConnectionMultiplexer Redis { get; private set; }
19+
public ConnectionMultiplexer Redis { get; }
1920
}
2021
}

0 commit comments

Comments
 (0)