【PowerShell】半角カタカナを全角カタカナに変換する処理をPesterでテストする

はじまり#

リサちゃん

うーん、このカタカナ半角だな・・・

135ml

全角の方が見慣れてるんだよなあ。

半角カタカナとかあまり使いたくない#

まあ、人に見せるための資料を作る時に、なんとか収めたい時に使うことが無いこともギリ無いですけど・・・。

しかし、自分のメモ用には全角カタカナで一律揃えたいので、どこかのWebサイトから情報を引っ張ってくる時に、文字列の中に含まれている半角カタカナを全て全角カタカナにするツールをPowerShellで作りました。

起動用のバッチを実行すれば、表示されるPowerShellコンソール内に文字列を打ち込めば全角カタカナになります。これをコピーして、貼りたい場所に貼って使用できます。

全角カタカナ変換処理のコード#

実行ディレクトリの構成はこれを想定しています。

1
C:.
2
│  Z9-1_convert_to_full_width_kana.bat
3
│  Z9-1_convert_to_full_width_kana.ps1
4
│  Z9-1_convert_to_full_width_kana.Tests.ps1

これが今回のツールのコードです。正味の処理は1行しかありません。

1
function Convert-ToFullWidthKana {
2
  param (
3
      [string]$String
4
  )
5

6
  return $String.Normalize([System.Text.NormalizationForm]::FormKC)
7
}
8

9
$inputString = Read-Host "Input characters containing Katakana."
10

11
if ([string]::IsNullOrWhiteSpace($inputString)) {
12
  Write-Host "No input. This process has cancelled."
13
  exit 1
14
}
15

16
$convertedString = Convert-ToFullWidthKana -String $inputString
17

18
Write-Output ("Input characters: {0}" -f $inputString)
19
Write-Output ("Output characters: {0}" -f $convertedString)
20

21
$tmp = Read-Host "Input any key to terminate this process......";

実行用のバッチの中身はこんな感じです。

1
@echo off
2
setlocal
3

4
Start /WAIT Powershell -Windowstyle Normal -NoProfile -ExecutionPolicy Unrestricted -File "Z9-1_convert_to_full_width_kana.ps1"
5

6
endlocal

Pesterを動かす。#

今回は、「Pester」で動くテストコードも書いてみます。

「Pester」とは、PowerShellスクリプトを単体テストするためのPowerShellに内蔵されているライブラリです。

僕自身、Pesterを使ったことがないので、今回のような単純な処理で使用感を味わってみたいと思います。

pester.dev

Quick Start | Pester

Get started using Pester to test your PowerShell scripts, functions and modules

pester.dev

まずは、単体テストをするディレクトリにて、Pesterをインストールします。

1
Install-Module -Name Pester -Force -SkipPublisherCheck

今回のテストコードはこんな感じです。

1
BeforeAll {
2
  $scriptDir = (Get-Location).Path
3
  $script = (Split-Path -Leaf $PSCommandPath).Replace(".Tests", "")
4
  $script = $scriptDir + "\" + $script
5
  . $script
6
}
7

