Add comprehensive unit tests for AlyaNum with enhanced assertion helpers for detailed test output by Copilot · Pull Request #4 · evilbocchi/alyanum

Copilot · 2025-08-01T02:57:01Z

This PR adds a comprehensive test suite for the AlyaNum library, expanding the existing 20 tests to 68 comprehensive unit tests that thoroughly validate mathematical properties, large number operations, and edge cases.

What's Added

Mathematical Property Tests (12 tests)

Identity properties: Additive identity (a + 0 = a), multiplicative identity (a × 1 = a), exponentiation identity (a^1 = a, a^0 = 1)
Commutativity: Addition (a + b = b + a), multiplication (a × b = b × a), including tests with large numbers
Associativity: Addition ((a + b) + c = a + (b + c)), multiplication ((a × b) × c = a × (b × c))
Distributivity: Multiplication over addition (a × (b + c) = (a × b) + (a × c))
Inverse operations: Addition/subtraction, multiplication/division, power/root reversibility

Large Number Tests (18 tests)

Tests operations with numbers approaching the 10^^^^10 safe limit mentioned in the code:

Tetration (^^): 2^^3 = 16, 2^^4 = 65536, and larger towers
Pentation (^^^): 2^^^3 and higher-order operations
Hexation (^^^^): 2^^^^3 and extreme hyperoperations
Googol-scale operations: 10^100 and beyond
Scientific notation: 1e1000+ numbers
Extreme numbers: Testing the library's upper bounds with heptation levels

Edge Cases and Boundary Conditions (18 tests)

Zero behavior: 0 + a, 0 × a, 0^a, a^0 across all operations
Negative numbers: Sign handling in arithmetic and hyperoperations
Very small numbers: 1e-100 precision handling
One in hyperoperations: 1^^a, 1^^^a, 1^^^^a edge cases
String parsing: Various formats including scientific notation
Comparison operations: Equality, less than, greater than with edge values

Enhanced Test Infrastructure

Added detailed assertion helper functions that provide informative error messages instead of generic assertion failures:

-- Before: Generic assertion failure
assert(a:moreThan(b), "should be greater")
-- Output: assertion failed

-- After: Detailed assertion with values
assertMoreThan(a, b, "should be greater")
-- Output: Expected E(100)1K > E(100)2K: should be greater

The new assertion helpers include:

assertEquals(actual, expected, msg): Shows "Expected X, got Y" for AlyaNum equality
assertMoreThan(actual, expected, msg): Shows "Expected X > Y" when greater-than fails
assertLessThan(actual, expected, msg): Shows "Expected X < Y" when less-than fails
assertMoreEquals/assertLessEquals: For >= and <= comparisons with detailed output

Why This Matters

The AlyaNum library handles numbers up to 10^^^^^10 (heptation), which is astronomically large. This enhanced test suite ensures:

Mathematical correctness at extreme scales
Proper hyperoperation behavior (tetration, pentation, hexation)
Robust edge case handling for real-world usage
String conversion reliability for display purposes
Better debugging with detailed assertion failure messages showing actual vs expected values

Example test demonstrating the enhanced assertions:

addTest("commutativity: large numbers", function()
    local a = AlyaNum.new(1e100)
    local b = AlyaNum.new(1e150)
    assertEquals(a:add(b), b:add(a), "large a + b should equal b + a")
    assertEquals(a:mul(b), b:mul(a), "large a * b should equal b * a")
end)

This ensures the AlyaNum library maintains mathematical rigor even when working with numbers that exceed the capabilities of standard floating-point arithmetic by many orders of magnitude, while providing clear debugging information when tests fail.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

… and large number support Co-authored-by: evilbocchi <71329833+evilbocchi@users.noreply.github.com>

evilbocchi · 2025-08-01T03:20:24Z

Create helper functions like assertMoreThan/assertLessThan/etc. instead of assert for more detailed test outputs

