Merge pull request #24 from RonasIT/20_add-dependabot-configuration-step

DenTray · web-flow · commit 7cb56bbba170 · 2025-02-10T09:37:15.000+06:00
20_add dependabot configuration step
diff --git a/resources/md/readme/CREDENTIALS_AND_ACCESS.md b/resources/md/readme/CREDENTIALS_AND_ACCESS.md
@@ -10,4 +10,4 @@
 
 {nova_credentials}Laravel Nova access:
 - email `:nova_email`
-- password `:nova_password`{/nova_credentials}
+- password `:nova_password`{/nova_credentials}
diff --git a/resources/md/readme/RENOVATE.md b/resources/md/readme/RENOVATE.md
@@ -0,0 +1,3 @@
+### Renovate
+
+The application uses Renovate dependabot for automatically updating dependencies. You can configure it more precisely using the `renovate.json` file. Available configuration described here https://docs.renovatebot.com/config-overview
diff --git a/src/Commands/InitCommand.php b/src/Commands/InitCommand.php
@@ -6,6 +6,7 @@
 use Illuminate\Contracts\Console\Isolatable;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\Str;
 use RonasIT\ProjectInitializator\Enums\RoleEnum;
 use Illuminate\Support\Facades\Artisan;
@@ -24,9 +25,11 @@ class InitCommand extends Command implements Isolatable
         'nova' => 'Laravel Nova',
     ];
 