8
Describe "Convert-ToFullWidthKana Function Tests" {
9

10
  # Normal tests
11
  Context "When converting half-width Katakana to full-width Katakana" {
12
    It "should convert ｶﾀｶﾅ to カタカナ" {
13
      # Arrange
14
      $inputStr = "ｶﾀｶﾅ"
15
      $expected = "カタカナ"
16

17
      # Act
18
      $result = Convert-ToFullWidthKana -String $inputStr
19

20
      # Assert
21
      $result | Should -Be $expected
22
    }
23

24
    It "should convert ﾀﾞﾌﾞﾙｸｫｰﾃｰｼｮﾝ to ダブルクォーテーション" {
25
      $inputStr = "ﾀﾞﾌﾞﾙｸｫｰﾃｰｼｮﾝ"
26
      $expected = "ダブルクォーテーション"
27
      $result = Convert-ToFullWidthKana -String $inputStr
28
      $result | Should -Be $expected
29
    }
30
  }
31

32
  # Abnormal tests
33
  Context "When input is empty or invalid" {
34
    It "should return an empty string when input is empty" {
35
      $inputStr = ""
36
      $expected = ""
37
      $result = Convert-ToFullWidthKana -String $inputStr
38
      $result | Should -Be $expected
39
    }
40

41
    It "should return the original string if no half-width Katakana is present" {
42
      $inputStr = "これはテストです。"
43
      $expected = "これはテストです。"
44
      $result = Convert-ToFullWidthKana -String $inputStr
45
      $result | Should -Be $expected
46
    }
47
  }
48

49
  # Boundary Value Tests
50
  Context "Edge cases" {
51
    It "should handle mixed input with half-width and full-width characters" {
52
      $inputStr = "ﾊﾝｶｸと全角カタカナ"
53
      $expected = "ハンカクと全角カタカナ"
54
      $result = Convert-ToFullWidthKana -String $inputStr
55
      $result | Should -Be $expected
56
    }
57

58
    It "should handle mixed input with half-width and full-width characters and mixed Japanese and English characters" {
59
      $inputStr = "ﾊﾞﾝｶﾞｰﾄﾞFTSEｴﾏｰｼﾞﾝｸﾞ･ﾏｰｹｯﾂET"
60
      $expected = "バンガードFTSEエマージング・マーケッツET"
61
      $result = Convert-ToFullWidthKana -String $inputStr
62
      $result | Should -Be $expected
63
    }
64

65
    It "should handle numeric and symbol characters without changes" {
66
      $inputStr = "12345 &@"
67
      $expected = "12345 &@"
68
      $result = Convert-ToFullWidthKana -String $inputStr
69
      $result | Should -Be $expected
70
    }
71
  }
72
}

それではテストコードを実行してみます。

1
Invoke-Pester .\Z9-1_convert_to_full_width_kana.Tests.ps1

Pesterを実行してみると・・・アレッ。こんなエラーメッセージが表示されて全てのテストが失敗しました。

1
Starting discovery in 1 files.
2
Discovery found 7 tests in 204ms.
3
Running tests.
4
[-] Convert-ToFullWidthKana Function Tests.When converting half-width Katakana to full-width Katakana.should convert ｶﾀｶﾅ to カタカナ 66ms (39ms|26ms)
5
CommandNotFoundException: The term 'Convert-ToFullWidthKana' is not recognized as a name of a cmdlet, function, script file, or executable program.
6
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
7
at , /home/user/PictureExifOptimizer/codes/Z9-1_convert_to_full_width_kana.Tests.ps1:13
8
[-] Convert-ToFullWidthKana Function Tests.When converting half-width Katakana to full-width Katakana.should convert ﾀﾞﾌﾞﾙｸｫｰﾃｰｼｮﾝ to ダブルクォーテーション 24ms (23ms|1ms)
9
CommandNotFoundException: The term 'Convert-ToFullWidthKana' is not recognized as a name of a cmdlet, function, script file, or executable program.
10
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
11
at , /home/user/PictureExifOptimizer/codes/Z9-1_convert_to_full_width_kana.Tests.ps1:23

エラーメッセージで調べてみると、どうやらDescribeブロックの実行前にBeforeAllブロックが必要らしい。

1
BeforeAll {
2
  $scriptDir = (Get-Location).Path
3
  $script = (Split-Path -Leaf $PSCommandPath).Replace(".Tests", "")
4
  $script = $scriptDir + "\" + $script
5
  # Import-Module $script
6
  . $script
7
}

再びPesterを実行すると・・・、なんか止まった。

1
Starting discovery in 1 files.
2
Discovery found 7 tests in 43ms.
3
Running tests.
4
Input characters containing Katakana.:

あっ・・・、ファイルの中の全てが実行されるのか。だから入力待ちになっている・・・。適当に「v」とか何でもいいので入力します。

すると・・・成功！