Co-authored-by: evilbocchi <71329833+evilbocchi@users.noreply.github.com>

Copilot · 2025-08-01T03:30:40Z

Create helper functions like assertMoreThan/assertLessThan/etc. instead of assert for more detailed test outputs

I've added detailed assertion helper functions to replace generic assert() calls with more informative test outputs. The new helpers include:

assertEquals(actual, expected, msg) - Shows "Expected X, got Y"
assertMoreThan(actual, expected, msg) - Shows "Expected X > Y"
assertLessThan(actual, expected, msg) - Shows "Expected X < Y"
assertMoreEquals/assertLessEquals for >= and <= comparisons

These now provide detailed error messages with actual AlyaNum values instead of generic assertion failures. For example, instead of just "assertion failed", you now get outputs like "Expected E(100)2K > E(100)1K: large a + b should equal b + a".

Committed in 3dca1b5.

Eliminated the unused 'minMult' variable from the add function in init.luau to clean up the code and improve readability.

Eliminated an unnecessary print statement that output file contents during test execution. This cleans up the test runner output.

Added descriptive comments to constants related to number formatting and float64 limits in init.luau for improved code clarity and maintainability.

Improves AlyaNum.fromString to correctly handle scientific notation, including negative exponents and mantissas. Updates tests to use more accurate representations of large numbers, adjusts assertions for edge cases, and relaxes string parsing tolerance for very large or small numbers.

coderabbitai · 2025-08-01T05:53:11Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Pull Request Overview

This PR significantly expands the AlyaNum library's test suite from 20 to 68 comprehensive unit tests, adding thorough validation for mathematical properties, large number operations, and edge cases. The changes enhance test coverage for numbers up to 10^^^^^10 (heptation level) and improve debugging capabilities.

Key changes:

Added 48 new comprehensive unit tests covering mathematical properties, large numbers, and edge cases
Introduced enhanced assertion helper functions that provide detailed error messages with actual vs expected values
Removed debug print statement from test runner for cleaner output

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 13 comments.

File	Description
testRunner.luau	Removed debug print statement to clean up test output
test/tests.luau	Added 48 new tests and 5 enhanced assertion helper functions for better test diagnostics
src/init.luau	Refactored scientific notation parsing logic and improved variable naming

Copilot · 2025-08-01T05:55:57Z

+
+function assertMoreThan(actual, expected, msg)
+	if not actual:moreThan(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " > " .. tostring(expected:toString()), 2)


The double tostring() call is redundant since toString() already returns a string. Consider using (msg or "") .. " Expected " .. actual:toString() .. " > " .. expected:toString()

Suggested change

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " > " .. tostring(expected:toString()), 2)

error((msg or "") .. " Expected " .. actual:toString() .. " > " .. expected:toString(), 2)

Copilot · 2025-08-01T05:55:57Z

+		error((msg or "") .. " Expected " .. tostring(expected:toString()) .. ", got " .. tostring(actual:toString()), 2)
+	end
+end
+
+function assertMoreThan(actual, expected, msg)
+	if not actual:moreThan(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " > " .. tostring(expected:toString()), 2)
+	end
+end
+
+function assertLessThan(actual, expected, msg)
+	if not actual:lessThan(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " < " .. tostring(expected:toString()), 2)
+	end
+end
+
+function assertMoreEquals(actual, expected, msg)
+	if not actual:moreEquals(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " >= " .. tostring(expected:toString()), 2)
+	end
+end
+
+function assertLessEquals(actual, expected, msg)
+	if not actual:lessEquals(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " <= " .. tostring(expected:toString()), 2)


The double tostring() call is redundant since toString() already returns a string. Consider using (msg or "") .. " Expected " .. actual:toString() .. " < " .. expected:toString()

Suggested change

error((msg or "") .. " Expected " .. tostring(expected:toString()) .. ", got " .. tostring(actual:toString()), 2)

end

end

