Binstubs for Better Developer Experience

[stevenjcumming]

Summary

The introduction of binstubs, which are executable wrappers, is proposed as a solution to harmonize the development environment across different setup configurations. The primary objective of these binstubs is to standardize core development commands, such as setup, running applications, and executing tests. By ensuring uniformity in these processes, we aim to mitigate the discrepancies currently observed in testing outcomes.

Note: Sorry for the big PR, most of this has already been reviewed, but it was branched off the k8s branch

Setup

• Setup replaces the existing manual setup setups by combining most of them into one command
• Some setup steps must be done manually such as Postgres & PostGIS for native
• Currently bin/setup only supports Mac OSX
• bin/setup for native, docker, and hybrid developer setup
• Setup preference is stored in .developer-setup

Test

• Replace existing testing command with a binstub bin/test
• Options include --ci, --no-parallel, --coverage, --log
• Input folders/files can be include like with rspec
• Uses the .developer-setup preference for the testing environment

Lint

• Add binstub for linting with command bin/lint
• Uses rubocop, brakeman, and bundle-audit
• Options include --dry,--only-rubocop,--only-brakeman
• Inputs can include files and folder
• Autocorrecting in rubocop is on by default, but --dry will override autocorrect option

Others

• bin/help - Display vets-api related binstubs
• bin/info - Display version related information

Impacted Areas

• This only changes local development. No functional changes

Related Issue(s)

• Exploration and Implementation of Binstubs for Development Environment Consistency va.gov-team#74660
• Developer Setup with Binstubs va.gov-team#77053
• Testing with binstubs va.gov-team#75918
• Linting with binstubs va.gov-team#75920
• (USER TESTING) Binstub User Testing  va.gov-team#77436

Acceptance criteria

• bin/help outputs a help message
• bin/info outputs a message with various versions
• bin/setup can setup local environments native, hybrid, and docker
• bin/test runs test suite with various options
• bin/lint runs security checks and linting

[va-vsp-bot]

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: docs/setup/binstubs.md

[github-actions]

1 Error

🚫

This PR changes 1153 LoC (not counting whitespace/newlines). In order to ensure each PR receives the proper attention it deserves, those exceeding 500 will not be reviewed, nor will they be allowed to merge. Please break this PR up into smaller ones. If you have reason to believe that this PR should be granted an exception, please see the Submitting pull requests for approval - FAQ. File Summary Files .github/CODEOWNERS (+2/-6) .gitignore (+3/-1) .rubocop.yml (+1/-0) bin/deps (+3/-0) bin/help (+18/-0) bin/info (+19/-0) bin/lib/vets-api/README.md (+78/-0) bin/lib/vets-api/commands/command.rb (+57/-0) bin/lib/vets-api/commands/info.rb (+61/-0) bin/lib/vets-api/commands/lint.rb (+63/-0) bin/lib/vets-api/commands/setup.rb (+77/-0) bin/lib/vets-api/commands/test.rb (+65/-0) bin/lib/vets-api/setups/base.rb (+119/-0) bin/lib/vets-api/setups/docker.rb (+62/-0) bin/lib/vets-api/setups/hybrid.rb (+91/-0) bin/lib/vets-api/setups/native.rb (+76/-0) bin/lib/vets-api/setups/rails.rb (+77/-0) bin/lint (+38/-0) bin/setup (+32/-29) bin/test (+58/-0) docs/setup/binstubs.md (+97/-0) docs/setup/docker.md (+1/-1) rakelib/support/shell_command.rb (+18/-0) Note: We exclude files matching the following when considering PR size: *.csv, *.json, *.tsv, *.txt, Gemfile.lock, app/swagger, modules/mobile/docs, spec/fixtures/, spec/support/vcr_cassettes/, modules/mobile/spec/support/vcr_cassettes/, db/seeds, modules/vaos/app/docs, modules/meb_api/app/docs, modules/appeals_api/app/swagger/, *.bru Big PRs are difficult to review, often become stale, and cause delays.

Generated by 🚫 Danger

[va-vsp-bot]

Error: A file (or its parent directories) does not have a CODEOWNERS entry. Please update the .github/CODEOWNERS file and add the entry for the Offending file: docs/setup/binstubs.md