+    public const string CONTACTS_TEAM_LEAD = 'team_lead';
+
     public const array CONTACTS_ITEMS = [
         'manager' => 'Manager',
-        'team_lead' => 'Code Owner/Team Lead',
+        self::CONTACTS_TEAM_LEAD => 'Code Owner/Team Lead',
     ];
 
     public const array CREDENTIALS_ITEMS = [
@@ -63,6 +66,8 @@ class InitCommand extends Command implements Isolatable
 
     protected string $appName;
 
+    protected ?string $reviewer = null;
+
     public function handle(): void
     {
         $this->prepareAppName();
@@ -88,7 +93,7 @@ public function handle(): void
             $this->createAdminUser($kebabName);
         }
 
-        if ($this->confirm('Do you want to generate a README file?', true)) {
+        if ($shouldGenerateReadme = $this->confirm('Do you want to generate a README file?', true)) {
             $this->fillReadme();
 
             if ($this->confirm('Do you need a `Resources & Contacts` part?', true)) {
@@ -126,6 +131,16 @@ public function handle(): void
             }
         }
 
+        if ($this->confirm('Would you use Renovate dependabot?')) {
+            $this->saveRenovateJSON();
+
+            if ($shouldGenerateReadme) {
+                $this->fillRenovate();
+
+                $this->saveReadme();
+            }
+        }
+
         if ($this->confirm('Do you want to install media package?')) {
             $this->shellCommands[] = 'composer require ronasit/laravel-media';
         }
@@ -219,6 +234,10 @@ protected function fillContacts(): void
 
         foreach (self::CONTACTS_ITEMS as $key => $title) {
             if ($link = $this->ask("Please enter a {$title}'s email", '')) {
+                if (!empty($link) && $key === self::CONTACTS_TEAM_LEAD) {
+                    $this->reviewer = $link;
+                }
+
                 $this->setReadmeValue($filePart, "{$key}_link", $link);
             } else {
                 $this->emptyValuesList[] = "{$title}'s email";
@@ -371,4 +390,44 @@ protected function prepareAppName(): void
             $this->appName = $pascalCaseAppName;
         }
     }
+
+    protected function saveRenovateJSON(): void
+    {
+        $this->reviewer = $this->validateInput(
+            method: fn () => $this->ask('Please type username of the project reviewer', Str::before($this->reviewer, '@')),
+            field: 'username of the project reviewer',
+            rules: 'required|alpha_dash',
+        );
+
+        $data = [
+            '$schema' => 'https://docs.renovatebot.com/renovate-schema.json',
+            'extends' => ['config:recommended'],
+            'enabledManagers' => ['composer'],
+            'assignees' => [$this->reviewer],
+        ];
+
+        file_put_contents('renovate.json', json_encode($data, JSON_PRETTY_PRINT));
+    }
+
+    protected function validateInput(callable $method, string $field, string|array $rules): string
+    {
+        $value = $method();
+
+        $validator = Validator::make([$field => $value], [$field => $rules]);
+
+        if ($validator->fails()) {
+            $this->warn($validator->errors()->first());
+
+            $value = $this->validateInput($method, $field, $rules);
+        }
+
+        return $value;
+    }
+
+    protected function fillRenovate(): void
+    {
+        $filePart = $this->loadReadmePart('RENOVATE.md');
+
+        $this->updateReadmeFile($filePart);
+    }
 }
diff --git a/tests/InitCommandTest.php b/tests/InitCommandTest.php
@@ -24,6 +24,12 @@ public function testRunWithoutAdminAndReadmeCreation()
         $this->mockFilePutContent(
             'env.example_app_name_pascal_case.yml',
             'env.development_app_name_pascal_case.yml',
+            [
+                'renovate.json',
+                $this->getFixture('renovate.json'),
+                'optionalParameter',
+                'optionalParameter',
+            ],
         );
 
         $this->mockShellExec(
@@ -40,6 +46,8 @@ public function testRunWithoutAdminAndReadmeCreation()
             ->expectsQuestion('Please enter an application URL', 'https://mysite.com')
             ->expectsConfirmation('Do you want to generate an admin user?')
             ->expectsConfirmation('Do you want to generate a README file?')
+            ->expectsConfirmation('Would you use Renovate dependabot?', 'yes')
+            ->expectsQuestion('Please type username of the project reviewer', 'reviewer')
             ->expectsConfirmation('Do you want to install media package?')
             ->expectsConfirmation('Do you want to uninstall project-initializator package?')
             ->assertExitCode(0);
@@ -78,6 +86,7 @@ public function testRunWithoutAdminAndReadmeCreationConvertAppNameToPascalCase()
             ->expectsQuestion('Please enter an application URL', 'https://mysite.com')
             ->expectsConfirmation('Do you want to generate an admin user?')
             ->expectsConfirmation('Do you want to generate a README file?')
+            ->expectsConfirmation('Would you use Renovate dependabot?')
             ->expectsConfirmation('Do you want to install media package?')
             ->expectsConfirmation('Do you want to uninstall project-initializator package?')
             ->assertExitCode(0);
@@ -126,6 +135,7 @@ public function testRunWithAdminAndWithoutReadmeCreation()
             ->expectsQuestion('Please enter an admin password', '123456')
             ->expectsQuestion('Please enter an admin role id', 1)
             ->expectsConfirmation('Do you want to generate a README file?')
+            ->expectsConfirmation('Would you use Renovate dependabot?')
             ->expectsConfirmation('Do you want to install media package?')
             ->expectsConfirmation('Do you want to uninstall project-initializator package?')
             ->assertExitCode(0);
@@ -174,6 +184,10 @@ public function testRunWithAdminAndDefaultReadmeCreation()
                 'arguments' => ['/app/resources/md/readme/CREDENTIALS_AND_ACCESS.md'],
                 'result' => $this->getTemplate('CREDENTIALS_AND_ACCESS.md'),
             ],
+            [
+                'arguments' => ['/app/resources/md/readme/RENOVATE.md'],
+                'result' => $this->getTemplate('RENOVATE.md'),
+            ],
         );
 
         $this->mockFilePutContent(
@@ -190,7 +204,19 @@ public function testRunWithAdminAndDefaultReadmeCreation()
                 $this->getFixture('default_readme.md'),
                 'optionalParameter',
                 'optionalParameter',
-            ]
+            ],
+            [
+                'renovate.json',
+                $this->getFixture('renovate.json'),
+                'optionalParameter',
+                'optionalParameter',
+            ],
+            [
+                'README.md',
+                $this->getFixture('default_readme_after_using_renovate.md'),
+                'optionalParameter',
+                'optionalParameter',
+            ],
         );
 
         $this->mockShellExec(
@@ -267,6 +293,8 @@ public function testRunWithAdminAndDefaultReadmeCreation()
             ->expectsOutput('- ArgoCD link')
             ->expectsOutput('- Manager\'s email')
             ->expectsOutput('- Code Owner/Team Lead\'s email')
+            ->expectsConfirmation('Would you use Renovate dependabot?', 'yes')
+            ->expectsQuestion('Please type username of the project reviewer', 'reviewer')
             ->expectsConfirmation('Do you want to install media package?')
             ->expectsConfirmation('Do you want to uninstall project-initializator package?')
             ->assertExitCode(0);
@@ -382,6 +410,7 @@ public function testRunWithAdminAndPartialReadmeCreation()
             ->expectsOutput('Don`t forget to fill the following empty values:')
             ->expectsOutput('- Issue Tracker link')
             ->expectsOutput('- Code Owner/Team Lead\'s email')
+            ->expectsConfirmation('Would you use Renovate dependabot?')
             ->expectsConfirmation('Do you want to install media package?')
             ->expectsConfirmation('Do you want to uninstall project-initializator package?')
             ->assertExitCode(0);
@@ -430,6 +459,10 @@ public function testRunWithAdminAndFullReadmeCreationAndRemovingInitializatorIns
                 'arguments' => ['/app/resources/md/readme/CREDENTIALS_AND_ACCESS.md'],
                 'result' => $this->getTemplate('CREDENTIALS_AND_ACCESS.md'),
             ],
