InterSystems IRIS とソース・コントロール・システムの統合

このページでは、ドキュメントという用語は、ソース・コントロール・システム内に配置する個別のアイテムを指します。これには、クラス定義、ルーチン、データ変換が含まれます。InterSystems IRIS では、最後にコンパイルされてから変更があったかどうかなどの情報が記録されます。ソース・コントロール・システムは、各ドキュメントを個別のユニットとして扱います。

各ドキュメントには 2 つの名前があります。

• 内部名。

• 外部名。これは、ファイル・システム内でのファイルの完全修飾パスです。

内部名と外部名との間に双方向のマッピングを作成することは、ソース・コントロール・システムを実装するうえで最も難しい部分であると言えます。このマッピングは、コードで定義する必要があります。つまり、以下を行う必要があります。

• 内部アイテムの名前が指定されている場合は、対応するファイル名を決定します。

• 変更されたファイルが指定されている場合は、対応する内部アイテムを決定し、変更されたファイルをインポートして更新します。

例えば、次のようなディレクトリ構造を使用できます。

• クラス・ファイルは、クラスのパッケージ階層に対応するサブディレクトリを含む cls サブディレクトリ内にあります。

• .INT ルーチンは int サブディレクトリ内にあります。

• .MAC ルーチンは mac サブディレクトリ内にあります。

異なる環境で複数の開発者がカスタム・ソース・コントロール・クラスを使用できるように、コードでファイルの基本的な場所を構成する方法も提供する必要があります (マッピングを完全にハードコーディングするのではなく)。

InterSystems IRIS には、ドキュメントと外部ファイルを管理するために、以下のツールが用意されています。

• InterSystems IRIS ドキュメントをエクスポートするには、使用するファイル形式に応じて、以下のいずれかを使用します。

  • UDL ファイルの場合は、$system.OBJ.ExportUDL() を使用します。

  • XML ファイルの場合は、$system.OBJ.Export() を使用します。

  UDL ファイルは、IDE で見られるコードにより類似しています。

• (いずれかの形式の) ファイルをインポートするには、$system.OBJ.Load() を使用します。

• InterSystems IRIS ドキュメントのタイムスタンプやコンパイル日時を取得するには、%RoutineMgr.TS クラス・メソッドを使用します。

ソース・コントロール・システムの API には、ファイルのチェック・アウトなど、ソース・コントロールの機能を実行するためのメソッドまたは関数が用意されています。ソース・コントロール・クラスは、この API の適切な呼び出しを行う必要があります。また、InterSystems IRIS サーバは、API 自体を定義する共有ライブラリまたは他のファイルの場所を特定する必要があります。

また、InterSystems IRIS が InterSystems IRIS サーバ上でソース・コントロール・コマンドを実行することにも注意する必要があります。つまり、XML ファイルは InterSystems IRIS サーバ上にあり、ファイル・マッピングが、そのサーバ上で使用するオペレーティング・システムで機能する必要があります。

例 1

以下のフラグメントでは、VSS の API 用のラッパ・メソッドを生成しました。次に、ソース・コントロール・メソッド内に以下のようなコードを含めることができます。

 do ..VSSFile.CheckIn(..VSSFile.LocalSpec,Description)

詳細は、ソース・コントロール・ソフトウェア、その API、および要件によって異なります。

例 2

以下のフラグメントでは、Windows コマンド行インタフェースを使用してファイルをチェック・アウトしています。この例では、ソース・コントロール・システムは Perforce です。

/// Check this routine/class out of source control.
Method CheckOut(IntName As %String, Description As %String) As %Status
{
  Set file=..ExternalName(IntName)
  If file="" Quit $$$OK
  //...
 Set cmd="p4 edit """_file_""""


  #; execute the actual command
  Set sc=..RunCmd(cmd)
  If $$$ISERR(sc) Quit sc

  #; If the file still does not exist or
  #; if it is not writable then checkout failed
  If '##class(%File).Exists(file)||(##class(%File).ReadOnly(file)) {
    Quit $$$ERROR($$$GeneralError,
                  "Failure: '"_IntName_"' not writeable in file sys")
  }

  #; make sure we have latest version
  Set sc=..OnBeforeLoad(IntName)
  If $$$ISERR(sc) Quit sc

  //...
  Quit sc
}

この例では、RunCmd() は、指定したコマンドを実行して一部の汎用エラーのチェックを行う別のメソッドです。(RunCmd() は、コールアウト・インタフェースから OS コマンドを発行します。)

また、この CheckOut() メソッドは、InterSystems IRIS ドキュメントと外部 XML ドキュメントを同期させる OnBeforeLoad() メソッドを呼び出します。