edu4rdshl/rust-postgres-devcontainer
1
0
Fork 0
mirror of https://github.com/edu4rdshl/rust-postgres-devcontainer.git synced 2026-07-17 23:24:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Initial commit.

Browse source
This commit is contained in:
Eduard Tolosa 2025-02-05 10:10:39 +00:00
parent f2fc22907b
commit 016dfa9787
5 changed files with 255 additions and 84 deletions
Download patch file Download diff file Expand all files Collapse all files

22
.devcontainer/Dockerfile Normal file
View file

@ -0,0 +1,22 @@
FROM rust:latest
# Install the development dependencies
RUN apt-get update && apt-get upgrade -y && apt-get install -y build-essential curl git libssl-dev pkg-config make postgresql-client \
postgresql clang lld sudo vim bash-completion && apt-get clean && rm -rf /var/lib/apt/lists/*
# Create a non-root user
ENV USER_NAME=vscode
RUN useradd -m $USER_NAME -s /bin/bash
USER $USER_NAME
# Install nightly toolchain and rustfmt for it and the stable version
RUN rustup toolchain install nightly --component rustfmt clippy && rustup component add rustfmt clippy \
&& cargo install diesel_cli dcargo-edit cargo-update cargo-audit cargo-udeps && mkdir -p /home/$USER_NAME/workspace
# Copy .bash_aliases, it contains several useful aliases for cargo
COPY configs/.bash_aliases /home/$USER_NAME/.bash_aliases
# Detect the postgres version and set the volume
ENV POSTGRES_VERSION=15
VOLUME /var/lib/postgresql/$POSTGRES_VERSION/main
# trust all local connections to postgres
COPY configs/pg_hba.conf /etc/postgresql/$POSTGRES_VERSION/main/pg_hba.conf
# Allow the user to run sudo without password, generate locales and set the default one
USER root
RUN echo "$USER_NAME ALL=(ALL:ALL) NOPASSWD: ALL" | tee /etc/sudoers.d/$USER_NAME && \
echo "en_US.UTF-8 UTF-8" > /etc/locale.gen && locale-gen && update-locale

15
.devcontainer/configs/.bash_aliases Normal file
View file

@ -0,0 +1,15 @@
alias clippy='cargo +nightly clippy -- -D clippy::all -W clippy::pedantic -W clippy::nursery'
alias clippyfix='cargo +nightly clippy --allow-dirty --fix -- -D clippy::all -W clippy::pedantic -W clippy::nursery'
alias audit='cargo audit'
alias udeps='cargo +nightly udeps'
alias cbuild='cargo build'
alias ctest='cargo test'
alias ccheck='cargo check'
alias cdoc='cargo doc'
alias cfmt='cargo fmt'
alias crelease='cargo build --release'
alias cupdate='cargo update'
alias cwatch='cargo watch'
alias cupgrade='cargo upgrade'
alias rupgrade='cargo install-update -ag'
alias startpostgres='sudo service postgresql start'

104
.devcontainer/configs/pg_hba.conf Normal file
View file

@ -0,0 +1,104 @@
# PostgreSQL Client Authentication Configuration File
# ===================================================
#
# Refer to the "Client Authentication" section in the PostgreSQL
# documentation for a complete description of this file. A short
# synopsis follows.
#
# This file controls: which hosts are allowed to connect, how clients
# are authenticated, which PostgreSQL user names they can use, which
# databases they can access. Records take one of these forms:
#
# local DATABASE USER METHOD [OPTIONS]
# host DATABASE USER ADDRESS METHOD [OPTIONS]
# hostssl DATABASE USER ADDRESS METHOD [OPTIONS]
# hostnossl DATABASE USER ADDRESS METHOD [OPTIONS]
# hostgssenc DATABASE USER ADDRESS METHOD [OPTIONS]
# hostnogssenc DATABASE USER ADDRESS METHOD [OPTIONS]
#
# (The uppercase items must be replaced by actual values.)
#
# The first field is the connection type:
# - "local" is a Unix-domain socket
# - "host" is a TCP/IP socket (encrypted or not)
# - "hostssl" is a TCP/IP socket that is SSL-encrypted
# - "hostnossl" is a TCP/IP socket that is not SSL-encrypted
# - "hostgssenc" is a TCP/IP socket that is GSSAPI-encrypted
# - "hostnogssenc" is a TCP/IP socket that is not GSSAPI-encrypted
#
# DATABASE can be "all", "sameuser", "samerole", "replication", a
# database name, or a comma-separated list thereof. The "all"
# keyword does not match "replication". Access to replication
# must be enabled in a separate record (see example below).
#
# USER can be "all", a user name, a group name prefixed with "+", or a
# comma-separated list thereof. In both the DATABASE and USER fields
# you can also write a file name prefixed with "@" to include names
# from a separate file.
#
# ADDRESS specifies the set of hosts the record matches. It can be a
# host name, or it is made up of an IP address and a CIDR mask that is
# an integer (between 0 and 32 (IPv4) or 128 (IPv6) inclusive) that
# specifies the number of significant bits in the mask. A host name
# that starts with a dot (.) matches a suffix of the actual host name.
# Alternatively, you can write an IP address and netmask in separate
# columns to specify the set of hosts. Instead of a CIDR-address, you
# can write "samehost" to match any of the server's own IP addresses,
# or "samenet" to match any address in any subnet that the server is
# directly connected to.
#
# METHOD can be "trust", "reject", "md5", "password", "scram-sha-256",
# "gss", "sspi", "ident", "peer", "pam", "ldap", "radius" or "cert".
# Note that "password" sends passwords in clear text; "md5" or
# "scram-sha-256" are preferred since they send encrypted passwords.
#
# OPTIONS are a set of options for the authentication in the format
# NAME=VALUE. The available options depend on the different
# authentication methods -- refer to the "Client Authentication"
# section in the documentation for a list of which options are
# available for which authentication methods.
#
# Database and user names containing spaces, commas, quotes and other
# special characters must be quoted. Quoting one of the keywords
# "all", "sameuser", "samerole" or "replication" makes the name lose
# its special character, and just match a database or username with
# that name.
#
# This file is read on server startup and when the server receives a
# SIGHUP signal. If you edit the file on a running system, you have to
# SIGHUP the server for the changes to take effect, run "pg_ctl reload",
# or execute "SELECT pg_reload_conf()".
#
# Put your actual configuration here
# ----------------------------------
#
# If you want to allow non-local connections, you need to add more
# "host" records. In that case you will also need to make PostgreSQL
# listen on a non-local interface via the listen_addresses
# configuration parameter, or via the -i or -h command line switches.
# DO NOT DISABLE!
# If you change this first entry you will need to make sure that the
# database superuser can access the database using some other method.
# Noninteractive access to all databases is required during automatic
# maintenance (custom daily cronjobs, replication, and similar tasks).
#
# Database administrative login by Unix domain socket
local all postgres trust
# TYPE DATABASE USER ADDRESS METHOD
# "local" is for Unix domain socket connections only
local all all trust
# IPv4 local connections:
host all all 127.0.0.1/32 trust
# IPv6 local connections:
host all all ::1/128 trust
# Allow replication connections from localhost, by a user with the
# replication privilege.
local replication all trust
host replication all 127.0.0.1/32 trust
host replication all ::1/128 trust

53
.devcontainer/devcontainer.json Normal file
View file

@ -0,0 +1,53 @@
// This is the devcontainer.json file for the Rust development container
// It's intended to be used for many different projects, so it's a bit more generic.
// All you need is to create a symlink to /var/local/development from the directory
// where you have all your Rust projects. You can however override the options,
// check the README.md for more information.
{
"name": "rust_devcontainer",
"build": {
"dockerfile": "Dockerfile"
},
"customizations": {
"vscode": {
"settings": {
"terminal.integrated.shell.linux": "/bin/bash"
},
"extensions": [
"rust-lang.rust-analyzer",
"ms-vscode.cpptools",
"vadimcn.vscode-lldb",
"ms-vscode.cmake-tools",
"twxs.cmake",
"fill-labs.dependi",
"tamasfe.even-better-toml",
"GitLab.gitlab-workflow",
"ms-ossdata.vscode-postgresql",
"mtxr.sqltools",
"mtxr.sqltools-driver-pg"
]
}
},
"workspaceFolder": "/home/vscode/workspace",
"workspaceMount": "source=/var/local/development,target=/home/vscode/workspace,type=bind,consistency=cached",
// Handle CARGO_HOME=/usr/local/cargo creating a volume for the cargo data to persist between runs
"mounts": [
{
"source": "cargo-cache-rust_devcontainer",
"target": "/usr/local/cargo",
"type": "volume"
},
// Handle the postgres data directory
{
"source": "postgres-rust_devcontainer",
"target": "/var/lib/postgresql/15/main",
"type": "volume"
}
],
"runArgs": [
"--restart=always",
"--name=rust_devcontainer"
],
"postStartCommand": "sudo service postgresql start",
"remoteUser": "vscode"
}

145
README.md
View file

@ -1,93 +1,70 @@
# Rust Devcontainers Setup for Somos Internet # Rust and PostgreSQL devcontainer
This is a [devcontainer](https://containers.dev/) for Rust and PostgreSQL development. It is based on the official Rust devcontainer and adds PostgreSQL.
# How to use
## Getting started 1. Install the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension for Visual Studio Code.
2. Add a `.devcontainer/devcontainer.json` file to your repository with the following content:
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
```json
{
"image": "ghcr.io/edu4rdshl/rust-postgres-devcontainer:latest",
"customizations": {
"vscode": {
"settings": {
"terminal.integrated.shell.linux": "/bin/bash"
},
"extensions": [
"rust-lang.rust-analyzer",
"ms-vscode.cpptools",
"vadimcn.vscode-lldb",
"ms-vscode.cmake-tools",
"twxs.cmake",
"fill-labs.dependi",
"tamasfe.even-better-toml",
"GitLab.gitlab-workflow",
"ms-ossdata.vscode-postgresql",
"mtxr.sqltools",
"mtxr.sqltools-driver-pg"
]
}
},
// Mount the workspace folder into the container
"workspaceMount": "source=${localWorkspaceFolder},target=/home/vscode/workspace,type=bind,consistency=cached",
"mounts": [
// Note: The volumes cargo-cache-rust_devcontainer and postgres-rust_devcontainer are automatically used
// to cache the cargo and postgresql data directories respectively. You can override them by setting the
// mounts here. Example:
// {
// "source": "cargo-cache-${localWorkspaceFolderBasename}",
// "target": "/usr/local/cargo",
// "type": "volume"
// },
// {
// "source": "postgres-${localWorkspaceFolderBasename}",
// "target": "/var/lib/postgresql/15/main",
// "type": "volume"
// }
],
"runArgs": [
"--restart=always",
"--name=devcontainer-${localWorkspaceFolderBasename}"
]
}
``` ```
cd existing_repo 3. Install [devcontainer-cli](https://github.com/devcontainers/cli) by running `npm install -g @devcontainers/cli`.
git remote add origin https://gitlab.com/somos-engineering/rust-devcontainers-setup.git 4. Run `devcontainer up --workspace-folder .` in the repository root.
git branch -M main 5. Attach to the devcontainer by clicking the green button in the bottom left corner of Visual Studio Code.
git push -uf origin main 6. You're ready to go!
```
## Integrate with your tools # What's included
- [ ] [Set up project integrations](https://gitlab.com/somos-engineering/rust-devcontainers-setup/-/settings/integrations) - Rust
- PostgreSQL
- Diesel CLI
- Several useful bash_aliases
## Collaborate with your team # Issues
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) If you encounter any issues, please open an issue on the [GitHub repository](https://github.com/Edu4rdSHL/rust-postgres-devcontainer/issues).
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.