C# API リファレンス

Axe DevTools C# クラス

このページでは、Axe DevTools C# を構成するクラスを記述しています

class Deque.AxeDevtools.Selenium.AxeSelenium

axe へのインターフェースです。axe の実行方法を変更するための設定と、axe を実行する機能を含んでいます。

AxeSelenium(OpenQA.Selenium.Remote.RemoteWebDriver, ReportConfiguration?, string)

特定の設定を持つページのために新しい AxeSelenium オブジェクトを作成します。

ReportResultsAnalyze()

ページで axe を実行します。

返り値: axe-core をページで実行した時のレポート。

var report = new AxeSelenium(driver).Analyze();

AxeSelenium Configure(Spec)

axe を設定します。これは axe.configure 経由で行われます。

返り値: チェーン用のこのオブジェクト。

var spec = new Spec.Spec {
    Checks = new Spec.Check[] {
        new Spec.Check() {
            Id = "dylang",
            Options = (object) new string[] { "dylan" },
            Evaluate = @"function (node, options) {
              var lang = (node.getAttribute('lang') || '').trim().toLowerCase();
              var xmlLang = (node.getAttribute('xml:lang') || '').trim().toLowerCase();
              var invalid = [];
              (options || []).forEach(function(cc) {
                cc = cc.toLowerCase();
                if (lang && (lang === cc || lang.indexOf(cc.toLowerCase() + '-') === 0)) {
                  lang = null;
                }
                if (xmlLang && (xmlLang === cc || xmlLang.indexOf(cc.toLowerCase() + '-') === 0)) {
                  xmlLang = null;
                }
              });
              if (xmlLang) {
                invalid.push('xml:lang='' + xmlLang + ''');
              }
              if (lang) {
                invalid.push('lang='' + lang + ''');
              }
              if (invalid.length) {
                this.data(invalid);
                return true;
              }
              return false;
            }"
        }
    },
    Rules = new Spec.Rule[] {
        new Spec.Rule() {
            Id = "dylang",
            Selector = "html",
            Tags = new string[] { "wcag2aa" },
            All = new string[0],
            Any = new string[0],
            None = new string[] { "dylang" }
        }
    }
};
var report = new AxeSelenium(driver)
  .Configure(spec)
  .Analyze()

AxeSeleniumDisablingRules(string[])

axe を実行するときに一部のルールを無効にします。

返り値: チェーン用のこのオブジェクト。

var report = new AxeSelenium(driver)
  .DisablingRules("html-has-lang", "label")
  .Analyze()

AxeSeleniumExcluding(string[])

axe を実行するときに除外するページの部分を指定します。

戻り値: チェイン処理のためのこのオブジェクト。

var report = new AxeSelenium(driver)
  .Excluding(".third-party-ad", ".iframe1")
  .Analyze()

AxeSeleniumインクルード(string[])

ページの一部にaxeを実行する範囲を指定します。

戻り値: チェイン処理のためのこのオブジェクト。

var report = new AxeSelenium(driver)
  .Including(".sidebar", ".some-class")
  .Analyze()

AxeSelenium RunOptions(RunOptions)

RunOptions を指定して、axe.runを呼び出す際にaxeに渡します。

戻り値: チェイン処理のためのこのオブジェクト。

var options = new RunOptions.RunOptions {
  IFrames = false,
  RunOnly = RunOptions.RunOnly.Tags(RunOptions.TagType.Wcag2a)
};
var report = new AxeSelenium(driver)
  .RunOptions(options)
  .Analyze()

AxeSeleniumコンフィグファイル指定(string)

コンフィグファイルを見つける場所を設定します。デフォルトのパスはconfig/axe-ruleset.jsonまたは$AXE_RULESET_PATHです。

戻り値: チェイン処理のためのこのオブジェクト。

var report = new AxeSelenium(driver)
  .WithConfigFile("path/to/file.json")
  .Analyze();

AxeSeleniumルール指定(string[])

axeを実行するときに使用するルール（ID）を指定します。

戻り値: チェイン処理のためのこのオブジェクト。

var report = new AxeSelenium(driver)
  .WithRules("document-title", "label")
  .WithRules("html-has-lang")
  .Analyze()

AxeSeleniumルールセット指定(string, bool)

特定のルールセットを使用します（例えば、wcag2.1、508）。

戻り値: チェイン用のこのオブジェクト。

var report = new AxeSelenium(driver)
  .WithRuleset("508", true)
  .Analyze()

AxeSelenium WithTags(TagType[])

実行時に使用するルールをタグで指定します。

戻り値: チェイン用のこのオブジェクト。

var report = new AxeSelenium(driver)
  .WithTags(RunTagType.BestPractice)
  .Analyze()

環境変数

これらの環境変数は、使用サービスを設定し、報告されるイベントのプロパティを変更することができます。

AxeSeleniumEnableTracking(bool)

使用サービスにデータを送信するかどうかをオプトインまたはオプトアウトする。

