Files
Terminal.Gui/Tests/UnitTests/Views/GraphViewTests.cs
Copilot c5906c2dc1 #4329—Major Terminal.Gui v2 Architecture Modernization: Application Decoupling, Terminology Improvements, and Nullable Migration (#4338)
* Initial plan

* Add comprehensive terminology proposal for Application.Top/Toplevel renaming

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add terminology proposal summary document

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add before/after comparison document for terminology proposal

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add index document for terminology proposal

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add Mermaid diagrams visualizing the terminology proposal

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Move terminology docs to docfx/docs per CONTRIBUTING.md guidelines

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update terminology proposal to reflect recent modernization (post-MainLoop removal)

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update terminology proposal - validate against recent driver refactoring changes

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update proposal after massive v2_develop modernization - TopLevels now public, RunState→SessionToken

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update proposal: RunStack → SessionStack to align with SessionToken terminology

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 1: Core API rename - Application.Top→Current, TopLevels→SessionStack

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 2: Fix test compilation errors for renamed properties

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 3: Update documentation files with new terminology

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor generic type names and remove unused field

Renamed generic type parameters in `Dim` and `Pos` classes for clarity:
- `T` was renamed to `TDim` in `Dim.Has` method.
- `T` was renamed to `TPos` in `Pos.Has` method.
Updated type casting and pattern matching logic to reflect these changes.

Removed the unused `_stopAfterFirstIteration` field from the `ApplicationImpl` class to clean up the codebase.

* Increase minimum code coverage target to 75%

Updated the `codecov.yml` configuration file to raise the
`project.default.target` value from 70% to 75%, enforcing
stricter code coverage requirements for the overall project.

* Add comprehensive unit tests for ApplicationImpl Begin/End logic

Added ApplicationImplBeginEndTests with 16 tests covering:
- Begin/End argument validation
- SessionStack push/pop operations
- Current property management
- Balanced Begin/End enforcement
- Multiple nested Begin/End scenarios
- ResetState cleanup behavior
- Toplevel activation/deactivation
- SessionToken management

Tests validate the fragile state management logic in ApplicationImpl.Lifecycle.cs
and ApplicationImpl.Run.cs to catch regressions in Current/SessionStack handling.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Refactor ApplicationImplBeginEndTests to work with ApplicationImpl instances directly

Tests now:
- Create ApplicationImpl instances directly instead of using global Application
- Use try-finally blocks to ensure Shutdown() is always called
- Work with app.Init() and app.Shutdown() properly
- 13 of 16 tests passing (3 tests need adjustment for ResetState behavior)

Tests validate fragile Begin/End state management logic without polluting global Application state.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Fix ApplicationImplBeginEndTests: Remove explicit ResetState calls, rely on Shutdown

Per maintainer feedback:
- Tests should not call ResetState explicitly if they call Shutdown (Shutdown calls ResetState)
- Removed all explicit app.ResetState() calls from tests
- Tests now only call Shutdown in finally blocks for cleanup
- Ensured toplevels are disposed BEFORE Shutdown to satisfy DEBUG_IDISPOSABLE assertions
- Fixed test cleanup order to prevent ResetState assertion failures
- All 16 tests now pass successfully

ResetState is idempotent - the issue was tests calling it unnecessarily and with incorrect disposal ordering.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 1: Enable nullable by default, add directives to all files

- Added <Nullable>enable</Nullable> to Terminal.Gui.csproj
- Removed #nullable enable from 37 files (now redundant with project setting)
- Added #nullable disable to 170 files that don't have nullable enabled yet
- Build successful with 279 nullable warnings (expected)

Breakdown of files with #nullable disable:
- 27 in Views/ directory (will remain disabled per plan)
- 143 outside Views/ (need to be fixed in subsequent commits)

Next: Systematically fix nullable issues in non-View files.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Phase 2: Remove nullable disable from all non-View files - COMPLETE!

- Removed #nullable disable from 142 non-View files
- All non-View code is now nullable-enabled
- Build successful with 0 errors, only 1 unrelated warning
- Created NULLABLE_VIEWS_REMAINING.md documenting the 121 View files still with nullable disable

Nullable cleanup summary:
 App/: 25 files - nullable enabled
 Configuration/: 24 files - nullable enabled
 ViewBase/: 30 files - nullable enabled
 Drivers/: 25 files - nullable enabled
 Drawing/: 18 files - nullable enabled
 FileServices/: 7 files - nullable enabled
 Input/: 6 files - nullable enabled
 Text/: 5 files - nullable enabled
 Resources/: 3 files - nullable enabled
⏸️  Views/: 121 files - remain disabled (as requested)

Total: 143 files nullable-enabled, 121 View files remain disabled.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* WIP: fixing nullability issues.

* Fixed final nullability issues.

* Moved Arrangment tests

* Refactor and improve modularity across multiple classes

Refactored `FillRectangles` in `RegionScenario` and `Region` to accept an `IDriver` parameter, reducing reliance on global state. Updated `ApplicationImpl` to replace static method calls with instance methods for better encapsulation. Renamed `Toplevel` to `Current` in `IPopover` and related classes for clarity.

Simplified `LineCanvas` methods by removing unnecessary `IDriver` parameters. Added `Id` and `App` properties to `View` for better state management and unique identification. Streamlined the `Driver` property in `View` with a concise getter.

Improved formatting and consistency across files, including `Region` and `IntersectionRuneResolver`. Enhanced thread safety in `Region` and cleaned up redundant code. Updated tests to align with interface changes and ensure compatibility.

* Refactor to make IDriver dependency explicit

Updated `AnsiEscapeSequenceRequest.Send` to accept an `IDriver?` parameter, replacing reliance on `Application.Driver`. Refactored `AnsiRequestScheduler` methods (`SendOrSchedule`, `RunSchedule`, and private `Send`) to propagate the `IDriver?` parameter, ensuring explicit driver dependency.

Modified `DriverImpl.QueueAnsiRequest` to pass `this` to `SendOrSchedule`. Updated `AnsiRequestSchedulerTests` to reflect new method signatures, passing `null` for the driver parameter where applicable.

Added `<param>` documentation for new parameters to improve clarity. These changes enhance flexibility, maintainability, and testability by reducing reliance on global state and allowing driver substitution in tests.

* WIP: Started migrating to View.App

Refactored `ApplicationImpl` to ensure proper handling of the `App`
property for `Toplevel` instances, improving modularity. Replaced
direct references to `Application` with `App` in `Border`, `ShadowView`,
and other classes to enhance flexibility and maintainability.

Introduced `GetApp` in `View` to allow overrides for retrieving the
`App` instance. Updated `Adornment` to use this method. Moved mouse
event subscriptions in `Border` to `BeginInit` for proper lifecycle
management.

Updated unit tests in `ArrangementTests` to use `App.Mouse` instead of
`Application.Mouse`, ensuring alignment with the refactored design.
Added `BeginInit` and `EndInit` calls for proper initialization during
tests. Removed redundant code and improved test assertions.

* WIP: Next set of View.App changes

Updated `SetClipToScreen`, `SetClip`, and `GetClip` methods to accept an `IDriver` parameter, replacing reliance on the global `Application.Driver`. This improves modularity, testability, and reduces implicit global state usage.

- Updated `Driver` property in `View` to use `App?.Driver` as fallback.
- Refactored `DimAuto` to use `App?.Screen.Size` with a default for unit tests.
- Updated all test cases to align with the new method signatures.
- Performed general cleanup for consistency and readability.

* Adds View clip tests.

* Merged

* Merged

* wip

* Fixed test bug.

* Refactored Thickness.Draw to require driver.

* Made TextFormatter.Draw require driver.

* Code cleanup.

* Un did stoopid idea.

* Decouped Application.Navigation

* MASSIVE - Almost completely decoupled Application from View etc...

* Obsolete

* Missed some

* More cleanup and decoupling.

Refactor `ToString` and remove legacy code