1
[+] /home/userxxxx/PictureExifOptimizer/codes/Z9-1_convert_to_full_width_kana.Tests.ps1 4.19s (4.13s|47ms)
2
Tests completed in 4.19s
3
Tests Passed: 7, Failed: 0, Skipped: 0, Inconclusive: 0, NotRun: 0

かなり使いやすくて良いですね。

テスト対象をスコープに入れる。#

ちなみに、BeforeAllブロックの中でテスト対象のスクリプトファイルを呼び出す処理を行っていますが。

1
BeforeAll {
2
  $scriptDir = (Get-Location).Path
3
  $script = (Split-Path -Leaf $PSCommandPath).Replace(".Tests", "")
4
  $script = $scriptDir + "\" + $script
5
  # Import-Module $script -Scope "Global"
6
  . $script
7
}

そして、「. $script」という処理で、テスト対象を現在のスコープの中にいれる処理を行っています。

このドットを頭に打ち込んでから、コマンドを実行しています。この記法を「ドットソース表記」と呼ぶらしく、コマンドを実行する前に新しいスコープは作成されません。なので、独自のローカルスコープに加えた追加や変更は、代わりに現在のスコープに対して行われるようです。

PowerShellではスクリプト実行時に、「スクリプトファイル」、「スクリプトブロック」、「関数またはフィルター」の括りでスコープが作成されます。なので、$scriptでスクリプトを実行してしまうと、そのテスト対象のスクリプトのスコープは「BeforeAllブロック」の中で閉じてしまうのでしょうか、CommandNotFoundExceptionの例外となってテストに失敗しました。「. $script」実行時には、「スクリプトファイル」内のスコープに入るってわけか。へえ、ブロック内にある処理に関係するモジュールのスコープは、全てそのブロックの中のものになると思っていたんですけど、実行時にスコープは定義されるのか・・・。それは知らなかった。

@MicrosoftLearn

基本的な概念 - PowerShell

PowerShell プロバイダーでは、コマンドラインからデータとコンポーネントにアクセスできます。データは、ファイルシステムドライブに似た一貫性のある形式で表示されます。

learn.microsoft.com

Import-Moduleではテストできない。#

さらにちなみに、BeforeAllブロックの中にImport-Moduleがコメントアウトされて書いてありますが。

1
BeforeAll {
2
  $scriptDir = (Get-Location).Path
3
  $script = (Split-Path -Leaf $PSCommandPath).Replace(".Tests", "")
4
  $script = $scriptDir + "\\" + $script
5
  # Import-Module $script -Scope "Global"
6
  . $script
7
}

なぜ、Import-Moduleなどと書いてあるかと言うと、テストを試している途中でエラーメッセージで表示されていたからです。しかし、このコマンドレットでテスト対象のスクリプトをモジュールとしてインポートしようとしてもテストは出来ませんでした。

詳しいロジックはちょっと分かりませんが、今回のテストは、「モジュールをテストしようとしているわけではない。」ということだからなんですかね。

@MicrosoftLearn

Import-Module (Microsoft.PowerShell.Core) - PowerShell