戻り値: チェイン用のこのオブジェクト。

AxeSeleniumSetTrackingUrl(string)

使用メトリクスデータが送信される場所を設定します。デフォルトはhttps://usage.deque.comです

戻り値: チェイン用のこのオブジェクト。

AxeSeleniumSetDistinctId(string)

使用メトリクス送信時に使用される異なるIDを設定します。

戻り値: チェイン用のこのオブジェクト。

class Deque.AxeDevtools.Selenium.ReportConfiguration

テストスイート名やユーザーエージェント情報など、レポート固有の情報を設定します。

static ReportConfigurationGetDefault()

現在のデフォルト設定を取得します。デフォルトは変更可能であることに注意してください。

戻り値: 現在のデフォルト。

static void ResetDefault()

デフォルトを初期状態にリセットします。

void SetAsDefault()

このオブジェクトをデフォルトとして設定します。

ReportConfiguration.GetDefault()
  .TestSuiteName("my-tests")
  .UIState("home-page")
  .SetAsDefault();

ReportConfigurationTestMachine(string)

これらのテストが実行されたマシンを設定します。

戻り値: チェイン用のこのオブジェクト。

ReportConfigurationTestSuiteName(string)

テストスイート名を設定します。

戻り値: チェイン用のこのオブジェクト。

ReportConfigurationUIState(string)

このテストセットのUI状態を指定します。IDとして使用されます。

戻り値: チェイン用のこのオブジェクト。

ReportConfigurationUserAgent(string)

テスト時に使用されるユーザーエージェントを設定します。

戻り値: チェイン用のこのオブジェクト。

class Deque.AxeDevtools.Selenium.Results.Check

Axeチェックの実行結果。

class Deque.AxeDevtools.Selenium.Results.CheckedNode

ルールによってチェックされたHTMLノード。

class Deque.AxeDevtools.Selenium.Results.Node

特定のHTMLノードを指定する。

class Deque.AxeDevtools.Selenium.Results.Platform

テストが実行されたプラットフォーム。

class Deque.AxeDevtools.Selenium.Results.ReportResults

リポーター形式と互換性のあるテスト結果。

var axe = new AxeSelenium(driver, ReportConfiguration.GetDefault().UIState("UIState"));
var res = axe.Analyze();
File.WriteAllText(reportPath, JsonConvert.SerializeObject(res));

class Deque.AxeDevtools.Selenium.Results.Rule

単一のルールの結果。

class Deque.AxeDevtools.Selenium.Results.TestEngine

テストが実行されたaxe-coreエンジンに関する情報。

class Deque.AxeDevtools.Selenium.Results.TestEnvironment

テストが実施された環境に関する情報。

class Deque.AxeDevtools.Selenium.Results.TestResults

ページでaxeを実行した結果。

class Deque.AxeDevtools.Selenium.Results.TestRunner

テストランナーの名前。

class Deque.AxeDevtools.Selenium.Results.TestSubject

テスト対象に関する情報。

class Deque.AxeDevtools.Selenium.RunOptions.Context

テストする要素としない要素を指定します。

void Excluding(string[])

テストしない要素のセレクターセットを追加します。

void Including(string[])

テストする要素のセレクターセットを追加します。

enum Deque.AxeDevtools.Selenium.RunOptions.ResultGroup

• 合格
• 違反
• 不完全
• 不適用

class Deque.AxeDevtools.Selenium.RunOptions.RuleStatus

ルールを有効化または無効化します。

class Deque.AxeDevtools.Selenium.RunOptions.RunOnly

名前やタグに基づいて実行するルールを制限します。

static RunOnlyRules(string[])

IDに基づいてルールのリミッターを構築します。

戻り値: RunOnly オブジェクト。

static RunOnly タグ(TagType[])

タグに基づくルールの制限を構築します。

戻り値: RunOnly オブジェクト。

enum Deque.AxeDevtools.Selenium.RunOptions.RunOnlyType

• ルール
• ルール
• タグ
• タグ

class Deque.AxeDevtools.Selenium.RunOptions.RunOptions

axe の動作を柔軟に設定します。

enum Deque.AxeDevtools.Selenium.RunOptions.TagType

• Wcag2a
• Wcag2aa
• Wcag2aaa
• Wcag21a
• Wcag21aa
• Wcag21aaa
• Wcag22a
• Wcag22aa
• Wcag22aaa
• Section508
• TTv5
• EN301549
• RGAAv4
• BestPractice

class Deque.AxeDevtools.Selenium.Spec.Check

ルールで使用されるチェックリストにチェックを追加したり、既存のチェックのプロパティを上書きするために使用されます。

class Deque.AxeDevtools.Selenium.Spec.Rule

既存のルールセットにルールを追加したり、既存のルールのプロパティを上書きするために使用されます。

class Deque.AxeDevtools.Selenium.Spec.Spec

axeで使用されるデータの形式を設定します。これを使用して新しいルールを追加できますが、実行するにはライブラリに登録する必要があります。