diff --git a/.idea/.idea.resume builder/.idea/dataSources.xml b/.idea/.idea.resume builder/.idea/dataSources.xml
index 733ee45..3512eb9 100644
--- a/.idea/.idea.resume builder/.idea/dataSources.xml
+++ b/.idea/.idea.resume builder/.idea/dataSources.xml
@@ -8,5 +8,12 @@
jdbc:sqlite:$USER_HOME$/AppData/Local/resume.db
$ProjectFileDir$
+
+ sqlite.xerial
+ true
+ org.sqlite.JDBC
+ jdbc:sqlite:$PROJECT_DIR$/TestResumeBuilder/bin/Debug/net8.0/TestResumeBuilder.db
+ $ProjectFileDir$
+
\ No newline at end of file
diff --git a/.run/resume builder add job.run.xml b/.run/resume builder add job.run.xml
index d25d13e..02b7e13 100644
--- a/.run/resume builder add job.run.xml
+++ b/.run/resume builder add job.run.xml
@@ -1,8 +1,8 @@
-
+
-
+
@@ -12,7 +12,7 @@
-
+
diff --git a/TestResumeBuilder/AppTestBase.cs b/TestResumeBuilder/AppTestBase.cs
deleted file mode 100644
index 258f406..0000000
--- a/TestResumeBuilder/AppTestBase.cs
+++ /dev/null
@@ -1,26 +0,0 @@
-using resume_builder;
-using Spectre.Console.Testing;
-
-namespace TestResumeBuilder
-{
- //todo: find way to pass text to test command app for prompts
- public abstract class AppTestBase
- {
- internal CommandAppTester TestApp;
-
- public AppTestBase()
- {
- TestApp = new CommandAppTester();
- TestApp.Configure(Program.AppConfiguration);
- }
-
- protected CommandAppResult Run(IEnumerable cmdArgs, params string[] args) =>
- TestApp.Run(cmdArgs.Concat(args).ToArray());
-
- protected CommandAppResult Run(string cmd, params string[] args) =>
- Run(args.Prepend(cmd));
-
- protected CommandAppFailure RunAndCatch(IEnumerable cmdArgs, params string[] args)
- where T : Exception => TestApp.RunAndCatch(cmdArgs.Concat(args).ToArray());
- }
-}
\ No newline at end of file
diff --git a/TestResumeBuilder/TestBase.cs b/TestResumeBuilder/TestBase.cs
new file mode 100644
index 0000000..294ddbf
--- /dev/null
+++ b/TestResumeBuilder/TestBase.cs
@@ -0,0 +1,55 @@
+using resume_builder;
+using resume_builder.models;
+using Spectre.Console.Testing;
+
+namespace TestResumeBuilder
+{
+ //todo: find way to pass text to test command app for prompts
+ public abstract class TestBase: IDisposable, IAsyncDisposable
+ {
+ internal CommandAppTester TestApp;
+ internal ResumeContext TestDb;
+
+ public TestBase()
+ {
+ //given
+ TestApp = new CommandAppTester();
+ TestApp.Configure(Program.AppConfiguration);
+ TestDb = new ResumeContext();
+ }
+
+ public async ValueTask DisposeAsync()
+ {
+ TestDb.Jobs.RemoveRange(TestDb.Jobs);
+ TestDb.Projects.RemoveRange(TestDb.Projects);
+ TestDb.Profiles.RemoveRange(TestDb.Profiles);
+ TestDb.Companies.RemoveRange(TestDb.Companies);
+ TestDb.Skills.RemoveRange(TestDb.Skills);
+ await TestDb.SaveChangesAsync();
+ await TestDb.DisposeAsync();
+ GC.SuppressFinalize(this);
+ }
+
+ public void Dispose()
+ {
+ TestDb.Jobs.RemoveRange(TestDb.Jobs);
+ TestDb.Projects.RemoveRange(TestDb.Projects);
+ TestDb.Profiles.RemoveRange(TestDb.Profiles);
+ TestDb.Companies.RemoveRange(TestDb.Companies);
+ TestDb.Skills.RemoveRange(TestDb.Skills);
+ TestDb.SaveChanges();
+ TestDb.Dispose();
+
+ GC.SuppressFinalize(this);
+ }
+
+ protected CommandAppResult Run(IEnumerable cmdArgs, params string[] args) =>
+ TestApp.Run(cmdArgs.Concat(args).ToArray());
+
+ protected CommandAppResult Run(string cmd, params string[] args) =>
+ Run(args.Prepend(cmd));
+
+ protected CommandAppFailure RunAndCatch(IEnumerable cmdArgs, params string[] args)
+ where T : Exception => TestApp.RunAndCatch(cmdArgs.Concat(args).ToArray());
+ }
+}
\ No newline at end of file
diff --git a/TestResumeBuilder/TestData.cs b/TestResumeBuilder/TestData.cs
deleted file mode 100644
index 4989518..0000000
--- a/TestResumeBuilder/TestData.cs
+++ /dev/null
@@ -1,14 +0,0 @@
-using System;
-using System.Collections;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-using Bogus;
-
-namespace TestResumeBuilder;
-internal class TestData
-{
- static private Faker Faker { get; set; } = new();
- public static TheoryData RandomArgs() => [Faker.Random.WordsArray(2)];
-}
diff --git a/TestResumeBuilder/TestResumeBuilder.csproj b/TestResumeBuilder/TestResumeBuilder.csproj
index e44b9bd..9d27581 100644
--- a/TestResumeBuilder/TestResumeBuilder.csproj
+++ b/TestResumeBuilder/TestResumeBuilder.csproj
@@ -20,6 +20,7 @@
runtime; build; native; contentfiles; analyzers; buildtransitive
+
all
diff --git a/TestResumeBuilder/commands/InitTest.cs b/TestResumeBuilder/commands/InitTest.cs
index 3dd1d8b..9f8a968 100644
--- a/TestResumeBuilder/commands/InitTest.cs
+++ b/TestResumeBuilder/commands/InitTest.cs
@@ -1,22 +1,27 @@
+using resume_builder.models;
namespace TestResumeBuilder.commands;
-public class InitTest : AppTestBase
+public class InitTest: TestBase
{
[Fact]
public void Init_WithNoArgs_ShouldReturnSuccess()
{
+ //when
var result = TestApp.Run("init");
+ //then
Assert.Equal(0, result.ExitCode);
}
-
- [Theory]
- [MemberData(nameof(TestData.RandomArgs), MemberType = typeof(TestData))]
- public void Init_WithArgs_ShouldReturnSuccess(string[] args)
+ [Fact]
+ public void Init_WithNoArgs_ShouldCreateDb()
{
- Assert.True(true);
- //var result = Run("init", args);
- //Assert.That(result.ExitCode, Is.EqualTo(0));
+ //when
+ var result = TestApp.Run("init");
+ //then
+ Assert.True(File.Exists("TestResumeBuilder.db"));
+ Assert.Equal(0, result.ExitCode);
+ TestDb = new ResumeContext();
+ Assert.True(TestDb.Database.CanConnect());
}
}
\ No newline at end of file
diff --git a/TestResumeBuilder/commands/add/AddJobTest.cs b/TestResumeBuilder/commands/add/AddJobTest.cs
new file mode 100644
index 0000000..c0d6cb4
--- /dev/null
+++ b/TestResumeBuilder/commands/add/AddJobTest.cs
@@ -0,0 +1,132 @@
+using Bogus;
+using resume_builder;
+using resume_builder.cli.commands.add;
+using resume_builder.models;
+
+namespace TestResumeBuilder.commands.add;
+
+public class AddJobTest: TestBase
+{
+ static readonly string[] cmdArgs = ["add", "job"];
+
+ public static readonly TheoryData AddJobData =
+ new()
+ {
+ {
+ "jobTitle", "companyName", new DateOnly(2021, 1, 1), "jobDescription", "experience",
+ new DateOnly(2231, 1, 1)
+ }
+ };
+
+ [Fact(Skip =
+ "hangs forever (at least in vs2022) because it's expecting input in interactive mode which can't be emulated right now with its (spectre) test console")]
+ public void AddJob_WithNoArgs_ShouldFail()
+ {
+ //this hangs forever becuase a prompt is required
+ //and I have no idea how to inject a response to the app
+ //I added a timeout so it sould stop
+ var result = TestApp.Run(cmdArgs);
+ Assert.Equal(ExitCode.Error.ToInt(), result.ExitCode);
+ }
+
+ [Theory]
+ [MemberData(nameof(AddJobTestData.JobTitleAndStartDate), MemberType = typeof(AddJobTestData))]
+ public void AddJob_WithNameAndStartOptions_ShouldSucceed(string jobTitle, string companyName, DateOnly startDate)
+ {
+ //when
+ var result = TestApp.Run([.. cmdArgs, "-t", jobTitle, "-s", startDate.ToString(), "-c", companyName]);
+ var resultSettings = result.Settings as AddJobSettings;
+ //then
+ Assert.Multiple(() =>
+ {
+ Assert.Equal(0, result.ExitCode);
+ Assert.NotNull(resultSettings);
+ Assert.Equal(jobTitle, resultSettings.JobTitle);
+ Assert.Equal(companyName, resultSettings.Company);
+ Assert.Equal(startDate, resultSettings.StartDate);
+ });
+ }
+
+ [Theory]
+ [MemberData(nameof(AddJobTestData.AllOptions), MemberType = typeof(AddJobTestData))]
+ public void AddJob_WithAllOptions_ShouldSucceed(string jobTitle, string companyName, DateOnly startDate,
+ string? jobDescription, string? experience, DateOnly? endDate)
+ {
+ //? job description and experience are non-null because in the run it will be parsed/replaced with an empty string
+ // and users can't enter the null value
+ //which is to say they can choose to enter nothing with empty quotes which this test tests for too
+ //when
+ string[]? descriptionArg = jobDescription == null ? [null] : ["-d", $"{jobDescription}"];
+ string[]? expArg = experience == null ? [null] : ["-x", $"{experience}"];
+ string[]? endArg = endDate == null ? [null] : ["-e", $"{endDate}"];
+ List args =
+ [
+ ..cmdArgs, ..descriptionArg, ..expArg, ..endArg, "-t", jobTitle, "-s", startDate.ToString(), "-c",
+ companyName
+ ];
+ var result = Run(args.Where(x => x != null).ToArray()!);
+ var resultSettings = result.Settings as AddJobSettings;
+ //then
+ Assert.Equal(0, result.ExitCode);
+ Assert.NotNull(resultSettings);
+ Assert.Equal(jobTitle, resultSettings.JobTitle);
+ Assert.Equal(companyName, resultSettings.Company);
+ Assert.Equal(startDate, resultSettings.StartDate);
+ Assert.Equal(jobDescription, resultSettings.JobDescription);
+ Assert.Equal(experience, resultSettings.Experience);
+ Assert.Equal(endDate, resultSettings.EndDate);
+ }
+
+ [Theory]
+ [MemberData(nameof(AddJobData))]
+ [MemberData(nameof(AddJobTestData.AllOptions), MemberType = typeof(AddJobTestData))]
+ public void AddJob_WithAllOptions_ShouldUpdateDB(string jobTitle, string companyName, DateOnly startDate,
+ string? jobDescription, string? experience, DateOnly? endDate)
+ {
+ string[] descriptionArg = jobDescription == null ? [null] : [$"-d", $"{jobDescription}"];
+ string[] expArg = experience == null ? [null] : [$"-x", $"{experience}"];
+ string[] endArg = endDate == null ? [null] : [$"-e", $"{endDate}"];
+ string?[] args =
+ [
+ ..cmdArgs, "-t", jobTitle, "-s", startDate.ToString(), "-c", companyName, ..descriptionArg, ..expArg,
+ ..endArg
+ ];
+ var result = TestApp.Run(args.Where(x => x != null).ToArray()!);
+ Assert.Equal(0, result.ExitCode);
+ var job = TestDb.Jobs.First(j => j.Title == jobTitle && j.Company == companyName && j.StartDate == startDate);
+ Assert.NotNull(job);
+ //clean inputs; trim and nullify empty strings
+ jobDescription = jobDescription?.Trim();
+ companyName = companyName.Trim();
+ experience = experience?.Trim();
+ jobTitle = jobTitle.Trim();
+
+
+ Assert.Equal(jobTitle, job!.Title);
+ Assert.Equal(companyName, job.Company);
+ Assert.Equal(startDate, job.StartDate);
+ Assert.Equal(jobDescription.IsBlank() ? null : jobDescription, job.Description);
+ Assert.Equal(experience.IsBlank() ? null : experience, job.Experience);
+ Assert.Equal(endDate, job.EndDate);
+ }
+}
+
+internal class AddJobTestData: JobTestData
+{
+ public static TheoryData JobTitleAndStartDate()
+ {
+ var data = new TheoryData();
+ for(var i = TestRepetitions - 1; i >= 0; i--)
+ data.Add(RandomJobTitle(), RandomCompany(), RandomPastDate());
+ return data;
+ }
+
+ public static TheoryData AllOptions()
+ {
+ var data = new TheoryData();
+ for(var i = TestRepetitions - 1; i >= 0; i--)
+ data.Add(RandomJobTitle(), RandomCompany(), RandomPastDate(), WaffleOrNull(), WaffleOrNull(),
+ RandomFutureDate().OrNull(Faker));
+ return data;
+ }
+}
\ No newline at end of file
diff --git a/TestResumeBuilder/data/JobTestData.cs b/TestResumeBuilder/data/JobTestData.cs
new file mode 100644
index 0000000..70af122
--- /dev/null
+++ b/TestResumeBuilder/data/JobTestData.cs
@@ -0,0 +1,19 @@
+using Bogus;
+using resume_builder.models;
+
+namespace TestResumeBuilder;
+
+internal class JobTestData: TestData
+{
+ protected static Faker BogusJob { get; set; } = new Faker()
+ .RuleFor(job => job.Title, RandomJobTitle)
+ .RuleFor(job => job.Description, RandomTextOrNull)
+ .RuleFor(job => job.Experience, RandomTextOrNull)
+ .RuleFor(job => job.Company, RandomCompany)
+ .RuleFor(job => job.StartDate, RandomPastDate)
+ .RuleFor(job => job.EndDate, RandomEndDate);
+
+ public static string RandomJobTitle() => Faker.Name.JobTitle();
+ public static string RandomCompany() => Faker.Company.CompanyName();
+ public static DateOnly? RandomEndDate() => RandomPastDate().OrNull(Faker);
+}
\ No newline at end of file
diff --git a/TestResumeBuilder/data/TestData.cs b/TestResumeBuilder/data/TestData.cs
new file mode 100644
index 0000000..571de14
--- /dev/null
+++ b/TestResumeBuilder/data/TestData.cs
@@ -0,0 +1,38 @@
+using Bogus;
+using WaffleGenerator;
+
+namespace TestResumeBuilder;
+
+internal class TestData
+{
+ private protected const int TestRepetitions = 10;
+
+
+ private static Random Random { get; set; } = new();
+ protected static Faker Faker { get; set; } = new();
+
+ static private protected int MaxRandomYearsAfterToday()
+ {
+ DateOnly.MaxValue.Deconstruct(out var maxYear, out _, out _);
+ DateOnly.FromDateTime(DateTime.Today).Deconstruct(out var todayYear, out _, out _);
+ return maxYear - todayYear;
+ }
+
+ static private protected int MaxRandomYearsBeforeToday()
+ {
+ DateOnly.MinValue.Deconstruct(out var minYear, out _, out _);
+ DateOnly.FromDateTime(DateTime.Today).Deconstruct(out var todayYear, out _, out _);
+ return todayYear - minYear;
+ }
+
+ public static TheoryData RandomArgs() => [Faker.Random.WordsArray(2)];
+
+
+ public static DateOnly RandomPastDate() => Faker.Date.PastDateOnly(MaxRandomYearsBeforeToday());
+ public static DateOnly RandomFutureDate() => Faker.Date.FutureDateOnly(MaxRandomYearsAfterToday());
+ public static DateOnly RandomDate() => Faker.Date.BetweenDateOnly(RandomPastDate(), RandomFutureDate());
+ public static string? RandomTextOrNull() => Faker.Lorem.Paragraph().OrNull(Faker);
+
+ public static string Waffle() => WaffleEngine.Text(Random.Next(TestRepetitions), Faker.Random.Bool());
+ public static string? WaffleOrNull() => Waffle().OrNull(Faker);
+}
\ No newline at end of file
diff --git a/qodana.yaml b/qodana.yaml
index 99a40de..64e28d6 100644
--- a/qodana.yaml
+++ b/qodana.yaml
@@ -3,27 +3,48 @@
# https://www.jetbrains.com/help/qodana/qodana-yaml.html #
#-------------------------------------------------------------------------------#
version: "1.0"
-
#Specify inspection profile for code analysis
profile:
name: qodana.starter
-
#Enable inspections
#include:
# - name:
-
#Disable inspections
#exclude:
# - name:
# paths:
# -
-
#Execute shell command before Qodana execution (Applied in CI/CD pipeline)
#bootstrap: sh ./prepare-qodana.sh
-
#Install IDE plugins before Qodana execution (Applied in CI/CD pipeline)
#plugins:
# - id: #(plugin id can be found at https://plugins.jetbrains.com)
-
#Specify Qodana linter for analysis (Applied in CI/CD pipeline)
linter: jetbrains/qodana-dotnet:latest
+include:
+ - name: AutoPropertyCanBeMadeGetOnly.Global
+ - name: AutoPropertyCanBeMadeGetOnly.Local
+ - name: FieldCanBeMadeReadOnly.Global
+ - name: PublicConstructorInAbstractClass
+ - name: MemberCanBePrivate.Global
+ - name: PropertyCanBeMadeInitOnly.Global
+ - name: UseMethodAny.2
+ - name: ConvertIfStatementToReturnStatement
+ - name: MergeIntoPattern
+ - name: UseObjectOrCollectionInitializer
+ - name: ClassNeverInstantiated.Global
+ - name: RedundantAttributeParentheses
+ - name: RedundantIfElseBlock
+ - name: RedundantEmptyObjectCreationArgumentList
+ - name: UnusedMethodReturnValue.Global
+ - name: UnusedMember.Global
+ - name: UnusedParameter.Global
+ - name: VirtualMemberNeverOverridden.Global
+ - name: CA1860
+ - name: CA1827
+ - name: ArrangeModifiersOrder
+ - name: ArrangeRedundantParentheses
+ - name: ArrangeNamespaceBody
+ - name: ArrangeTrailingCommaInMultilineLists
+ - name: ArrangeObjectCreationWhenTypeEvident
+ - name: CheckDependencyLicenses
diff --git a/resume builder/Helpers.cs b/resume builder/Helpers.cs
index bfb9fcb..1350eb5 100644
--- a/resume builder/Helpers.cs
+++ b/resume builder/Helpers.cs
@@ -1,4 +1,5 @@
using System.Data.Common;
+using System.Diagnostics.CodeAnalysis;
using Microsoft.Data.Sqlite;
using resume_builder.cli.settings;
using resume_builder.models;
@@ -130,7 +131,8 @@ public static List Surround(this IEnumerable strings, string txt
///
/// string to check
/// true if the string is null, empty, or whitespace; otherwise false
- public static bool IsBlank(this string? s) => s == null || string.IsNullOrEmpty(s) || string.IsNullOrWhiteSpace(s);
+ public static bool IsBlank([NotNullWhen(false)] this string? s) =>
+ s == null || string.IsNullOrEmpty(s) || string.IsNullOrWhiteSpace(s);
#endregion
diff --git a/resume builder/cli/commands/add/AddJobCommand.cs b/resume builder/cli/commands/add/AddJobCommand.cs
index 3fe755c..7b9e0a0 100644
--- a/resume builder/cli/commands/add/AddJobCommand.cs
+++ b/resume builder/cli/commands/add/AddJobCommand.cs
@@ -45,16 +45,13 @@ public override int Execute([NotNull] CommandContext context, [NotNull] AddJobSe
endDate = AnsiConsole.Prompt(endDatePrompt);
}
- if(string.IsNullOrWhiteSpace(jobTitle))
- throw new ArgumentException("Job title is invalid, it cannot be empty");
-
var job = new Job()
{
Title = jobTitle,
Description = jobDescription,
Experience = experience,
Company = company,
- StartDate = (DateOnly)startDate!,
+ StartDate = (DateOnly)startDate,
EndDate = endDate
};
var db = new ResumeContext();
diff --git a/resume builder/models/Job.cs b/resume builder/models/Job.cs
index 66d4619..9cb30d4 100644
--- a/resume builder/models/Job.cs
+++ b/resume builder/models/Job.cs
@@ -1,18 +1,29 @@
using System.ComponentModel.DataAnnotations;
-using System.ComponentModel.DataAnnotations.Schema;
-using System.Data.Common;
+using System.Diagnostics.CodeAnalysis;
using System.Text;
-using Microsoft.Data.Sqlite;
namespace resume_builder.models;
public class Job
{
- private string? _company;
+ private string _company;
private string? _description;
private string? _experience;
private string _title;
+ public Job()
+ {
+ Id = Guid.NewGuid();
+ }
+
+ public Job(Guid id, string title, string company, DateOnly? startDate = null)
+ {
+ Id = id;
+ Title = title;
+ Company = company;
+ StartDate = startDate ?? Globals.Today;
+ }
+
public Guid Id { get; init; }
[MinLength(1, ErrorMessage = "Job title cannot be empty")]
@@ -21,15 +32,21 @@ public string Title
get => _title;
set
{
- ArgumentException.ThrowIfNullOrWhiteSpace(value);
- _title = Trim(value)!;
+ if(string.IsNullOrWhiteSpace(value))
+ throw new ArgumentException("Job title cannot be empty");
+ _title = Trim(value.ReplaceLineEndings(" - "));
}
}
-
- public string? Company
+
+ public string Company
{
get => _company;
- set => _company = Trim(value);
+ set
+ {
+ if(string.IsNullOrWhiteSpace(value))
+ throw new ArgumentException("Company name cannot be empty");
+ _company = Trim(value);
+ }
}
public DateOnly StartDate { get; set; }
@@ -47,29 +64,20 @@ public string? Experience
set => _experience = Trim(value);
}
- public Job()
- {
- Id = Guid.NewGuid();
- }
- public Job(string title, Guid id, DateOnly? startDate = null): this()
- {
- Title = title;
- StartDate = startDate ?? Globals.Today;
- }
-
+ [return: NotNullIfNotNull(nameof(value))]
private static string? Trim(string? value) =>
- string.IsNullOrWhiteSpace(value) ? null : value.ReplaceLineEndings(" - ").Trim();
+ string.IsNullOrWhiteSpace(value) ? null : value.Trim();
public override string ToString()
{
var stringBuilder = new StringBuilder();
stringBuilder.Append($"{Title} ({StartDate:yyyy-MM-dd} - ");
- if (EndDate == null)
+ if(EndDate == null)
stringBuilder.Append("present");
else
stringBuilder.Append($"{EndDate:yyyy-MM-dd}");
stringBuilder.Append(')');
- if (!string.IsNullOrWhiteSpace(Company))
+ if(!string.IsNullOrWhiteSpace(Company))
stringBuilder.Append($" @ {Company}");
return stringBuilder.ToString();
}
diff --git a/resume builder/models/ResumeContext.cs b/resume builder/models/ResumeContext.cs
index 15961b8..1f0ca8f 100644
--- a/resume builder/models/ResumeContext.cs
+++ b/resume builder/models/ResumeContext.cs
@@ -4,6 +4,17 @@ namespace resume_builder.models;
public class ResumeContext: DbContext
{
+ public ResumeContext()
+ {
+ const Environment.SpecialFolder folder = Environment.SpecialFolder.LocalApplicationData;
+ var path = Environment.GetFolderPath(folder);
+ #if DEBUG
+ DbPath = "TestResumeBuilder.db";
+ #else
+ DbPath = System.IO.Path.Join(path, "resume.db");
+ #endif
+ }
+
public DbSet Jobs { get; set; }
public DbSet Projects { get; set; }
public DbSet Profiles { get; set; }
@@ -12,13 +23,6 @@ public class ResumeContext: DbContext
public string DbPath { get; }
- public ResumeContext()
- {
- const Environment.SpecialFolder folder = Environment.SpecialFolder.LocalApplicationData;
- var path = Environment.GetFolderPath(folder);
- DbPath = System.IO.Path.Join(path, "resume.db");
- }
-
// The following configures EF to create a Sqlite database file in the
// special "local" folder for your platform.
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)