Refactored `ToString` implementations across `Application`, `DriverImpl`, and `IDriver` to improve consistency and maintainability. Removed the legacy `ToString(IDriver? driver)` method and its associated references. Simplified `ToString` in `DriverImpl` to generate a string representation of the `Contents` buffer.

Replaced redundant XML documentation with `<inheritdoc/>` tags to reduce duplication. Cleaned up unused `global using` directives and removed deprecated methods and properties, including `Screen`, `SetCursorVisibility`, and `IsRuneSupported`.

Updated test cases in `GuiTestContext` and `DriverAssert` to use the new `ToString` implementation. Improved error messages for better debugging output. Streamlined LINQ queries and removed redundant checks for better readability and performance.

Enhanced maintainability by decluttering the codebase, aligning namespaces, and consolidating related changes.

* Changes before error encountered

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Update docfx/docs to document View.App architecture and instance-based patterns

Updated 16 documentation files to reflect the major architectural changes:

NEW FILES:
- application.md: Comprehensive deep dive on decoupled Application architecture

UPDATED FILES:
- View.md: Documents View.App property, GetApp(), and instance-based patterns
- navigation.md: Shows View.App usage instead of static Application
- drivers.md: Documents View.Driver and GetDriver() patterns
- keyboard.md: Event handling through View.App
- mouse.md: Mouse event handling via View.App
- arrangement.md: Updated code examples to use View.App
- drawing.md: Rendering examples with instance-based API
- cursor.md: Cursor management through View.App
- multitasking.md: SessionStack and session management via View.App
- Popovers.md: Popover patterns with View.App
- cancellable-work-pattern.md: Updated examples
- command.md: Command pattern with View.App context
- config.md: Configuration access through View.App
- migratingfromv1.md: Migration guide for static→instance patterns
- newinv2.md: Documents new instance-based architecture

All code examples now demonstrate the instance-based API (view.App.Current)
instead of obsolete static Application references. Documentation accurately
reflects the massive architectural decoupling achieved in this PR.

Co-authored-by: tig <585482+tig@users.noreply.github.com>

* Add `ToAnsi` support for ANSI escape sequence generation

Introduced `ToAnsi` in `IDriver` and `IOutput` interfaces to generate
ANSI escape sequences representing the terminal's current state. This
enables serialization of terminal content for debugging, testing, and
exporting.

Implemented `ToAnsi` in `DriverImpl` and `FakeOutput`, supporting both
16-color and RGB modes. Refactored `OutputBase` with helper methods
`BuildAnsiForRegion` and `AppendCellAnsi` for efficient ANSI generation.

Enhanced `GuiTestContext` with `AnsiScreenShot` for capturing terminal
state during tests. Added `ToAnsiTests` for comprehensive validation,
including edge cases, performance, and wide/Unicode character handling.

Updated documentation to reflect `ToAnsi` functionality and modernized
driver architecture. Improved testability, modularity, and performance
while removing legacy driver references.

* Improve null safety and cleanup in GuiTestContext

Enhanced null safety across `GuiTestContext` and `GuiTestContextTests`:
- Replaced `a` with `app` for better readability in tests.
- Added null checks (`!`, `?.`) to prevent potential null reference exceptions.
- Removed redundant `WaitIteration` and duplicate `ScreenShot` calls.

Improved error handling and robustness:
- Updated shutdown logic to use null-safe calls for `RequestStop` and `Shutdown`.
- Applied null-safe invocation for `_applicationImpl.Invoke`.

General cleanup:
- Removed redundant method calls and improved naming consistency.
- Ensured better maintainability and adherence to best practices.

* Refactor docs: remove deprecated files, update architecture

Removed outdated documentation files related to the terminology
proposal (`terminology-before-after.md`, `terminology-diagrams.md`,
`terminology-index.md`, `terminology-proposal-summary.md`,
`terminology-proposal.md`) from the `Docs` project. These files
were either deprecated or consolidated into other documentation.

Updated `application.md`:
- Added a "View Hierarchy and Run Stack" section with a Mermaid
  diagram to illustrate the relationship between the view hierarchy
  and the application session stack.
- Added a "Usage Example Flow" section with a sequence diagram
  to demonstrate the flow of running and stopping views.

These changes improve clarity, streamline documentation, and
align with the finalized terminology updates for the
`Application.Current` and `Application.SessionStack` APIs.

* Refactor Init/Run methods to simplify driver handling

The `Init` method in `Application` and `IApplication` now accepts only an optional `driverName` parameter, removing the `IDriver` parameter. This simplifies initialization by relying on driver names to determine the appropriate driver.

The `Run` methods have been updated to use `driverName` instead of `driver`, ensuring consistency with the updated `Init` method.

Replaced redundant inline documentation with `<inheritdoc>` tags to improve maintainability and consistency. Legacy `Application` methods (`Init`, `Shutdown`, `Run`) have been marked as `[Obsolete]` to signal their eventual deprecation.

Test cases have been refactored to align with the updated `Init` method signature, removing unused `driver` parameters. Documentation files have also been updated to reflect these API changes.

These changes improve clarity, reduce complexity, and ensure a more consistent API design.

* Refactor: Introduce Application.Create() factory method

Introduced a new static method `Application.Create()` to create
instances of `IApplication`, replacing direct instantiation of
`ApplicationImpl`. This enforces a cleaner, recommended pattern
for creating application instances.

Made the `ApplicationImpl` constructor `internal` to ensure
`Application.Create()` is used for instance creation.

Refactored test cases across multiple files to use
`Application.Create()` instead of directly instantiating
`ApplicationImpl`. Simplified object initialization in tests
using target-typed `new()` expressions.

Updated documentation and examples in `application.md` to
reflect the new instance-based architecture and highlight its
benefits, such as supporting multiple applications with
different drivers.

Improved code readability, formatting, and consistency in
tests and documentation. Aligned `ApplicationImplBeginEndTests`
to use `IApplication` directly, adhering to the new architecture.

* Added `Application.StopAll` and fixed coupling issues.

Refactored `ApplicationImpl` to use an instance-based approach, replacing the static singleton pattern and Lazy<T>. Introduced `SetInstance` for configuring the singleton instance and updated tests to use `ApplicationImpl.Instance` or explicitly set the `Driver` property.

Enabled nullable reference types across the codebase, updating fields and variables to nullable types where applicable. Added null checks to improve safety and prevent runtime errors.

Refactored timeout management by introducing tokens for `Application.AddTimeout` and adding a `StopAll` method to `TimedEvents` for cleanup. Updated tests to use `System.Threading.Timer` for independent watchdog timers.

Removed legacy code, improved logging for error cases, and updated view initialization to explicitly set `App` or `Driver` in tests. Enhanced test coverage and restructured `ScrollSliderTests` for better readability.

Performed general code cleanup, including formatting changes, removal of unused imports, and improved naming consistency.

* Refactor: Transition to IApplication interface

Refactored the codebase to replace the static `Application` class with the `IApplication` interface, improving modularity, testability, and maintainability. Updated methods like `Application.Run`, `RequestStop`, and `Init` to use the new interface.

Marked static members `SessionStack` and `Current` as `[Obsolete]` and delegated their functionality to `ApplicationImpl.Instance`. Updated XML documentation to reflect these changes.

Simplified code by removing redundant comments, unused code, and converting methods like `GetMarginThickness` to single-line expressions. Improved null safety with null-conditional operators in `ToplevelTransitionManager`.

Enhanced consistency with formatting updates, logging improvements, and better error handling. Updated `Shortcut` and other classes to align with the new interface-based design.

Made breaking changes, including the removal of the `helpText` parameter in the `Shortcut` constructor. Updated `Wizard`, `Dialog`, and `GraphView` to use `IApplication` methods. Adjusted `ViewportSettings` and `HighlightStates` for better behavior.

* Enhance null-safety and simplify codebase