+            [
+                'arguments' => ['/app/resources/md/readme/RENOVATE.md'],
+                'result' => $this->getTemplate('RENOVATE.md'),
+            ],
         );
 
         $this->mockFilePutContent(
@@ -446,7 +479,19 @@ public function testRunWithAdminAndFullReadmeCreationAndRemovingInitializatorIns
                 $this->getFixture('full_readme.md'),
                 'optionalParameter',
                 'optionalParameter',
-            ]
+            ],
+            [
+                'renovate.json',
+                $this->getFixture('renovate.json'),
+                'optionalParameter',
+                'optionalParameter',
+            ],
+            [
+                'README.md',
+                $this->getFixture('full_readme_after_using_renovate.md'),
+                'optionalParameter',
+                'optionalParameter',
+            ],
         );
 
         $this->mockShellExec(
@@ -519,6 +564,8 @@ public function testRunWithAdminAndFullReadmeCreationAndRemovingInitializatorIns
             ->expectsQuestion('Please enter a Laravel Nova\'s admin email', 'nova_mail@mail.com')
             ->expectsQuestion('Please enter a Laravel Nova\'s admin password', '654321')
             ->expectsOutput('README generated successfully!')
+            ->expectsConfirmation('Would you use Renovate dependabot?', 'yes')
+            ->expectsQuestion('Please type username of the project reviewer', 'reviewer')
             ->expectsConfirmation('Do you want to install media package?', 'yes')
             ->expectsConfirmation('Do you want to uninstall project-initializator package?', 'yes')
             ->assertExitCode(0);
diff --git a/tests/fixtures/InitCommandTest/default_readme.md b/tests/fixtures/InitCommandTest/default_readme.md
@@ -80,4 +80,4 @@ Laravel Telescope access:
 
 Laravel Nova access:
 - email `mail@mail.com`
-- password `123456`
+- password `123456`
diff --git a/tests/fixtures/InitCommandTest/default_readme_after_using_renovate.md b/tests/fixtures/InitCommandTest/default_readme_after_using_renovate.md
@@ -0,0 +1,87 @@
+# My App
+
+This project implements an API for the My App Multiplatform app.
+
+## Project Resources & Contacts
+
+This section provides quick links to various resources and contacts associated
+with this project. It's here to streamline your navigation and communication
+process, so you can efficiently find what you need or reach out to who you need.
+
+### Resources
+
+Below are links to tools and services used in this project:
+- [Issue Tracker](): Here, you can report any issues or bugs related to the project. (will be added later)
+- [Figma](): This is where we maintain all our design assets and mock-ups. (will be added later)
+- [Sentry](): To monitor application performance and error tracking. (will be added later)
+- [DataDog](): This is where we monitor our logs, and server performance, and receive alerts. (will be added later)
+- [ArgoCD](): Is a kubernetes controller which continuously monitors running applications. (will be added later)
+- [Laravel Telescope](): This is debug assistant for the Laravel framework. (will be added later)
+- [Laravel Nova](): This is admin panel for the Laravel framework. (will be added later)
+- [API Documentation](https://mysite.com)
+
+### Contacts
+
+Should you need assistance or have questions, feel free to connect with the following individuals:
+- Manager: If you have any high-level project concerns, feel free to get in touch with our project manager. [Connect with Manager](mailto::manager_link)
+- Code Owner/Team Lead: For specific questions about the codebase or technical aspects, reach out to our team lead. [Connect with Team Lead](mailto::team_lead_link)
+
+Please be mindful of each individual's preferred contact method and office hours.
+
+## Prerequisites
+
+To work with this repository, you will need to have the following
+installed:
+
+- [Docker](https://www.docker.com)
+
+## Getting Started
+
+To get started with this repository, follow these steps:
+
+Clone this repository to your local machine:
+
+```sh
+git clone https://github.com/ronasit/laravel-helpers.git
+```
+
+Open project directory:
+
+```sh
+cd laravel-helpers
+```
+
+Build and start containers, it may takes some time:
+
+```sh
+docker compose up -d
+```
+
+## Environments
+
+This repository by default supports three environments: `local`, `development`,
+and `testing`. Each environment is represented by an appropriate environment file:
+
+| Environment | File | URL                                  |
+| --- | --- |--------------------------------------|
+| local | .env | [http://localhost](http://localhost) |
+| testing | .env.testing | -                                    |
+| development | .env.development | [https://mysite.com](https://mysite.com)               |
+
+## Credentials and Access
+
+Default admin access:
+- email `mail@mail.com`
+- password `123456`
+
+Laravel Telescope access:
+- email `mail@mail.com`
+- password `123456`
+
+Laravel Nova access:
+- email `mail@mail.com`
+- password `123456`
+
+### Renovate
+
+The application uses Renovate dependabot for automatically updating dependencies. You can configure it more precisely using the `renovate.json` file. Available configuration described here https://docs.renovatebot.com/config-overview
diff --git a/tests/fixtures/InitCommandTest/full_readme.md b/tests/fixtures/InitCommandTest/full_readme.md
@@ -80,4 +80,4 @@ Laravel Telescope access:
 
 Laravel Nova access:
 - email `nova_mail@mail.com`
-- password `654321`
+- password `654321`
diff --git a/tests/fixtures/InitCommandTest/full_readme_after_using_renovate.md b/tests/fixtures/InitCommandTest/full_readme_after_using_renovate.md
diff --git a/tests/fixtures/InitCommandTest/renovate.json b/tests/fixtures/InitCommandTest/renovate.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+### Renovate`
	`2`	`+`
	`3`	+The application uses Renovate dependabot for automatically updating dependencies. You can configure it more precisely using the `renovate.json` file. Available configuration described here https://docs.renovatebot.com/config-overview