Import-Module コマンドレットは、現在のセッションに 1 つ以上のモジュールを追加します。 PowerShell 3.0 以降では、モジュール内のコマンドまたはプロバイダーを使用すると、インストールされているモジュールがセッションに自動的にインポートされます。ただし、Import-Module コマンドを使用してモジュールをインポートすることはできます。 $PSModuleAutoLoadingPreference 基本設定変数を使用して、モジュールの自動インポートを無効にすることができます。 $PSModuleAutoLoadingPreference 変数の詳細については、about_Preference_Variablesを参照してください。モジュールは、PowerShell で使用できるメンバーを含むパッケージです。メンバーには、コマンドレット、プロバイダー、スクリプト、関数、変数、およびその他のツールとファイルが含まれます。モジュールがインポートされたら、セッションでモジュールメンバーを使用できます。モジュールの詳細については、about_Modulesを参照してください。既定では、モジュールがエクスポートするすべてのメンバー Import-Module インポートされますが、Alias、Function、Cmdlet、および Variable パラメーターを使用して、インポートするメンバーを制限できます。 NoClobber パラメーターを指定すると、Import-Module は現在のセッションのメンバーと同じ名前のメンバーをインポートできなくなります。 Import-Module は、モジュールを現在のセッションにのみインポートします。新しいセッションごとにモジュールをインポートするには、PowerShell プロファイルに Import-Module コマンドを追加します。プロファイルの詳細については、about_Profilesを参照してください。リモートコンピューターに PSSession を作成することで、PowerShell リモート処理が有効になっているリモート Windows コンピューターを管理できます。次に、の Import-Module パラメーターを使用して、リモートコンピューターにインストールされているモジュールをインポートします。現在のセッションでインポートされたコマンドを使用すると、コマンドはリモートコンピューターで暗黙的に実行されます。 Windows PowerShell 3.0 以降では、Import-Module を使用して共通情報モデル (CIM) モジュールをインポートできます。 CIM モジュールは、コマンドレット定義 XML (CDXML) ファイルでコマンドレットを定義します。この機能を使用すると、C++ で記述されたコマンドレットなど、非マネージドコードアセンブリに実装されているコマンドレットを使用できます。 Windows オペレーティングシステムを実行していないコンピューターなど、PowerShell リモート処理が有効になっていないリモートコンピューターの場合は、の Import-Module パラメーターを使用して、リモートコンピューターから CIM モジュールをインポートできます。インポートされたコマンドは、リモートコンピューターで暗黙的に実行されます。 CIMSession は、リモートコンピューター上の Windows Management Instrumentation (WMI) への接続です。

learn.microsoft.com

テストのカバレッジを取得する。#

さらにさらに、Pesterでは実行ディレクトリにおけるテストカバレッジも取得できます。

pester.dev

Generating Code Coverage Metrics | Pester

Pester can generate code coverage metrics to help you understand how many lines of your PowerShell code that is actually covered by your Pester-tests. Use this to increase confidence in your tests

pester.dev

Pesterの公式ドキュメントにある「Generating Code Coverage Metrics」の項にある「Quick Start」に書いてあるスニペットをそのままテスト対象のディレクトリで実行します。

1
# Create a Pester configuration object using `New-PesterConfiguration`
2
$config = New-PesterConfiguration
3

4
# Set the test path to specify where your tests are located. In this example, we set the path to the current directory. Pester will look into all subdirectories.
5
$config.Run.Path = "."
6

7
# Enable Code Coverage
8
$config.CodeCoverage.Enabled = $true
9

10
# Run Pester tests using the configuration you've created
11
Invoke-Pester -Configuration $config

ちゃんと実行されると、テスト終了後にこんな感じに表示されます。

1
Running tests.
2
Input characters containing Katakana.: v
3
[+] /home/userxxxxxxx/PictureExifOptimizer/codes/Z9-1_convert_to_full_width_kana.Tests.ps1 2.6s (2.44s|155ms)
4
Tests completed in 2.61s
5
Tests Passed: 7, Failed: 0, Skipped: 0, Inconclusive: 0, NotRun: 0
6
Processing code coverage result.
7
Covered 0.71% / 75%. 845 analyzed Commands in 22 Files.

うーんまあ、そりゃあ他のスクリプトのテストは書いてないからなあ・・・。

とりあえず、カバレッジを取ることも出来ました！ちなみに、実行ディレクトリの中に、より詳細な内容が記録されているcoverage.xmlというファイルも出力されましたとさ。中身はこんな感じでした。classタグとsourcefileタグに分かれてデータが入っていますね。

1
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
<!DOCTYPE report PUBLIC "-//JACOCO//DTD Report 1.1//EN" "report.dtd"[]>
3
<report name="Pester (11/15/2024 18:43:45)">
4
  <sessioninfo id="this" start="1731696222526" dump="1731696225137" />
