Fspw 708

[MatteoDelOmbra]

Please review my changes :)

Summary by CodeRabbit

• Version Update

  • Package version bumped to 1.8.0

• Documentation

  • README.md now included in package distribution

• Tests

  • Enhanced test infrastructure and coverage

[coderabbitai]

Walkthrough

The changes introduce environment variable support for tests via dotenv configuration, refactor the test structure by replacing the old unit test with a new functional test, and update the package manifest with version bump and metadata improvements.

Changes

Cohort / File(s)	Summary
Test Environment Configuration Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/.env.example, Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/Frends.Echo.Execute.Tests.csproj, Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/TestBase.cs	Added .env.example template with FRENDS_SECRET_KEY placeholder, added dotenv.net NuGet package, and created new TestBase abstract class that loads environment variables via DotEnv.Load() and exposes SecretKey property to derived test classes.
Test Refactoring Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/UnitTests.cs, Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/FunctionalTests.cs	Removed existing UnitTests.cs and replaced with FunctionalTests.cs that inherits from TestBase, providing functional test coverage for the Echo.Execute method with identical test logic.
Package Manifest Update FrendsTaskTemplate.csproj	Bumped PackageVersion to 1.8.0, added PackageReadmeFile element, removed IncludeBuildOutput and NoDefaultExcludes settings, and extended content exclusions to include .idea directories.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

Possibly related PRs

• Simplify template parameters to single FullTaskName, add analyzer and… #12 — Modifies task internals and related test configuration, sharing test infrastructure patterns
• refactor #13 — Modifies test project structure and test scaffolding with overlapping test file changes

Suggested reviewers

• MichalFrends1

Poem

🐰 Whiskers twitch with dotenv delight,
Secrets loaded from files so right,
Tests refactored with TestBase grace,
Functional checks set a cleaner pace,
Version bumped—1.8 takes flight! 📦✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Title check	❓ Inconclusive	The title 'Fspw 708' appears to be a ticket/issue reference but lacks clarity about what changes are being made. It does not convey meaningful information about the actual modifications to the codebase.	Consider using a more descriptive title that explains the main purpose of changes, such as 'Add environment variable support and refactor tests' or 'Configure secret key loading for test environment'.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fspw-708

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In `@Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/.env.example`:
- Around line 1-2: The .env example triggers a dotenv-linter QuoteCharacter
warning for the FRENDS_SECRET_KEY entry; remove the surrounding double quotes
from the value so the line reads FRENDS_SECRET_KEY=example (update the
Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/.env.example file
and ensure the FRENDS_SECRET_KEY variable uses no quotes).

In
`@Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/IntegrationTests.cs`:
- Around line 10-14: The test TestEnvironmentVariables currently passes the
secret value SecretKey as the assertion message, which can leak it into CI logs;
update the assertion in TestEnvironmentVariables to not include SecretKey as the
message — either remove the third parameter entirely or replace it with a
non-sensitive string such as "SecretKey does not match expected value" so the
assertion uses Assert.That(SecretKey, Is.EqualTo("example")) or
Assert.That(SecretKey, Is.EqualTo("example"), "SecretKey does not match expected
value").

In `@Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/TestBase.cs`:
- Around line 4-14: The TestBase class is declared under the wrong namespace
(currently "Frends.Xml.Write.Tests") so test runners can't find it; change the
namespace declaration to "Frends.Echo.Execute.Tests" to match the test project
and make TestBase discoverable, ensuring the class name TestBase and its
constructor/signature remain unchanged.

🧹 Nitpick comments (1)

Frends.Template/Frends.Echo.Execute/Frends.Echo.Execute.Tests/Frends.Echo.Execute.Tests.csproj (1)

15-18: Pin dotenv.net to an exact version for reproducible builds.

Line 18 uses 4.*, which can pull in unexpected changes. Use 4.0.0, the latest stable version, for deterministic builds.

🔧 Suggested change

-        <PackageReference Include="dotenv.net" Version="4.*"/>
+        <PackageReference Include="dotenv.net" Version="4.0.0"/>