function assertMoreThan(actual, expected, msg)

if not actual:moreThan(expected) then

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " > " .. tostring(expected:toString()), 2)

end

end

function assertLessThan(actual, expected, msg)

if not actual:lessThan(expected) then

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " < " .. tostring(expected:toString()), 2)

end

end

function assertMoreEquals(actual, expected, msg)

if not actual:moreEquals(expected) then

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " >= " .. tostring(expected:toString()), 2)

end

end

function assertLessEquals(actual, expected, msg)

if not actual:lessEquals(expected) then

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " <= " .. tostring(expected:toString()), 2)

error((msg or "") .. " Expected " .. expected:toString() .. ", got " .. actual:toString(), 2)

end

end

function assertMoreThan(actual, expected, msg)

if not actual:moreThan(expected) then

error((msg or "") .. " Expected " .. actual:toString() .. " > " .. expected:toString(), 2)

end

end

function assertLessThan(actual, expected, msg)

if not actual:lessThan(expected) then

error((msg or "") .. " Expected " .. actual:toString() .. " < " .. expected:toString(), 2)

end

end

function assertMoreEquals(actual, expected, msg)

if not actual:moreEquals(expected) then

error((msg or "") .. " Expected " .. actual:toString() .. " >= " .. expected:toString(), 2)

end

end

function assertLessEquals(actual, expected, msg)

if not actual:lessEquals(expected) then

error((msg or "") .. " Expected " .. actual:toString() .. " <= " .. expected:toString(), 2)

Copilot · 2025-08-01T05:55:57Z

+		error((msg or "") .. " Expected " .. tostring(expected:toString()) .. ", got " .. tostring(actual:toString()), 2)
+	end
+end
+
+function assertMoreThan(actual, expected, msg)
+	if not actual:moreThan(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " > " .. tostring(expected:toString()), 2)
+	end
+end
+
+function assertLessThan(actual, expected, msg)
+	if not actual:lessThan(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " < " .. tostring(expected:toString()), 2)
+	end
+end
+
+function assertMoreEquals(actual, expected, msg)
+	if not actual:moreEquals(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " >= " .. tostring(expected:toString()), 2)
+	end
+end
+
+function assertLessEquals(actual, expected, msg)
+	if not actual:lessEquals(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " <= " .. tostring(expected:toString()), 2)


The double tostring() call is redundant since toString() already returns a string. Consider using (msg or "") .. " Expected " .. actual:toString() .. " >= " .. expected:toString()

Suggested change

error((msg or "") .. " Expected " .. tostring(expected:toString()) .. ", got " .. tostring(actual:toString()), 2)

end

end

function assertMoreThan(actual, expected, msg)

if not actual:moreThan(expected) then

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " > " .. tostring(expected:toString()), 2)

end

end

function assertLessThan(actual, expected, msg)

if not actual:lessThan(expected) then

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " < " .. tostring(expected:toString()), 2)

end

end

function assertMoreEquals(actual, expected, msg)

if not actual:moreEquals(expected) then

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " >= " .. tostring(expected:toString()), 2)

end

end

function assertLessEquals(actual, expected, msg)

if not actual:lessEquals(expected) then

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " <= " .. tostring(expected:toString()), 2)

error((msg or "") .. " Expected " .. expected:toString() .. ", got " .. actual:toString(), 2)

end

end

function assertMoreThan(actual, expected, msg)

if not actual:moreThan(expected) then

error((msg or "") .. " Expected " .. actual:toString() .. " > " .. expected:toString(), 2)

end

end

function assertLessThan(actual, expected, msg)

if not actual:lessThan(expected) then

error((msg or "") .. " Expected " .. actual:toString() .. " < " .. expected:toString(), 2)

end

end

function assertMoreEquals(actual, expected, msg)

if not actual:moreEquals(expected) then

error((msg or "") .. " Expected " .. actual:toString() .. " >= " .. expected:toString(), 2)

