Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Козлов Данил #228

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Козлов Данил #228

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
da2fc5c
refactored tests
SenyaPevko Nov 26, 2023
a703de1
refactored after reseting branch
SenyaPevko Nov 28, 2023
dc64fc8
refactored after feedback 2
SenyaPevko Nov 28, 2023
55a9716
refactored after feedback 3
SenyaPevko Nov 28, 2023
b50bce9
added tests
SenyaPevko Nov 29, 2023
02eaf46
added tests and refactored
SenyaPevko Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cs/HomeExercises/HomeExercises.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<PackageReference Include="JetBrains.Annotations" Version="2020.1.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.7.1" />
<PackageReference Include="NUnit" Version="3.12.0" />
<PackageReference Include="NUnit3TestAdapter" Version="3.17.0" />
<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
</ItemGroup>

</Project>
235 changes: 163 additions & 72 deletions cs/HomeExercises/NumberValidatorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,80 +1,171 @@
using System;
using System.Text.RegularExpressions;
using FluentAssertions;
using FluentAssertions.Execution;
using NUnit.Framework;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics.Contracts;

namespace HomeExercises
{
public class NumberValidatorTests
{
[Test]
public void Test()
{
Assert.Throws<ArgumentException>(() => new NumberValidator(-1, 2, true));
Assert.DoesNotThrow(() => new NumberValidator(1, 0, true));
Assert.Throws<ArgumentException>(() => new NumberValidator(-1, 2, false));
Assert.DoesNotThrow(() => new NumberValidator(1, 0, true));

Assert.IsTrue(new NumberValidator(17, 2, true).IsValidNumber("0.0"));
Assert.IsTrue(new NumberValidator(17, 2, true).IsValidNumber("0"));
Assert.IsTrue(new NumberValidator(17, 2, true).IsValidNumber("0.0"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("00.00"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("-0.00"));
Assert.IsTrue(new NumberValidator(17, 2, true).IsValidNumber("0.0"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("+0.00"));
Assert.IsTrue(new NumberValidator(4, 2, true).IsValidNumber("+1.23"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("+1.23"));
Assert.IsFalse(new NumberValidator(17, 2, true).IsValidNumber("0.000"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("-1.23"));
Assert.IsFalse(new NumberValidator(3, 2, true).IsValidNumber("a.sd"));
}
}

public class NumberValidator
{
private readonly Regex numberRegex;
private readonly bool onlyPositive;
private readonly int precision;
private readonly int scale;

public NumberValidator(int precision, int scale = 0, bool onlyPositive = false)
{
this.precision = precision;
this.scale = scale;
this.onlyPositive = onlyPositive;
if (precision <= 0)
throw new ArgumentException("precision must be a positive number");
if (scale < 0 || scale >= precision)
throw new ArgumentException("precision must be a non-negative number less or equal than precision");
numberRegex = new Regex(@"^([+-]?)(\d+)([.,](\d+))?$", RegexOptions.IgnoreCase);
}

public bool IsValidNumber(string value)
{
// Проверяем соответствие входного значения формату N(m,k), в соответствии с правилом,
// описанным в Формате описи документов, направляемых в налоговый орган в электронном виде по телекоммуникационным каналам связи:
// Формат числового значения указывается в виде N(m.к), где m – максимальное количество знаков в числе, включая знак (для отрицательного числа),
// целую и дробную часть числа без разделяющей десятичной точки, k – максимальное число знаков дробной части числа.
// Если число знаков дробной части числа равно 0 (т.е. число целое), то формат числового значения имеет вид N(m).

if (string.IsNullOrEmpty(value))
return false;

var match = numberRegex.Match(value);
if (!match.Success)
return false;

// Знак и целая часть
var intPart = match.Groups[1].Value.Length + match.Groups[2].Value.Length;
// Дробная часть
var fracPart = match.Groups[4].Value.Length;

if (intPart + fracPart > precision || fracPart > scale)
return false;

if (onlyPositive && match.Groups[1].Value == "-")
return false;
return true;
}
}
[TestFixture]
public class NumberValidatorTests
{
private static IEnumerable<TestCaseData> IsValidNumberPrecisionTests = new []
{
new TestCaseData(3, 2, true, "+0.00").Returns(false)
.SetName("False_WhenSymbolWithNumberLengthGreaterThanPrecision"),
new TestCaseData(3, 2, true, "00.00").Returns(false)
.SetName("False_WhenIntPartWithFracPartGreaterThanPrecision"),

new TestCaseData(17, 2, true, "0").Returns(true)
.SetName("True_WhenNumberLengthNotGreaterThanPrecision"),
new TestCaseData(4, 2, true, "+1.23").Returns(true)
.SetName("True_WhenPositiveSymbolWithNumberLengthNotGreaterThanPrecision"),
new TestCaseData(4, 2, false, "-1.23").Returns(true)
.SetName("True_WhenNegativeSymbolWithNumberLengthNotGreaterThanPrecision")
};

private static IEnumerable<TestCaseData> IsValidNumberScaleTests = new []
{
new TestCaseData(17, 2, true, "0.000").Returns(false)
.SetName("False_WhenFracPartGreaterThanScale"),
new TestCaseData(17, 2, true, "0.0").Returns(true)
.SetName("True_WhenFracPartNotGreaterThanScale")
};

private static IEnumerable<TestCaseData> IsValidNumberBigNumbersTests = new[]
Copy link

@pakapik pakapik Nov 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Было бы правильнее назвать не BigNumbers, а LongNumbers, т.к. 1/3 в виде десятичной дроби - число длинное, но не большое). В то время, как Int64.MaxValue и большое, и длинное.

{
new TestCaseData(41, 2, true, $"{Int64.MaxValue}{Int64.MaxValue}").Returns(true)
.SetName("True_WhenGivenBigIntPart"),
new TestCaseData(41, 40, true, $"1,{Int64.MaxValue}{Int64.MaxValue}").Returns(true)
.SetName("True_WhenGivenBigFracPart"),
new TestCaseData(81, 80, true, $"{Int64.MaxValue}{Int64.MaxValue},{Int64.MaxValue}{Int64.MaxValue}")
.Returns(true).SetName("True_WhenGivenBigFractWithIntPart"),
new TestCaseData(1001, 1000, true, $"{1/3}").Returns(true)
.SetName("True_WhenGivenEndlessRationalNumber"),
new TestCaseData(1001, 1000, true, $"{Math.PI}").Returns(true)
.SetName("True_WhenGivenEndlessIrrationalNumber"),
new TestCaseData(2, 1, true, "01").Returns(true)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Этот же тест в IsValidNumberDiffrentFormsOfNumbersTests

.SetName("True_WhenGivenNumberInOtherNumberSystemThan10")
};

private static IEnumerable<TestCaseData> IsValidNumberDiffrentFormsOfNumbersTests = new[]
{
new TestCaseData(2, 1, true, "01").Returns(true)
Copy link

@pakapik pakapik Nov 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

В программировании относительно часто используется так же и шестнадцатеричная система, её тоже стоит добавить).

Двоичная как-то не очень выглядит. Глядя на тест я вижу, что валидатор считает число 01 верным. А если увеличить разрядность и написать 0001? Должно быть это зависит от передаваемых параметров?

.SetName("True_WhenGivenNumberInOtherNumberSystemThan10"),
new TestCaseData(8, 7, true, "1,23E+10").Returns(false)
.SetName("False_WhenGivenNumberInexponentialForm")
};

private static IEnumerable<TestCaseData> IsValidNumberPositivityTests = new []
{
new TestCaseData(3, 2, true, "-0.00").Returns(false)
.SetName("False_WhenAcceptsOnlyPositiveButGivenNegativeNumber"),
new TestCaseData(3, 2, false, "-0.0").Returns(true)
.SetName("True_WhenAcceptsAnyAndGivenNegativeNumber")
};

private static IEnumerable<TestCaseData> IsValidNumberSymbolsTests = new []
{
new TestCaseData(3, 2, true, "1,2").Returns(true).SetName("True_WhenSeparatorIsComma"),

new TestCaseData(3, 2, true, "1;2").Returns(false).SetName("False_WhenSeparatorIsNotCommaOrDot"),
new TestCaseData(3, 2, true, "1.,2").Returns(false).SetName("False_WhenStringContainsMoreThanOneSeparator"),
new TestCaseData(3, 2, true, "\n").Returns(false).SetName("False_WhenGivenSpecialCharacter"),
new TestCaseData(3, 2, true, ",").Returns(false).SetName("False_WhenOnlySeparatorGiven"),
new TestCaseData(3, 2, true, "1a").Returns(false).SetName("False_WhenGivenLetterAfterDigit"),
new TestCaseData(3, 2, true, "a1").Returns(false).SetName("False_WhenGivenDigitAfterLetter"),
new TestCaseData(3, 2, true, null).Returns(false).SetName("False_WhenGivenNull"),
new TestCaseData(3, 2, true, "a.sd").Returns(false).SetName("False_WhenGivenNotDigits"),
new TestCaseData(3, 2, true, "#").Returns(false).SetName("False_WhenGivenNotDigitSymbol"),
new TestCaseData(17, 2, true, "").Returns(false).SetName("False_WhenEmptyStringGiven"),
new TestCaseData(17, 2, true, " ").Returns(false).SetName("False_WhenStringOfSpacesGiven")
};

[Pure]
Copy link

@pakapik pakapik Nov 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Pure] стоило прицепить на метод IsValidNumber, с тестами их юзать не стоит.

Атрибуты обычно стараются выравнивать по длине

Чтоб
Было вот так

В случае, когда были только источники данных, я пропускал этот момент, но [Repeat(5)] прям глаз режет)

[TestCaseSource(nameof(IsValidNumberPositivityTests))]
[TestCaseSource(nameof(IsValidNumberPrecisionTests))]
[TestCaseSource(nameof(IsValidNumberScaleTests))]
[TestCaseSource(nameof(IsValidNumberSymbolsTests))]
[TestCaseSource(nameof(IsValidNumberDiffrentFormsOfNumbersTests))]
[Repeat(5)]
[TestCaseSource(nameof(IsValidNumberBigNumbersTests))]
public bool IsValidNumber_Returns(int precision, int scale, bool onlyPositive, string number) =>
new NumberValidator(precision, scale, onlyPositive).IsValidNumber(number);


private static IEnumerable<TestCaseData> ConstructorArgumentExceptions = new[]
{
new TestCaseData(-1, 2, true).SetName("WhenPercisionNotPositive"),
new TestCaseData(1, 2, true).SetName("WhenScaleGreaterThanPercision"),
new TestCaseData(1, -1, true).SetName("WhenScaleNotPositive"),
new TestCaseData(1, 1, true).SetName("WhenScaleEqualsPercision")
};

[Pure]
[TestCaseSource(nameof(ConstructorArgumentExceptions))]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Найс. После рефакторинга видно, что источник данных для теста с конструктором слишком далеко от самого теста.

Давай протащим ConstructorArgumentExceptions ближе к тесту, который использует этот источник данных.

Да и в целом история хорошая, когда данные лежат как можно ближе к месту использования.

public void Constructor_ThrowsArgumentException(int precision, int scale, bool onlyPositive) =>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Возможно, стоит добавить тест, когда конструктор не кидает исключений.

Assert.Throws<ArgumentException>(() => new NumberValidator(precision, scale, onlyPositive));

[Test]
public void ValidatorState_ShouldStayUnchanged()
{
var validator = new NumberValidator(10, 9, true);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Нет структуры ААА - Arrange, Act, Assert. Если тест небольшой, то обычно просто пустыми строками разделяют. Если большой (либо есть желание), то дополнительно прям пишут, где какая секция, используя комментарии.

Тут писать комменты смысла нет, но логически всё равно стоит разделить.

var number = "1,2";
var resultBeforeChange = validator.IsValidNumber(number);
validator.IsValidNumber("00");
var resultAfterChange = validator.IsValidNumber(number);
resultAfterChange.Should().Be(resultBeforeChange);
}
}

public class NumberValidator
{
private readonly Regex numberRegex;
private readonly bool onlyPositive;
private readonly int precision;
private readonly int scale;

public NumberValidator(int precision, int scale = 0, bool onlyPositive = false)
{
this.precision = precision;
this.scale = scale;
this.onlyPositive = onlyPositive;
if (precision <= 0)
throw new ArgumentException("precision must be a positive number");
if (scale < 0 || scale >= precision)
throw new ArgumentException("precision must be a non-negative number less or equal than precision");
numberRegex = new Regex(@"^([+-]?)(\d+)([.,](\d+))?$", RegexOptions.IgnoreCase);
}

public bool IsValidNumber(string value)
{
// Проверяем соответствие входного значения формату N(m,k), в соответствии с правилом,
// описанным в Формате описи документов, направляемых в налоговый орган в электронном виде по телекоммуникационным каналам связи:
// Формат числового значения указывается в виде N(m.к), где m – максимальное количество знаков в числе, включая знак (для отрицательного числа),
// целую и дробную часть числа без разделяющей десятичной точки, k – максимальное число знаков дробной части числа.
// Если число знаков дробной части числа равно 0 (т.е. число целое), то формат числового значения имеет вид N(m).

if (string.IsNullOrEmpty(value))
return false;

var match = numberRegex.Match(value);
if (!match.Success)
return false;

// Знак и целая часть
var intPart = match.Groups[1].Value.Length + match.Groups[2].Value.Length;
// Дробная часть
var fracPart = match.Groups[4].Value.Length;

if (intPart + fracPart > precision || fracPart > scale)
return false;

if (onlyPositive && match.Groups[1].Value == "-")
return false;
return true;
}
}
}
Loading