dotnet/test/common/PrintTest.cs

// <copyright file="PrintTest.cs" company="Selenium Committers">
// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.
// </copyright>

using NUnit.Framework;
using System;

namespace OpenQA.Selenium;

[TestFixture]
public class PrintTest : DriverTestFixture
{
    private const string MagicString = "JVBER";
    private ISupportsPrint printer;

    [SetUp]
    public void LocalSetUp()
    {
        Assert.That(driver, Is.InstanceOf<ISupportsPrint>(), $"Driver does not support {nameof(ISupportsPrint)}.");

        printer = driver as ISupportsPrint;

        driver.Navigate().GoToUrl(this.printPage);
    }

    [Test]
    public void CanPrintPage()
    {
        var pdf = printer.Print(new PrintOptions());

        Assert.That(pdf.AsBase64EncodedString, Does.Contain(MagicString));
    }

    [Test]
    public void CanPrintTwoPages()
    {
        var options = new PrintOptions();

        options.AddPageRangeToPrint("1-2");

        var pdf = printer.Print(options);

        Assert.That(pdf.AsBase64EncodedString, Does.Contain(MagicString));
    }

    [Test]
    public void CanPrintWithMostParams()
    {
        var options = new PrintOptions()
        {
            Orientation = PrintOrientation.Landscape,
            ScaleFactor = 0.5,
            PageDimensions = new PrintOptions.PageSize { Width = 200, Height = 100 },
            PageMargins = new PrintOptions.Margins { Top = 1, Bottom = 1, Left = 2, Right = 2 },
            OutputBackgroundImages = true,
            ShrinkToFit = false
        };

        options.AddPageRangeToPrint("1-3");

        var pdf = printer.Print(options);

        Assert.That(pdf.AsBase64EncodedString, Does.Contain(MagicString));
    }

    [Test]
    public void PageSizeCannotBeNull()
    {
        Assert.That(() => new PrintOptions { PageDimensions = null }, Throws.InstanceOf<ArgumentNullException>());
    }

    [Test]
    public void MarginsCannotBeNull()
    {
        Assert.That(() => new PrintOptions { PageMargins = null }, Throws.InstanceOf<ArgumentNullException>());
    }

    [Test]
    public void PageNumberCannotHaveInvalidValues()
    {
        Assert.That(() => new PrintOptions().AddPageToPrint(-1), Throws.TypeOf<ArgumentOutOfRangeException>());
        Assert.That(() => new PrintOptions().AddPageRangeToPrint(null), Throws.TypeOf<ArgumentException>());
        Assert.That(() => new PrintOptions().AddPageRangeToPrint(""), Throws.TypeOf<ArgumentException>());
        Assert.That(() => new PrintOptions().AddPageRangeToPrint("1-2-3"), Throws.TypeOf<ArgumentException>());
        Assert.That(() =>
        {
            var options = new PrintOptions();
            options.AddPageToPrint(1);
            options.AddPageToPrint(1);
        }, Throws.TypeOf<ArgumentException>());
    }

    [Test]
    public void PageSizeCannotHaveNegativeValues()
    {
        Assert.That(() => new PrintOptions.PageSize { Height = -1 }, Throws.TypeOf<ArgumentOutOfRangeException>());
        Assert.That(() => new PrintOptions.PageSize { HeightInInches = -1 }, Throws.TypeOf<ArgumentOutOfRangeException>());
        Assert.That(() => new PrintOptions.PageSize { Width = -1 }, Throws.TypeOf<ArgumentOutOfRangeException>());
        Assert.That(() => new PrintOptions.PageSize { WidthInInches = -1 }, Throws.TypeOf<ArgumentOutOfRangeException>());
    }

    [Test]
    public void MarginsCannotHaveNegativeValues()
    {
        Assert.That(() => new PrintOptions.Margins { Top = -1 }, Throws.TypeOf<ArgumentOutOfRangeException>());
        Assert.That(() => new PrintOptions.Margins { Bottom = -1 }, Throws.TypeOf<ArgumentOutOfRangeException>());
        Assert.That(() => new PrintOptions.Margins { Left = -1 }, Throws.TypeOf<ArgumentOutOfRangeException>());
        Assert.That(() => new PrintOptions.Margins { Right = -1 }, Throws.TypeOf<ArgumentOutOfRangeException>());
    }

    [Test]
    public void CanSetPredefinedPageSizes()
    {
        var options = new PrintOptions();

        options.PageDimensions = PrintOptions.PageSize.A4;
        Assert.That(options.PageDimensions.Width, Is.EqualTo(PrintOptions.PageSize.A4.Width));
        Assert.That(options.PageDimensions.Height, Is.EqualTo(PrintOptions.PageSize.A4.Height));

        options.PageDimensions = PrintOptions.PageSize.Legal;
        Assert.That(options.PageDimensions.Width, Is.EqualTo(PrintOptions.PageSize.Legal.Width));
        Assert.That(options.PageDimensions.Height, Is.EqualTo(PrintOptions.PageSize.Legal.Height));

        options.PageDimensions = PrintOptions.PageSize.Letter;
        Assert.That(options.PageDimensions.Width, Is.EqualTo(PrintOptions.PageSize.Letter.Width));
        Assert.That(options.PageDimensions.Height, Is.EqualTo(PrintOptions.PageSize.Letter.Height));

        options.PageDimensions = PrintOptions.PageSize.Tabloid;
        Assert.That(options.PageDimensions.Width, Is.EqualTo(PrintOptions.PageSize.Tabloid.Width));
        Assert.That(options.PageDimensions.Height, Is.EqualTo(PrintOptions.PageSize.Tabloid.Height));
    }

    [Test]
    public void CanSetCustomPageSize()
    {
        var options = new PrintOptions();
        var customPageSize = new PrintOptions.PageSize { Width = 25.0, Height = 30.0 };

        options.PageDimensions = customPageSize;

        Assert.That(options.PageDimensions.Width, Is.EqualTo(25.0));
        Assert.That(options.PageDimensions.Height, Is.EqualTo(30.0));
    }

}