5
  <package name="codes">
6
    <class name="codes/1-2-2_move_mp4" sourcefilename="1-2-2_move_mp4.ps1">
7
      <method name="<script>" desc="()" line="1">
8
        <counter type="INSTRUCTION" missed="1" covered="0" />
9
        <counter type="LINE" missed="1" covered="0" />
10
        <counter type="METHOD" missed="1" covered="0" />
11
      </method>
12
      <counter type="INSTRUCTION" missed="1" covered="0" />
13
      <counter type="LINE" missed="1" covered="0" />
14
      <counter type="METHOD" missed="1" covered="0" />
15
      <counter type="CLASS" missed="1" covered="0" />
16
    </class>
17
    <class name="codes/1-2-3_set_create_date" sourcefilename="1-2-3_set_create_date.ps1">
18

19
      ...
20

21
    </class>
22
    <class name="codes/Z9-1_convert_to_full_width_kana" sourcefilename="Z9-1_convert_to_full_width_kana.ps1">
23
      <method name="Convert-ToFullWidthKana" desc="()" line="6">
24
        <counter type="INSTRUCTION" missed="0" covered="1" />
25
        <counter type="LINE" missed="0" covered="1" />
26
        <counter type="METHOD" missed="0" covered="1" />
27
      </method>
28
      <method name="<script>" desc="()" line="9">
29
        <counter type="INSTRUCTION" missed="2" covered="5" />
30
        <counter type="LINE" missed="2" covered="5" />
31
        <counter type="METHOD" missed="0" covered="1" />
32
      </method>
33
      <counter type="INSTRUCTION" missed="2" covered="6" />
34
      <counter type="LINE" missed="2" covered="6" />
35
      <counter type="METHOD" missed="0" covered="2" />
36
      <counter type="CLASS" missed="0" covered="1" />
37
    </class>
38
    <sourcefile name="1-2-2_move_mp4.ps1">
39
      <line nr="1" mi="1" ci="0" mb="0" cb="0" />
40
      <counter type="INSTRUCTION" missed="1" covered="0" />
41
      <counter type="LINE" missed="1" covered="0" />
42
      <counter type="METHOD" missed="1" covered="0" />
43
      <counter type="CLASS" missed="1" covered="0" />
44
    </sourcefile>
45
    <sourcefile name="1-2-3_set_create_date.ps1">
46

47
      ...
48

49
    </sourcefile>
50
    <sourcefile name="Z9-1_convert_to_full_width_kana.ps1">
51
      <line nr="6" mi="0" ci="1" mb="0" cb="0" />
52
      <line nr="9" mi="0" ci="1" mb="0" cb="0" />
53
      <line nr="11" mi="0" ci="1" mb="0" cb="0" />
54
      <line nr="12" mi="1" ci="0" mb="0" cb="0" />
55
      <line nr="13" mi="1" ci="0" mb="0" cb="0" />
56
      <line nr="16" mi="0" ci="1" mb="0" cb="0" />
57
      <line nr="18" mi="0" ci="1" mb="0" cb="0" />
58
      <line nr="19" mi="0" ci="1" mb="0" cb="0" />
59
      <counter type="INSTRUCTION" missed="2" covered="6" />
60
      <counter type="LINE" missed="2" covered="6" />
61
      <counter type="METHOD" missed="0" covered="2" />
62
      <counter type="CLASS" missed="0" covered="1" />
63
    </sourcefile>
64
    <counter type="INSTRUCTION" missed="839" covered="6" />
65
    <counter type="LINE" missed="639" covered="6" />
66
    <counter type="METHOD" missed="45" covered="2" />
67
    <counter type="CLASS" missed="21" covered="1" />
68
  </package>
69
  <counter type="INSTRUCTION" missed="839" covered="6" />
70
  <counter type="LINE" missed="639" covered="6" />
71
  <counter type="METHOD" missed="45" covered="2" />
72
  <counter type="CLASS" missed="21" covered="1" />
73
</report>