end

end

function assertLessEquals(actual, expected, msg)

if not actual:lessEquals(expected) then

error((msg or "") .. " Expected " .. actual:toString() .. " <= " .. expected:toString(), 2)

Copilot · 2025-08-01T05:55:58Z

+
+function assertLessEquals(actual, expected, msg)
+	if not actual:lessEquals(expected) then
+		error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " <= " .. tostring(expected:toString()), 2)


The double tostring() call is redundant since toString() already returns a string. Consider using (msg or "") .. " Expected " .. actual:toString() .. " <= " .. expected:toString()

Suggested change

error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " <= " .. tostring(expected:toString()), 2)

error((msg or "") .. " Expected " .. actual:toString() .. " <= " .. expected:toString(), 2)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Initial plan

ed6f351

Copilot AI assigned Copilot and evilbocchi Aug 1, 2025

Copilot started work on behalf of evilbocchi August 1, 2025 02:57 View session

Add comprehensive unit tests for AlyaNum with mathematical properties…

b3e3618

… and large number support Co-authored-by: evilbocchi <71329833+evilbocchi@users.noreply.github.com>

Copilot AI requested a review from evilbocchi August 1, 2025 03:14

Copilot finished work on behalf of evilbocchi August 1, 2025 03:14

Copilot started work on behalf of evilbocchi August 1, 2025 03:20 View session

Copilot AI and others added 2 commits August 1, 2025 03:29

Add detailed assertion helper functions for better test output

5d2fcdd

Co-authored-by: evilbocchi <71329833+evilbocchi@users.noreply.github.com>

Update .gitignore to exclude lune binary files

3dca1b5

Co-authored-by: evilbocchi <71329833+evilbocchi@users.noreply.github.com>

Copilot AI changed the title ~~Add comprehensive unit tests for AlyaNum mathematical properties and large number operations~~ Add comprehensive unit tests for AlyaNum with enhanced assertion helpers for detailed test output Aug 1, 2025

Copilot finished work on behalf of evilbocchi August 1, 2025 03:31

evilbocchi added 4 commits August 1, 2025 13:18

Remove unused variable in add function

88093bf

Eliminated the unused 'minMult' variable from the add function in init.luau to clean up the code and improve readability.

Remove debug print from test runner

80e80b3

Eliminated an unnecessary print statement that output file contents during test execution. This cleans up the test runner output.

Add documentation comments for numeric constants

acafe66

Added descriptive comments to constants related to number formatting and float64 limits in init.luau for improved code clarity and maintainability.

evilbocchi marked this pull request as ready for review August 1, 2025 05:53

evilbocchi requested a review from Copilot August 1, 2025 05:53

Copilot AI reviewed Aug 1, 2025

View reviewed changes

evilbocchi and others added 7 commits August 1, 2025 14:01

Update test/tests.luau

1fc5bf9

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

49b9ef0

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

6d7a8c0

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

d168581

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

54d08a2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

6317924

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

ae0491b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

evilbocchi and others added 2 commits August 1, 2025 14:04

Apply suggestion from @Copilot

256a3c6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @Copilot

a278717

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

evilbocchi merged commit 2986717 into main Aug 1, 2025
3 checks passed

	error((msg or "") .. " Expected " .. tostring(actual:toString()) .. " > " .. tostring(expected:toString()), 2)
	error((msg or "") .. " Expected " .. actual:toString() .. " > " .. expected:toString(), 2)

Conversation

Copilot AI commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What's Added

Mathematical Property Tests (12 tests)

Large Number Tests (18 tests)

Edge Cases and Boundary Conditions (18 tests)

Enhanced Test Infrastructure

Why This Matters

Uh oh!

evilbocchi commented Aug 1, 2025

Uh oh!

Copilot AI commented Aug 1, 2025

Uh oh!

coderabbitai Bot commented Aug 1, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Aug 1, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)