Improved null-safety by adopting nullable reference types and adding null-forgiving operators (`!`) where appropriate. Replaced direct method calls with null-safe calls using the null-conditional operator (`?.`) to prevent potential `NullReferenceException`.

Removed default parameter values in test methods to enforce explicit parameter passing. Refactored test classes to remove unnecessary dependencies on `ITestOutputHelper`.

Fixed a bug in `WindowsOutput.cs` by setting `_force16Colors` to `false` to avoid reliance on a problematic driver property. Updated `SessionTokenTests` to use null-forgiving operators for clarity in intentional null usage.

Simplified graph and UI updates by ensuring safe access to properties and methods. Cleaned up namespaces and removed unused `using` directives for better readability.

Updated `Dispose` methods to use null-safe calls and replaced nullable driver initialization with non-nullable initialization in `ScrollSliderTests` to ensure proper instantiation.

* Refactor test code to use nullable `App` property

Replaced direct `Application` references with `App` property across test classes to improve encapsulation and robustness. Updated `GuiTestContext` to use a nullable `App` property, replacing `_applicationImpl` for consistency.

Refactored key event handling to use `App.Driver` and revised `InitializeApplication` and `CleanupApplication` methods to ensure safe usage of the nullable `App` property. Updated `Then` callbacks to explicitly pass `App` for clarity.

Replaced `Application.QuitKey` with `context.App?.Keyboard.RaiseKeyDownEvent` to ensure context-specific event handling. Refactored `EnableForDesign` logic in `MenuBarv2Tests` and `PopoverMenuTests` to operate on the correct application instance.

Improved null safety in test assertions and revised `RequestStop` and `Shutdown` calls to use `App?.RequestStop` and `App?.Shutdown`. Updated navigation logic to use `Terminal.Gui.App.Application` for namespace consistency.

Enhanced exception handling in the `Invoke` method and performed general cleanup to align with modern C# practices, improving maintainability and readability.

* Commented out exception handling in Application.Shutdown

The `try-catch` block around `Application.Shutdown` was commented out, disabling the logging of exceptions thrown after a test exited. This change removes the `catch` block that used `Debug.WriteLine` for logging.

The `finally` block remains intact, ensuring cleanup operations such as clearing `View.Instances` and resetting the application state are still executed.

* Fixes #4394 - Changing Theme at Runtime does not Update Some Properties

* Tweaks to config format.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Tig <tig@users.noreply.github.com>
Co-authored-by: tig <585482+tig@users.noreply.github.com>
2025-11-19 16:23:35 -05:00

1637 lines
52 KiB
C#

using System.Text;
using UnitTests;
using Xunit.Abstractions;
namespace UnitTests.ViewsTests;
#region Helper Classes
internal class FakeHAxis : HorizontalAxis
{
public List<Point> DrawAxisLinePoints = new ();
public List<int> LabelPoints = new ();
public override void DrawAxisLabel (GraphView graph, int screenPosition, string text)
{
base.DrawAxisLabel (graph, screenPosition, text);
LabelPoints.Add (screenPosition);
}
protected override void DrawAxisLine (GraphView graph, int x, int y)
{
base.DrawAxisLine (graph, x, y);
DrawAxisLinePoints.Add (new Point (x, y));
}
}
internal class FakeVAxis : VerticalAxis
{
public List<Point> DrawAxisLinePoints = new ();
public List<int> LabelPoints = new ();
public override void DrawAxisLabel (GraphView graph, int screenPosition, string text)
{
base.DrawAxisLabel (graph, screenPosition, text);
LabelPoints.Add (screenPosition);
}
protected override void DrawAxisLine (GraphView graph, int x, int y)
{
base.DrawAxisLine (graph, x, y);
DrawAxisLinePoints.Add (new Point (x, y));
}
}
#endregion
public class GraphViewTests : FakeDriverBase
{
/// <summary>
/// A cell size of 0 would result in mapping all graph space into the same cell of the console. Since
/// <see cref="GraphView.CellSize"/> is mutable a sensible place to check this is in redraw.
/// </summary>
[Fact]
[AutoInitShutdown]
public void CellSizeZero ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
//gv.Scheme = new Scheme ();
gv.Viewport = new Rectangle (0, 0, 50, 30);
gv.Series.Add (new ScatterSeries { Points = new List<PointF> { new (1, 1) } });
gv.CellSize = new PointF (0, 5);
var ex = Assert.Throws<Exception> (() => gv.Draw ());
Assert.Equal ("CellSize cannot be 0", ex.Message);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
/// <summary>Returns a basic very small graph (10 x 5)</summary>
/// <returns></returns>
public static GraphView GetGraph ()
{
var gv = new GraphView ()
{
Driver = Application.Driver ?? CreateFakeDriver ()
};
gv.BeginInit ();
gv.EndInit ();
//gv.Scheme = new Scheme ();
gv.MarginBottom = 1;
gv.MarginLeft = 1;
gv.Viewport = new Rectangle (0, 0, 10, 5);
return gv;
}
/// <summary>
/// Tests that each point in the screen space maps to a rectangle of (float) graph space and that each corner of
/// that rectangle of graph space maps back to the same row/col of the graph that was fed in
/// </summary>
[Fact]
public void TestReversing_ScreenToGraphSpace ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 50, 30);
// How much graph space each cell of the console depicts
gv.CellSize = new PointF (0.1f, 0.25f);
gv.AxisX.Increment = 1;
gv.AxisX.ShowLabelsEvery = 1;
gv.AxisY.Increment = 1;
gv.AxisY.ShowLabelsEvery = 1;
// Start the graph at 80
gv.ScrollOffset = new PointF (0, 80);
for (var x = 0; x < gv.Viewport.Width; x++)
{
for (var y = 0; y < gv.Viewport.Height; y++)
{
RectangleF graphSpace = gv.ScreenToGraphSpace (x, y);
// See
// https://en.wikipedia.org/wiki/Machine_epsilon
var epsilon = 0.0001f;
Point p = gv.GraphSpaceToScreen (
new PointF (
graphSpace.Left + epsilon,
graphSpace.Top + epsilon
)
);
Assert.Equal (x, p.X);
Assert.Equal (y, p.Y);
p = gv.GraphSpaceToScreen (
new PointF (
graphSpace.Right - epsilon,
graphSpace.Top + epsilon
)
);
Assert.Equal (x, p.X);
Assert.Equal (y, p.Y);
p = gv.GraphSpaceToScreen (
new PointF (
graphSpace.Left + epsilon,
graphSpace.Bottom - epsilon
)
);
Assert.Equal (x, p.X);
Assert.Equal (y, p.Y);
p = gv.GraphSpaceToScreen (
new PointF (
graphSpace.Right - epsilon,
graphSpace.Bottom - epsilon
)
);
Assert.Equal (x, p.X);
Assert.Equal (y, p.Y);
}
}
}
#region Screen to Graph Tests
[Fact]
public void ScreenToGraphSpace_DefaultCellSize ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 20, 10);
// origin should be bottom left
RectangleF botLeft = gv.ScreenToGraphSpace (0, 9);
Assert.Equal (0, botLeft.X);
Assert.Equal (0, botLeft.Y);
Assert.Equal (1, botLeft.Width);
Assert.Equal (1, botLeft.Height);
// up 2 rows of the console and along 1 col
RectangleF up2along1 = gv.ScreenToGraphSpace (1, 7);
Assert.Equal (1, up2along1.X);
Assert.Equal (2, up2along1.Y);
}
[Fact]
public void ScreenToGraphSpace_DefaultCellSize_WithMargin ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 20, 10);
// origin should be bottom left
RectangleF botLeft = gv.ScreenToGraphSpace (0, 9);
Assert.Equal (0, botLeft.X);
Assert.Equal (0, botLeft.Y);
Assert.Equal (1, botLeft.Width);
Assert.Equal (1, botLeft.Height);
gv.MarginLeft = 1;
botLeft = gv.ScreenToGraphSpace (0, 9);
// Origin should be at 1,9 now to leave a margin of 1
// so screen position 0,9 would be data space -1,0
Assert.Equal (-1, botLeft.X);
Assert.Equal (0, botLeft.Y);
Assert.Equal (1, botLeft.Width);
Assert.Equal (1, botLeft.Height);
gv.MarginLeft = 1;
gv.MarginBottom = 1;
botLeft = gv.ScreenToGraphSpace (0, 9);
// Origin should be at 1,0 (to leave a margin of 1 in both sides)
// so screen position 0,9 would be data space -1,-1
Assert.Equal (-1, botLeft.X);
Assert.Equal (-1, botLeft.Y);
Assert.Equal (1, botLeft.Width);
Assert.Equal (1, botLeft.Height);
}
[Fact]
public void ScreenToGraphSpace_CustomCellSize ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 20, 10);
// Each cell of screen measures 5 units in graph data model vertically and 1/4 horizontally
gv.CellSize = new PointF (0.25f, 5);
// origin should be bottom left
// (note that y=10 is actually overspilling the control, the last row is 9)
RectangleF botLeft = gv.ScreenToGraphSpace (0, 9);
Assert.Equal (0, botLeft.X);
Assert.Equal (0, botLeft.Y);
Assert.Equal (0.25f, botLeft.Width);
Assert.Equal (5, botLeft.Height);
// up 2 rows of the console and along 1 col
RectangleF up2along1 = gv.ScreenToGraphSpace (1, 7);
Assert.Equal (0.25f, up2along1.X);
Assert.Equal (10, up2along1.Y);
Assert.Equal (0.25f, botLeft.Width);
Assert.Equal (5, botLeft.Height);
}
#endregion
#region Graph to Screen Tests
[Fact]
public void GraphSpaceToScreen_DefaultCellSize ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 20, 10);
// origin should be bottom left
Point botLeft = gv.GraphSpaceToScreen (new PointF (0, 0));
Assert.Equal (0, botLeft.X);
Assert.Equal (9, botLeft.Y); // row 9 of the view is the bottom left
// along 2 and up 1 in graph space
Point along2up1 = gv.GraphSpaceToScreen (new PointF (2, 1));
Assert.Equal (2, along2up1.X);
Assert.Equal (8, along2up1.Y);
}
[Fact]
public void GraphSpaceToScreen_DefaultCellSize_WithMargin ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 20, 10);
// origin should be bottom left
Point botLeft = gv.GraphSpaceToScreen (new PointF (0, 0));
Assert.Equal (0, botLeft.X);
Assert.Equal (9, botLeft.Y); // row 9 of the view is the bottom left
gv.MarginLeft = 1;
// With a margin of 1 the origin should be at x=1 y= 9
botLeft = gv.GraphSpaceToScreen (new PointF (0, 0));
Assert.Equal (1, botLeft.X);
Assert.Equal (9, botLeft.Y); // row 9 of the view is the bottom left
gv.MarginLeft = 1;
gv.MarginBottom = 1;
// With a margin of 1 in both directions the origin should be at x=1 y= 9
botLeft = gv.GraphSpaceToScreen (new PointF (0, 0));
Assert.Equal (1, botLeft.X);
Assert.Equal (8, botLeft.Y); // row 8 of the view is the bottom left up 1 cell
}
[Fact]
public void GraphSpaceToScreen_ScrollOffset ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 20, 10);
//graph is scrolled to present chart space -5 to 5 in both axes
gv.ScrollOffset = new PointF (-5, -5);
// origin should be right in the middle of the control
Point botLeft = gv.GraphSpaceToScreen (new PointF (0, 0));
Assert.Equal (5, botLeft.X);
Assert.Equal (4, botLeft.Y);
// along 2 and up 1 in graph space
Point along2up1 = gv.GraphSpaceToScreen (new PointF (2, 1));
Assert.Equal (7, along2up1.X);
Assert.Equal (3, along2up1.Y);
}
[Fact]
public void GraphSpaceToScreen_CustomCellSize ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 20, 10);
// Each cell of screen is responsible for rendering 5 units in graph data model
// vertically and 1/4 horizontally
gv.CellSize = new PointF (0.25f, 5);
// origin should be bottom left
Point botLeft = gv.GraphSpaceToScreen (new PointF (0, 0));
Assert.Equal (0, botLeft.X);
// row 9 of the view is the bottom left (height is 10 so 0,1,2,3..9)
Assert.Equal (9, botLeft.Y);
// along 2 and up 1 in graph space
Point along2up1 = gv.GraphSpaceToScreen (new PointF (2, 1));
Assert.Equal (8, along2up1.X);
Assert.Equal (9, along2up1.Y);
// Y value 4 should be rendered in bottom most row
Assert.Equal (9, gv.GraphSpaceToScreen (new PointF (2, 4)).Y);
// Cell height is 5 so this is the first point of graph space that should
// be rendered in the graph in next row up (row 9)
Assert.Equal (8, gv.GraphSpaceToScreen (new PointF (2, 5)).Y);
// More boundary testing for this cell size
Assert.Equal (8, gv.GraphSpaceToScreen (new PointF (2, 6)).Y);
Assert.Equal (8, gv.GraphSpaceToScreen (new PointF (2, 7)).Y);
Assert.Equal (8, gv.GraphSpaceToScreen (new PointF (2, 8)).Y);
Assert.Equal (8, gv.GraphSpaceToScreen (new PointF (2, 9)).Y);
Assert.Equal (7, gv.GraphSpaceToScreen (new PointF (2, 10)).Y);
Assert.Equal (7, gv.GraphSpaceToScreen (new PointF (2, 11)).Y);
}
[Fact]
public void GraphSpaceToScreen_CustomCellSize_WithScrollOffset ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 20, 10);
// Each cell of screen is responsible for rendering 5 units in graph data model
// vertically and 1/4 horizontally
gv.CellSize = new PointF (0.25f, 5);
//graph is scrolled to present some negative chart (4 negative cols and 2 negative rows)
gv.ScrollOffset = new PointF (-1, -10);
// origin should be in the lower left (but not right at the bottom)
Point botLeft = gv.GraphSpaceToScreen (new PointF (0, 0));
Assert.Equal (4, botLeft.X);
Assert.Equal (7, botLeft.Y);
// along 2 and up 1 in graph space
Point along2up1 = gv.GraphSpaceToScreen (new PointF (2, 1));
Assert.Equal (12, along2up1.X);
Assert.Equal (7, along2up1.Y);
// More boundary testing for this cell size/offset
Assert.Equal (6, gv.GraphSpaceToScreen (new PointF (2, 6)).Y);
Assert.Equal (6, gv.GraphSpaceToScreen (new PointF (2, 7)).Y);
Assert.Equal (6, gv.GraphSpaceToScreen (new PointF (2, 8)).Y);
Assert.Equal (6, gv.GraphSpaceToScreen (new PointF (2, 9)).Y);
Assert.Equal (5, gv.GraphSpaceToScreen (new PointF (2, 10)).Y);
Assert.Equal (5, gv.GraphSpaceToScreen (new PointF (2, 11)).Y);
}
#endregion
}
public class SeriesTests
{
[Fact]
[AutoInitShutdown]
public void Series_GetsPassedCorrectViewport_AllAtOnce ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
gv.Viewport = new Rectangle (0, 0, 50, 30);
//gv.Scheme = new Scheme ();
var fullGraphBounds = RectangleF.Empty;
var graphScreenBounds = Rectangle.Empty;
var series = new FakeSeries (
(v, s, g) =>
{
graphScreenBounds = s;
fullGraphBounds = g;
}
);
gv.Series.Add (series);
gv.LayoutSubViews ();
gv.Draw ();
Assert.Equal (new RectangleF (0, 0, 50, 30), fullGraphBounds);
Assert.Equal (new Rectangle (0, 0, 50, 30), graphScreenBounds);
// Now we put a margin in
// Graph should not spill into the margins
gv.MarginBottom = 2;
gv.MarginLeft = 5;
// Even with a margin the graph should be drawn from
// the origin, we just get less visible width/height
gv.LayoutSubViews ();
gv.SetNeedsDraw ();
gv.Draw ();
Assert.Equal (new RectangleF (0, 0, 45, 28), fullGraphBounds);
// The screen space the graph will be rendered into should
// not overspill the margins
Assert.Equal (new Rectangle (5, 0, 45, 28), graphScreenBounds);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
/// <summary>
/// Tests that the bounds passed to the ISeries for drawing into are correct even when the
/// <see cref="GraphView.CellSize"/> results in multiple units of graph space being condensed into each cell of console
/// </summary>
[Fact]
[AutoInitShutdown]
public void Series_GetsPassedCorrectViewport_AllAtOnce_LargeCellSize ()
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
//gv.Scheme = new Scheme ();
gv.Viewport = new Rectangle (0, 0, 50, 30);
// the larger the cell size the more condensed (smaller) the graph space is
gv.CellSize = new PointF (2, 5);
var fullGraphBounds = RectangleF.Empty;
var graphScreenBounds = Rectangle.Empty;
var series = new FakeSeries (
(v, s, g) =>
{
graphScreenBounds = s;
fullGraphBounds = g;
}
);
gv.Series.Add (series);
gv.LayoutSubViews ();
gv.Draw ();
// Since each cell of the console is 2x5 of graph space the graph
// bounds to be rendered are larger
Assert.Equal (new RectangleF (0, 0, 100, 150), fullGraphBounds);
Assert.Equal (new Rectangle (0, 0, 50, 30), graphScreenBounds);
// Graph should not spill into the margins
gv.MarginBottom = 2;
gv.MarginLeft = 5;
// Even with a margin the graph should be drawn from
// the origin, we just get less visible width/height
gv.LayoutSubViews ();
gv.SetNeedsDraw ();
gv.Draw ();
Assert.Equal (new RectangleF (0, 0, 90, 140), fullGraphBounds);
// The screen space the graph will be rendered into should
// not overspill the margins
Assert.Equal (new Rectangle (5, 0, 45, 28), graphScreenBounds);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
private class FakeSeries : ISeries
{
private readonly Action<GraphView, Rectangle, RectangleF> _drawSeries;
public FakeSeries (
Action<GraphView, Rectangle, RectangleF> drawSeries
)
{
_drawSeries = drawSeries;
}
public void DrawSeries (GraphView graph, Rectangle bounds, RectangleF graphBounds) { _drawSeries (graph, bounds, graphBounds); }
}
}
public class MultiBarSeriesTests
{
private readonly ITestOutputHelper _output;
public MultiBarSeriesTests (ITestOutputHelper output) { _output = output; }
[Fact]
public void MultiBarSeries_BarSpacing ()
{
// Creates clusters of 5 adjacent bars with 2 spaces between clusters
var series = new MultiBarSeries (5, 7, 1);
Assert.Equal (5, series.SubSeries.Count);
Assert.Equal (0, series.SubSeries.ElementAt (0).Offset);
Assert.Equal (1, series.SubSeries.ElementAt (1).Offset);
Assert.Equal (2, series.SubSeries.ElementAt (2).Offset);
Assert.Equal (3, series.SubSeries.ElementAt (3).Offset);
Assert.Equal (4, series.SubSeries.ElementAt (4).Offset);
}
[Fact]
public void MultiBarSeriesAddValues_WrongNumber ()
{
// user asks for 3 bars per category
var series = new MultiBarSeries (3, 7, 1);
var ex = Assert.Throws<ArgumentException> (() => series.AddBars ("Cars", (Rune)'#', 1));
Assert.Equal (
"Number of values must match the number of bars per category (Parameter 'values')",
ex.Message
);
}
[Fact]
public void MultiBarSeriesColors_RightNumber ()
{
Attribute [] colors =
{
new (Color.Green, Color.Black), new (Color.Green, Color.White), new (Color.BrightYellow, Color.White)
};
// user passes 3 colors and asks for 3 bars
var series = new MultiBarSeries (3, 7, 1, colors);
Assert.Equal (series.SubSeries.ElementAt (0).OverrideBarColor, colors [0]);
Assert.Equal (series.SubSeries.ElementAt (1).OverrideBarColor, colors [1]);
Assert.Equal (series.SubSeries.ElementAt (2).OverrideBarColor, colors [2]);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
public void MultiBarSeriesColors_WrongNumber ()
{
Attribute [] colors = { new (Color.Green, Color.Black) };
// user passes 1 color only but asks for 5 bars
var ex = Assert.Throws<ArgumentException> (() => new MultiBarSeries (5, 7, 1, colors));
Assert.Equal (
"Number of colors must match the number of bars (Parameter 'numberOfBarsPerCategory')",
ex.Message
);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestRendering_MultibarSeries ()
{
var gv = new GraphView ();
//gv.Scheme = new Scheme ();
// y axis goes from 0.1 to 1 across 10 console rows
// x axis goes from 0 to 20 across 20 console columns
gv.Viewport = new Rectangle (0, 0, 20, 10);
gv.CellSize = new PointF (1f, 0.1f);
gv.MarginBottom = 1;
gv.MarginLeft = 1;
var multibarSeries = new MultiBarSeries (2, 4, 1);
//nudge them left to avoid float rounding errors at the boundaries of cells
foreach (BarSeries sub in multibarSeries.SubSeries)
{
sub.Offset -= 0.001f;
}
gv.Series.Add (multibarSeries);
FakeHAxis fakeXAxis;
// don't show axis labels that means any labels
// that appear are explicitly from the bars
gv.AxisX = fakeXAxis = new FakeHAxis { Increment = 0 };
gv.AxisY = new FakeVAxis { Increment = 0 };
gv.LayoutSubViews ();
gv.Draw ();
// Since bar series has no bars yet no labels should be displayed
Assert.Empty (fakeXAxis.LabelPoints);
multibarSeries.AddBars ("hey", (Rune)'M', 0.5001f, 0.5001f);
fakeXAxis.LabelPoints.Clear ();
gv.LayoutSubViews ();
gv.SetNeedsDraw ();
gv.Draw ();
Assert.Equal (4, fakeXAxis.LabelPoints.Single ());
multibarSeries.AddBars ("there", (Rune)'M', 0.24999f, 0.74999f);
multibarSeries.AddBars ("bob", (Rune)'M', 1, 2);
fakeXAxis.LabelPoints.Clear ();
gv.LayoutSubViews ();
gv.SetNeedsDraw ();
gv.SetClipToScreen ();
gv.Draw ();
Assert.Equal (3, fakeXAxis.LabelPoints.Count);
Assert.Equal (4, fakeXAxis.LabelPoints [0]);
Assert.Equal (8, fakeXAxis.LabelPoints [1]);
Assert.Equal (12, fakeXAxis.LabelPoints [2]);
var looksLike =
@"
│ MM
│ M MM
│ M MM
│ MM M MM
│ MM M MM
│ MM M MM
│ MM MM MM
│ MM MM MM
┼──┬M──┬M──┬M──────
heytherebob ";
DriverAssert.AssertDriverContentsAre (looksLike, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
}
public class BarSeriesTests : FakeDriverBase
{
[Fact]
public void TestOneLongOneShortHorizontalBars_WithOffset ()
{
GraphView graph = GetGraph (out FakeBarSeries barSeries, out FakeHAxis axisX, out FakeVAxis axisY);
graph.Driver = CreateFakeDriver ();
graph.Draw ();
// no bars
Assert.Empty (barSeries.BarScreenStarts);
Assert.Empty (axisX.LabelPoints);
Assert.Empty (axisY.LabelPoints);
// 0.1 units of graph y fit every screen row
// so 1 unit of graph y space is 10 screen rows
graph.CellSize = new PointF (0.5f, 0.1f);
// Start bar 3 screen units up (y = height-3)
barSeries.Offset = 0.25f;
// 1 bar every 3 rows of screen
barSeries.BarEvery = 0.3f;
barSeries.Orientation = Orientation.Horizontal;
// 1 bar that is very wide (100 graph units horizontally = screen pos 50 but bounded by screen)
barSeries.Bars.Add (
new BarSeriesBar ("hi1", new GraphCellToRender ((Rune)'.'), 100)
);
// 1 bar that is shorter
barSeries.Bars.Add (
new BarSeriesBar ("hi2", new GraphCellToRender ((Rune)'.'), 5)
);
// redraw graph
graph.SetNeedsDraw ();
graph.Draw ();
// since bars are horizontal all have the same X start cordinates
Assert.Equal (0, barSeries.BarScreenStarts [0].X);
Assert.Equal (0, barSeries.BarScreenStarts [1].X);
// bar goes all the way to the end so bumps up against right screen boundary
// width of graph is 20
Assert.Equal (19, barSeries.BarScreenEnds [0].X);
// shorter bar is 5 graph units wide which is 10 screen units
Assert.Equal (10, barSeries.BarScreenEnds [1].X);
// first bar should be offset 6 screen units (0.25f + 0.3f graph units)
// since height of control is 10 then first bar should be at screen row 4 (10-6)
Assert.Equal (4, barSeries.BarScreenStarts [0].Y);
// second bar should be offset 9 screen units (0.25f + 0.6f graph units)
// since height of control is 10 then second bar should be at screen row 1 (10-9)
Assert.Equal (1, barSeries.BarScreenStarts [1].Y);
// both bars should have labels but on the y axis
Assert.Equal (2, axisY.LabelPoints.Count);
Assert.Empty (axisX.LabelPoints);
// labels should align with the bars (same screen y axis point)
Assert.Contains (4, axisY.LabelPoints);
Assert.Contains (1, axisY.LabelPoints);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestTwoTallBars_WithOffset ()
{
GraphView graph = GetGraph (out FakeBarSeries barSeries, out FakeHAxis axisX, out FakeVAxis axisY);
graph.Draw ();
// no bars
Assert.Empty (barSeries.BarScreenStarts);
Assert.Empty (axisX.LabelPoints);
Assert.Empty (axisY.LabelPoints);
// 0.5 units of graph fit every screen cell
// so 1 unit of graph space is 2 screen columns
graph.CellSize = new PointF (0.5f, 0.1f);
// Start bar 1 screen unit along
barSeries.Offset = 0.5f;
barSeries.BarEvery = 1f;
barSeries.Bars.Add (
new BarSeriesBar ("hi1", new GraphCellToRender ((Rune)'.'), 100)
);
barSeries.Bars.Add (
new BarSeriesBar ("hi2", new GraphCellToRender ((Rune)'.'), 100)
);
barSeries.Orientation = Orientation.Vertical;
// redraw graph
graph.SetNeedsDraw ();
graph.Draw ();
// bar should be drawn at BarEvery 1f + offset 0.5f = 3 screen units
Assert.Equal (3, barSeries.BarScreenStarts [0].X);
Assert.Equal (3, barSeries.BarScreenEnds [0].X);
// second bar should be BarEveryx2 = 2f + offset 0.5f = 5 screen units
Assert.Equal (5, barSeries.BarScreenStarts [1].X);
Assert.Equal (5, barSeries.BarScreenEnds [1].X);
// both bars should have labels
Assert.Equal (2, axisX.LabelPoints.Count);
Assert.Contains (3, axisX.LabelPoints);
Assert.Contains (5, axisX.LabelPoints);
// bars are very tall but should not draw up off top of screen
Assert.Equal (9, barSeries.BarScreenStarts [0].Y);
Assert.Equal (0, barSeries.BarScreenEnds [0].Y);
Assert.Equal (9, barSeries.BarScreenStarts [1].Y);
Assert.Equal (0, barSeries.BarScreenEnds [1].Y);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestZeroHeightBar_WithName ()
{
GraphView graph = GetGraph (out FakeBarSeries barSeries, out FakeHAxis axisX, out FakeVAxis axisY);
graph.Draw ();
// no bars
Assert.Empty (barSeries.BarScreenStarts);
Assert.Empty (axisX.LabelPoints);
Assert.Empty (axisY.LabelPoints);
// bar of height 0
barSeries.Bars.Add (new BarSeriesBar ("hi", new GraphCellToRender ((Rune)'.'), 0));
barSeries.Orientation = Orientation.Vertical;
// redraw graph
graph.SetNeedsDraw ();
graph.Draw ();
// bar should not be drawn
Assert.Empty (barSeries.BarScreenStarts);
Assert.NotEmpty (axisX.LabelPoints);
Assert.Empty (axisY.LabelPoints);
// but bar name should be
// Screen position x=2 because bars are drawn every 1f of
// graph space and CellSize.X is 0.5f
Assert.Contains (2, axisX.LabelPoints);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
private GraphView GetGraph (out FakeBarSeries series, out FakeHAxis axisX, out FakeVAxis axisY)
{
var gv = new GraphView ();
gv.BeginInit ();
gv.EndInit ();
// y axis goes from 0.1 to 1 across 10 console rows
// x axis goes from 0 to 10 across 20 console columns
gv.Viewport = new Rectangle (0, 0, 20, 10);
//gv.Scheme = new Scheme ();
gv.CellSize = new PointF (0.5f, 0.1f);
gv.Series.Add (series = new FakeBarSeries ());
// don't show axis labels that means any labels
// that appaer are explicitly from the bars
gv.AxisX = axisX = new FakeHAxis { Increment = 0 };
gv.AxisY = axisY = new FakeVAxis { Increment = 0 };
return gv;
}
private class FakeBarSeries : BarSeries
{
public List<Point> BarScreenEnds { get; } = new ();
public List<Point> BarScreenStarts { get; } = new ();
public GraphCellToRender FinalColor { get; private set; }
protected override GraphCellToRender AdjustColor (GraphCellToRender graphCellToRender) { return FinalColor = base.AdjustColor (graphCellToRender); }
protected override void DrawBarLine (GraphView graph, Point start, Point end, BarSeriesBar beingDrawn)
{
base.DrawBarLine (graph, start, end, beingDrawn);
BarScreenStarts.Add (start);
BarScreenEnds.Add (end);
}
}
}
public class AxisTests
{
private GraphView GetGraph (out FakeHAxis axis) { return GetGraph (out axis, out _); }
private GraphView GetGraph (out FakeVAxis axis) { return GetGraph (out _, out axis); }
private GraphView GetGraph (out FakeHAxis axisX, out FakeVAxis axisY)
{
var gv = new GraphView ();
gv.Viewport = new Rectangle (0, 0, 50, 30);
// gv.Scheme = new Scheme ();
// graph can't be completely empty or it won't draw
gv.Series.Add (new ScatterSeries ());
axisX = new FakeHAxis ();
axisY = new FakeVAxis ();
gv.AxisX = axisX;
gv.AxisY = axisY;
return gv;
}
#region HorizontalAxis Tests
/// <summary>Tests that the horizontal axis is computed correctly and does not over spill it's bounds</summary>
[Fact]
[AutoInitShutdown]
public void TestHAxisLocation_NoMargin ()
{
GraphView gv = GetGraph (out FakeHAxis axis);
gv.LayoutSubViews ();
gv.Draw ();
Assert.DoesNotContain (new Point (-1, 29), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 29), axis.DrawAxisLinePoints);
Assert.Contains (new Point (1, 29), axis.DrawAxisLinePoints);
Assert.Contains (new Point (48, 29), axis.DrawAxisLinePoints);
Assert.Contains (new Point (49, 29), axis.DrawAxisLinePoints);
Assert.DoesNotContain (new Point (50, 29), axis.DrawAxisLinePoints);
Assert.InRange (axis.LabelPoints.Max (), 0, 49);
Assert.InRange (axis.LabelPoints.Min (), 0, 49);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestHAxisLocation_MarginBottom ()
{
GraphView gv = GetGraph (out FakeHAxis axis);
gv.MarginBottom = 10;
gv.LayoutSubViews ();
gv.Draw ();
Assert.DoesNotContain (new Point (-1, 19), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 19), axis.DrawAxisLinePoints);
Assert.Contains (new Point (1, 19), axis.DrawAxisLinePoints);
Assert.Contains (new Point (48, 19), axis.DrawAxisLinePoints);
Assert.Contains (new Point (49, 19), axis.DrawAxisLinePoints);
Assert.DoesNotContain (new Point (50, 19), axis.DrawAxisLinePoints);
Assert.InRange (axis.LabelPoints.Max (), 0, 49);
Assert.InRange (axis.LabelPoints.Min (), 0, 49);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestHAxisLocation_MarginLeft ()
{
GraphView gv = GetGraph (out FakeHAxis axis);
gv.MarginLeft = 5;
gv.LayoutSubViews ();
gv.Draw ();
Assert.DoesNotContain (new Point (4, 29), axis.DrawAxisLinePoints);
Assert.Contains (new Point (5, 29), axis.DrawAxisLinePoints);
Assert.Contains (new Point (6, 29), axis.DrawAxisLinePoints);
Assert.Contains (new Point (48, 29), axis.DrawAxisLinePoints);
Assert.Contains (new Point (49, 29), axis.DrawAxisLinePoints);
Assert.DoesNotContain (new Point (50, 29), axis.DrawAxisLinePoints);
// Axis lables should not be drawn in the margin
Assert.InRange (axis.LabelPoints.Max (), 5, 49);
Assert.InRange (axis.LabelPoints.Min (), 5, 49);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
#endregion
#region VerticalAxisTests
/// <summary>Tests that the horizontal axis is computed correctly and does not over spill it's bounds</summary>
[Fact]
[AutoInitShutdown]
public void TestVAxisLocation_NoMargin ()
{
GraphView gv = GetGraph (out FakeVAxis axis);
gv.LayoutSubViews ();
gv.Draw ();
Assert.DoesNotContain (new Point (0, -1), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 1), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 2), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 28), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 29), axis.DrawAxisLinePoints);
Assert.DoesNotContain (new Point (0, 30), axis.DrawAxisLinePoints);
Assert.InRange (axis.LabelPoints.Max (), 0, 29);
Assert.InRange (axis.LabelPoints.Min (), 0, 29);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestVAxisLocation_MarginBottom ()
{
GraphView gv = GetGraph (out FakeVAxis axis);
gv.MarginBottom = 10;
gv.LayoutSubViews ();
gv.Draw ();
Assert.DoesNotContain (new Point (0, -1), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 1), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 2), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 18), axis.DrawAxisLinePoints);
Assert.Contains (new Point (0, 19), axis.DrawAxisLinePoints);
Assert.DoesNotContain (new Point (0, 20), axis.DrawAxisLinePoints);
// Labels should not be drawn into the axis
Assert.InRange (axis.LabelPoints.Max (), 0, 19);
Assert.InRange (axis.LabelPoints.Min (), 0, 19);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestVAxisLocation_MarginLeft ()
{
GraphView gv = GetGraph (out FakeVAxis axis);
gv.MarginLeft = 5;
gv.LayoutSubViews ();
gv.Draw ();
Assert.DoesNotContain (new Point (5, -1), axis.DrawAxisLinePoints);
Assert.Contains (new Point (5, 1), axis.DrawAxisLinePoints);
Assert.Contains (new Point (5, 2), axis.DrawAxisLinePoints);
Assert.Contains (new Point (5, 28), axis.DrawAxisLinePoints);
Assert.Contains (new Point (5, 29), axis.DrawAxisLinePoints);
Assert.DoesNotContain (new Point (5, 30), axis.DrawAxisLinePoints);
Assert.InRange (axis.LabelPoints.Max (), 0, 29);
Assert.InRange (axis.LabelPoints.Min (), 0, 29);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
#endregion
}
public class TextAnnotationTests
{
private readonly ITestOutputHelper _output;
public TextAnnotationTests (ITestOutputHelper output) { _output = output; }
[Theory]
[InlineData (null)]
[InlineData (" ")]
[InlineData ("\t\t")]
[AutoInitShutdown]
public void TestTextAnnotation_EmptyText (string whitespace)
{
GraphView gv = GraphViewTests.GetGraph ();
gv.Annotations.Add (
new TextAnnotation { Text = whitespace, GraphPosition = new PointF (4, 2) }
);
// add a point a bit further along the graph so if the whitespace were rendered
// the test would pick it up (AssertDriverContentsAre ignores trailing whitespace on lines)
var points = new ScatterSeries ();
points.Points.Add (new PointF (7, 2));
gv.Series.Add (points);
gv.LayoutSubViews ();
gv.Draw ();
var expected =
@$"
┤ {Glyphs.Dot}
0┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestTextAnnotation_GraphUnits ()
{
GraphView gv = GraphViewTests.GetGraph ();
gv.Annotations.Add (
new TextAnnotation { Text = "hey!", GraphPosition = new PointF (2, 2) }
);
gv.LayoutSubViews ();
gv.Draw ();
var expected =
@"
┤ hey!
0┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// user scrolls up one unit of graph space
gv.ScrollOffset = new PointF (0, 1f);
gv.SetNeedsDraw ();
gv.SetClipToScreen ();
gv.Draw ();
// we expect the text annotation to go down one line since
// the scroll offset means that that point of graph space is
// lower down in the view. Note the 1 on the axis too, our viewport
// (excluding margins) now shows y of 1 to 4 (previously 0 to 5)
expected =
@"
┤ hey!
1┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestTextAnnotation_LongText ()
{
GraphView gv = GraphViewTests.GetGraph ();
gv.Annotations.Add (
new TextAnnotation
{
Text = "hey there partner hows it going boy its great", GraphPosition = new PointF (2, 2)
}
);
gv.LayoutSubViews ();
gv.SetNeedsDraw ();
gv.Draw ();
// long text should get truncated
// margin takes up 1 units
// the GraphPosition of the anntation is 2
// Leaving 7 characters of the annotation renderable (including space)
var expected =
@"
┤ hey the
0┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestTextAnnotation_Offscreen ()
{
GraphView gv = GraphViewTests.GetGraph ();
gv.Annotations.Add (
new TextAnnotation
{
Text = "hey there partner hows it going boy its great", GraphPosition = new PointF (9, 2)
}
);
gv.LayoutSubViews ();
gv.Draw ();
// Text is off the screen (graph x axis runs to 8 not 9)
var expected =
@"
0┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void TestTextAnnotation_ScreenUnits ()
{
GraphView gv = GraphViewTests.GetGraph ();
gv.Annotations.Add (
new TextAnnotation { Text = "hey!", ScreenPosition = new Point (3, 1) }
);
gv.LayoutSubViews ();
gv.SetClipToScreen ();
gv.Draw ();
var expected =
@"
┤ hey!
0┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// user scrolls up one unit of graph space
gv.ScrollOffset = new PointF (0, 1f);
gv.SetNeedsDraw ();
gv.SetClipToScreen ();
gv.Draw ();
// we expect no change in the location of the annotation (only the axis label changes)
// this is because screen units are constant and do not change as the viewport into
// graph space scrolls to different areas of the graph
expected =
@"
┤ hey!
1┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// user scrolls up one unit of graph space
gv.ScrollOffset = new PointF (0, 1f);
gv.SetNeedsDraw ();
gv.SetClipToScreen ();
gv.Draw ();
// we expect no change in the location of the annotation (only the axis label changes)
// this is because screen units are constant and do not change as the viewport into
// graph space scrolls to different areas of the graph
expected =
@"
┤ hey!
1┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
}
public class LegendTests
{
private readonly ITestOutputHelper _output;
public LegendTests (ITestOutputHelper output) { _output = output; }
[Fact]
public void Constructors_Defaults ()
{
var legend = new LegendAnnotation ();
Assert.Equal (Rectangle.Empty, legend.Viewport);
Assert.Equal (Rectangle.Empty, legend.Frame);
Assert.Equal (LineStyle.Single, legend.BorderStyle);
Assert.False (legend.BeforeSeries);
var bounds = new Rectangle (1, 2, 10, 3);
legend = new LegendAnnotation (bounds);
Assert.Equal (new Rectangle (0, 0, 8, 1), legend.Viewport);
Assert.Equal (bounds, legend.Frame);
Assert.Equal (LineStyle.Single, legend.BorderStyle);
Assert.False (legend.BeforeSeries);
legend.BorderStyle = LineStyle.None;
Assert.Equal (new Rectangle (0, 0, 10, 3), legend.Viewport);
Assert.Equal (bounds, legend.Frame);
}
[Fact]
[AutoInitShutdown]
public void LegendNormalUsage_WithBorder ()
{
GraphView gv = GraphViewTests.GetGraph ();
var legend = new LegendAnnotation (new Rectangle (2, 0, 5, 3));
legend.AddEntry (new GraphCellToRender ((Rune)'A'), "Ant");
legend.AddEntry (new GraphCellToRender ((Rune)'B'), "Bat");
gv.Annotations.Add (legend);
gv.Layout ();
gv.Draw ();
var expected =
@"
│┌───┐
┤│AAn│
┤└───┘
0┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void LegendNormalUsage_WithoutBorder ()
{
GraphView gv = GraphViewTests.GetGraph ();
var legend = new LegendAnnotation (new Rectangle (2, 0, 5, 3));
legend.AddEntry (new GraphCellToRender ((Rune)'A'), "Ant");
legend.AddEntry (new GraphCellToRender ((Rune)'B'), "?"); // this will exercise pad
legend.AddEntry (new GraphCellToRender ((Rune)'C'), "Cat");
legend.AddEntry (new GraphCellToRender ((Rune)'H'), "Hattter"); // not enough space for this oen
legend.BorderStyle = LineStyle.None;
gv.Annotations.Add (legend);
gv.Draw ();
var expected =
@"
│AAnt
┤B?
┤CCat
0┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
}
public class PathAnnotationTests
{
private readonly ITestOutputHelper _output;
public PathAnnotationTests (ITestOutputHelper output) { _output = output; }
[Fact]
public void MarginBottom_BiggerThanHeight_ExpectBlankGraph ()
{
GraphView gv = GraphViewTests.GetGraph ();
gv.Height = 10;
gv.MarginBottom = 20;
gv.Series.Add (
new ScatterSeries { Points = { new PointF (1, 1), new PointF (5, 0) } }
);
gv.LayoutSubViews ();
gv.Draw ();
var expected =
@"
";
DriverAssert.AssertDriverContentsAre (expected, _output, gv.Driver);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
public void MarginLeft_BiggerThanWidth_ExpectBlankGraph ()
{
GraphView gv = GraphViewTests.GetGraph ();
gv.Width = 10;
gv.MarginLeft = 20;
gv.Series.Add (
new ScatterSeries { Points = { new PointF (1, 1), new PointF (5, 0) } }
);
gv.LayoutSubViews ();
gv.Draw ();
var expected =
@"
";
DriverAssert.AssertDriverContentsAre (expected, _output, gv.Driver);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void PathAnnotation_Box ()
{
GraphView gv = GraphViewTests.GetGraph ();
var path = new PathAnnotation ();
path.Points.Add (new PointF (1, 1));
path.Points.Add (new PointF (1, 3));
path.Points.Add (new PointF (6, 3));
path.Points.Add (new PointF (6, 1));
// list the starting point again so that it draws a complete square
// (otherwise it will miss out the last line along the bottom)
path.Points.Add (new PointF (1, 1));
gv.Annotations.Add (path);
gv.LayoutSubViews ();
gv.Draw ();
var expected =
@"
│......
┤. .
┤......
0┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void PathAnnotation_Diamond ()
{
GraphView gv = GraphViewTests.GetGraph ();
var path = new PathAnnotation ();
path.Points.Add (new PointF (1, 2));
path.Points.Add (new PointF (3, 3));
path.Points.Add (new PointF (6, 2));
path.Points.Add (new PointF (3, 1));
// list the starting point again to close the shape
path.Points.Add (new PointF (1, 2));
gv.Annotations.Add (path);
gv.LayoutSubViews ();
gv.Draw ();
var expected =
@"
│ ..
┤.. ..
┤ ...
0┼┬┬┬┬┬┬┬┬
0 5";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Theory]
[AutoInitShutdown]
[InlineData (true)]
[InlineData (false)]
public void ViewChangeText_RendersCorrectly (bool useFill)
{
// create a wide window
var mount = new View { Width = 100, Height = 100 };
var top = new Toplevel ();
try
{
// Create a view with a short text
var view = new View { Text = "ff", Width = 2, Height = 1 };
// Specify that the label should be very wide
if (useFill)
{
view.Width = Dim.Fill ();
}
else
{
view.Width = 100;
}
//put label into view
mount.Add (view);
//putting mount into Toplevel since changing size
top.Add (mount);
Application.Begin (top);
// render view
//view.Scheme = new Scheme ();
Assert.Equal (1, view.Height);
mount.SetNeedsDraw ();
mount.Draw ();
// should have the initial text
DriverAssert.AssertDriverContentsAre ("ff", null);
// change the text and redraw
view.Text = "ff1234";
mount.SetNeedsDraw ();
top.SetClipToScreen ();
mount.Draw ();
// should have the new text rendered
DriverAssert.AssertDriverContentsAre ("ff1234", null);
}
finally
{
top.Dispose ();
Application.Shutdown ();
}
}
[Fact]
[AutoInitShutdown]
public void XAxisLabels_With_MarginLeft ()
{
var gv = new GraphView { Viewport = new Rectangle (0, 0, 10, 7) };
gv.CellSize = new PointF (1, 0.5f);
gv.AxisY.Increment = 1;
gv.AxisY.ShowLabelsEvery = 1;
gv.Series.Add (
new ScatterSeries { Points = { new PointF (1, 1), new PointF (5, 0) } }
);
// reserve 3 cells of the left for the margin
gv.MarginLeft = 3;
gv.MarginBottom = 1;
gv.LayoutSubViews ();
gv.SetNeedsDraw ();
gv.Draw ();
var expected =
@$"
2┤
1┤{Glyphs.Dot}
0┼┬┬┬┬{Glyphs.Dot}┬
0 5
";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
[Fact]
[AutoInitShutdown]
public void YAxisLabels_With_MarginBottom ()
{
var gv = new GraphView { Viewport = new Rectangle (0, 0, 10, 7) };
gv.CellSize = new PointF (1, 0.5f);
gv.AxisY.Increment = 1;
gv.AxisY.ShowLabelsEvery = 1;
gv.Series.Add (
new ScatterSeries { Points = { new PointF (1, 1), new PointF (5, 0) } }
);
// reserve 3 cells of the console for the margin
gv.MarginBottom = 3;
gv.MarginLeft = 1;
gv.LayoutSubViews ();
gv.SetNeedsDraw ();
gv.Draw ();
var expected =
@$"
1┤{Glyphs.Dot}
0┼┬┬┬┬{Glyphs.Dot}┬┬┬
0 5
";
DriverAssert.AssertDriverContentsAre (expected, _output);
// Shutdown must be called to safely clean up Application if Init has been called
Application.Shutdown ();
}
}
public class AxisIncrementToRenderTests
{
[Fact]
public void AxisIncrementToRenderTests_Constructor ()
{
var render = new AxisIncrementToRender (Orientation.Horizontal, 1, 6.6f);
Assert.Equal (Orientation.Horizontal, render.Orientation);
Assert.Equal (1, render.ScreenLocation);
Assert.Equal (6.6f, render.Value);
}
}