EN JP CN

既存のプロジェクトを新しいプロジェクトルートにインポートする

既存のプロジェクトを新しいプロジェクトルートにインポートする

既存のプロジェクトを新しいプロジェクトルートにインポートする

既存のプロジェクトを新しいプロジェクトルートにインポートする

Klocwork には、既存の projects_root のプロジェクトを新しい Klocwork インストールにインポートするための簡素な GUI が追加されました。この GUI では、コマンドラインを使用したり、データベースを検証したりすることなく、プロジェクトごとにデータを移行することができます。

プロジェクトをインポートする前に、新しくインストールする Klocwork 製品でこの機能がサポートされていることを確認してください。

注: アップグレードには、この方法をお勧めします。

一般的に、このプロセスには以下の手順が必要です。

  • 既存の projects_root のバックアップ (念のため)
  • 新しい Klocwork サーバーのインストール (新しいマシン上か、または別のポート番号を使用)
  • 新しいサーバーの起動、ポータルのオープン、GUI を使った既存プロジェクトの新しいサーバーへのインポート
  • 新しくインストールしたサーバーのテスト後、既存サーバーのアンインストールおよび projects_root の削除

お使いになる前に

インポートには、既存のインストール済み Klocwork (および projects_root) と新規にインストールする Klocwork (および空の projects_root) を同時に実行する必要があります。新しいサーバーをインストールしたら、既存の projects_root 内のすべてのプロジェクトを空の projects_root にインポートする必要があります。

同じマシン上で 2 台の Klocworkサーバーを実行するには、それぞれに一意のポート番号が指定されていなければなりません。新しい Klocwork を同じマシンにインストールする場合は、別のポート番号を使用して既存のサーバーを停止および再起動するようにお勧めします。これによって、新しくインストールしたサーバーに対して既存のポート番号を引き続き使用することができます。

ソフトウェアの新規メジャーリリースに移行する場合、メジャーリリースに新しい Klocwork ライセンスが必要な場合など、適格なライセンスのあることを確認してください。詳細については、ライセンス を参照してください。

また FlexLM は、各マシンで 2 つ以上のベンダーデーモンのインスタンスが起動されないようにするので、1 つのホストで 2 つのライセンスサーバーを実行できません。この場合、1 つのライセンス サーバーを実行し、両方のKlocworkインストールをライセンス サーバーにポイントする必要があります。詳細については、複数の projects_root ディレクトリを使用する場合のライセンスを参照してください。

Klocwork サーバーとデータベース サーバーの両方には、インポート プロセス時に対象のサーバーからアクセスできるように割り当てられた完全修飾ドメイン名か IP アドレスが必要です。localhost は使用しないでください。

注: インポート操作を実行するには、プロジェクトの root 管理者アクセスが必要です。

プロジェクトのインポートに対応した Klocwork バージョンについてサポートされるアップグレード パス

下の表で最新のバージョンおよび適切なアップグレード パスを確認してください。適切なバージョンの Klocwork へのアップグレードが完了したら、アップグレード後の Insight を使用して既存のプロジェクトをインポートしてください。下のチャートは、最新の現行リリースを正確に示しています。

Klocwork のバージョンを使用している場合は、 以下のバージョンのインポートがサポートされています。
10.3 最新Klocwork 2017 最新
10.4 最新Klocwork 2017 最新
11.0 最新Klocwork 2017 最新
11.1 最新Klocwork 2017 最新
11.2 最新Klocwork 2017 最新
11.3 最新Klocwork 2017 最新

リリース間の相互運用

Klocwork 2017 製品の以前のバージョンとの後方互換性はありません。Server と Desktop Analysis プラグインインストールの両方をアップグレードする必要があります。

使用している現行の Klocwork サーバーのバージョンがインポートされるプロジェクトのバージョン要件を満たさない場合は、既存の Klocwork のバージョンをサポートされているサービス リリースまたはバージョンに更新します。次に最新バージョンの Klocwork をインストールします。最新バージョンの Klocwork をインストールしてから、それを使用して既存の Klocwork サーバーに接続してプロジェクトをインポートします。プロジェクトをインポートするには、下記の手順に従ってください。

Klocworkサーバーパッケージのインストール

Klocwork 2017 サーバーパッケージをインストールします。詳しい手順については、Klocworkのインストールを参照してください。

ライセンス ファイルを <projects_root>/licenses にコピーします。

注: オプションの詳細については、ライセンスを参照してください。

サーバーを起動します。

新しいバージョンの Klocwork のインストールを完了してから、サーバーを起動します。Klocwork のインストールごとに、一意のホスト名およびポート番号の組合せを指定する必要があります。

一意のホスト名とポート番号の組合せの指定は、起動時またはインストールプロセス中に行うことができます。詳細については、Klocwork サーバーの管理を参照してください。

ログイン先 Klocwork Static Code Analysis

Klocwork サーバーを開始した後、Klocwork Static Code Analysis は、Klocwork サーバー ホスト名の URL と、インストール時に選択した Klocwork サーバー ポート (たとえば、server21:8080) を使用してアクセスできます。デフォルトでは、Klocwork をインストールした人が Klocwork 管理者になり、プロジェクト root 管理者の役割に割り当てられます。最初は、基本認証アクセス制御メソッドが使用されるので、パスワードなしでログインできます。たとえば、インストール時に使用したユーザー アカウントが jsmith の場合、管理者の役割で Static Code Analysis にログインするには、次の資格情報を使用します。
username: jsmith
password: <empty>
セキュリティと認証方法の詳細については、セキュリティとパーミッション を参照してください。

プロジェクトとサーバー設定のインポート

新しい Klocwork サーバーがインストールされ、ポータルが立ち上がった状態になったら、既存の Klocwork からサーバー設定およびプロジェクトをインポートできます。

既存のソースサーバーからサーバー設定をインポートすると、宛先サーバー上に存在するプロジェクトのみのパーミッション設定とともにすべてのグローバル パーミッション設定がインポートされます。つまり、サーバー A の設定をサーバー B に設定してから、サーバー A のプロジェクトをサーバー B にインポートする場合、プロジェクト A に固有のパーミッション設定はサーバー B に繰り越されません。プロジェクト A のプロジェクト固有パーミッション設定を繰り越すには、インポート操作を実行した後でサーバー設定を再インポートしなければなりません。

重要: プロジェクトにカスタム設定が含まれている場合は、プロジェクト インポートを実行した後でサーバー設定を再インポートする必要があります。

また、大量の指摘とビルドを含む projects_root をインポートすると、新しい projects_root が大きくなる可能性があることに注意してください。

既存のプロジェクトをインポートするには、次の手順に従います。

  1. Klocwork ポータルで Klocwork Static Code Analysis をクリックし、プロジェクトの root 管理者ユーザーアカウント として製品にログインします。
  2. [プロジェクト] タブをクリックします。
    その際、Insight を初めて使用する場合は、[設定またはプロジェクトのインポート] ボタンをクリックします。
    既にプロジェクトを作成したか、またはインポートした場合は、[インポート] ボタンをクリックします。
  3. [Klocwork server connection] ダイアログで、既存の Klocwork (設定やプロジェクトのインポート元) のログインおよび接続情報を指定します。指定項目は以下のとおりです。
    • 既存のサーバーの URL (例: http://server21:8082
    • ユーザー名。注意: サーバーに接続してプロジェクトをインポートするには、プロジェクトの root 管理者権限が必要です。
    • パスワード (必要に応じて)
  4. [サーバー構成のインポート] をクリックして既存のサーバーの構成設定をインポートします。この設定には、認証構成設定、パーミッション、カスタム メトリクス、レポート定義、電子メール購読設定が含まれます。
    注意:認証設定をインポートする場合、認証情報が無効になることがあるため、システムからログアウトされることがあります。この場合、今インポートした Admin 認証情報でログインしてください。
  5. [プロジェクトのリスト] をクリックして既存の projects_root にあるプロジェクトのリストを表示します。
  6. [インポートするプロジェクトの選択] ダイアログで、新しい projects_root にインポートするプロジェクトを選択します。
  7. [インポート] をクリックします。[Import status] ダイアログに、[プロジェクト インポート]のステータスが表示され、[プロジェクト] タブの上部にインポート ステータス メッセージが表示されます。
    正常にインポートされたプロジェクトはプロジェクトリストに表示されます。
    注: インポートプロセス中に、プロジェクトがアクティブにインポートされるときに、[プロジェクト] ビューの指摘情報がソースプロジェクトのデータに正確に反映されていない場合があります。[プロジェクト] ビューの情報は、インポート操作が完了すると同時に更新されます。インポート ステータス インジケーターをチェックすると、進行状況を確認できます。
  8. [サーバー構成のインポート] を再びクリックしてプロジェクトに固有の構成設定をインポートします。サーバー設定を再インポートしないとプロジェクトに固有の構成設定はすべて失われるため、このステップは必須です。
  9. インポートするプロジェクトごとに [パーミッション] をクリックして、各プロジェクトのパーミッションが正しいことを確認します。

各プロジェクトのパーミッションを確認することが重要なのは、ソース サーバーと宛先サーバーの間でインポート時にパーミッションが統合されるためです。インポート操作が完了するたびにこのプロセスを繰り返し、インポート元の各ソースサーバーのサーバー設定を再インポートするよう注意する必要があります。

Web API を使用したプロジェクトのインポート

Klocwork Web API を使用すると、コマンド ラインでプロジェクトをインポートすることができます。Web API では Web API アクセス権限が必要です。デフォルトでは、プロジェクト管理者役割とプロジェクトの root 管理者役割は Web API にアクセスできます。次の例は、プロジェクトをインポートするための curl スクリプトです。

curl --data "action=import_project&user=myself&project=my_project&sourceURL=
http://oldserver:8080&sourceAdmin=user&sourcePassword=pwd" http://localhost.mycompany.com:8080/review/api

フィールド

  • project は、インポートするプロジェクトの名前です。
  • sourceURL は、インポート元の既存の Klocwork サーバーの URL です。
  • sourceAdmin は、インポート元の Klocwork サーバー管理者 (プロジェクトの root への管理アクセス権を持っている必要があります) のユーザー ID です。
  • sourcePassword は管理者のパスワードです。

インポート元の projects_root フォルダーにあるプロジェクトすべてのリストを取得するには、次のコマンドを実行します。

curl --data "action=projects&user=myself&" http://localhost.mycompany.com:8080/review/api

Web API を使用してサーバー構成設定をインポートすることもできます。

curl --data "action=import_server_configuration&user=myself&sourceURL=
http://oldserver:8080&sourceAdmin=user&sourcePassword=pwd" http://localhost.mycompany.com:8080/review/api

通常、これらの操作のスクリプトは、Python などの言語で作成されています。Python を使用した curl 呼び出しの記述例については、KlocworkWeb API クックブックを参照してください。

分類基準ファイルのインポート

これまでのリリースで MISRA などのカスタム分類基準をインポートしている場合は、新しい分類基準ファイルをインポートして変更を反映させてください。分類基準の変更リストについては、新機能 を参照してください。MISRA チェッカーを利用している場合、<server_install>/taxonomies フォルダから misra.checkers.zip ファイルを <projects_root>/plugins フォルダにコピーする必要があります。

コードレビューのインポート

既存のコードレビューは、新しいプロジェクトルートにインポートできます。

既存の Klocwork Inspect コードレビューをインポートするには、次の手順に従います。

注: コードレビューデータをインポートするには、ローカルのプロジェクトルートに同等のプロジェクトが必要です。コードレビューデータをインポートすると、現在の projects_root フォルダーにある既存のコードレビューデータは上書きされます。
  1. Klocwork 製品ポータルで [Code Review] をクリックします。
  2. [設定] をクリックし、左側のペインの [インポート] をクリックします。
  3. [コードレビューのインポート] をクリックしてから、ソース Klocwork サーバーの URL、ソースプロジェクトルートの Klocwork 管理者のユーザー ID、およびパスワードを指定します (必要に応じて)。
  4. インポートするプロジェクトを選択し、[インポート] をクリックします。

既存の Klocwork Code Review またはコホートコードレビューをインポートするには、次の手順に従います。

注: Klocwork Code Review では、コードレビューをプロジェクト別に編成しません。Code Review サーバーから既存のコードレビューをインポートする場合、タグによってコードレビューを指定する必要があります。
  1. Klocwork 製品ポータルで [Code Review] をクリックします。
  2. [設定] をクリックし、左側のペインの [インポート] をクリックします。
  3. [コードレビューのインポート] をクリックしてから、ソース Klocwork Code Review サーバーの URL、ソースプロジェクトルートの Klocwork 管理者のユーザー ID、およびパスワードを指定します (必要に応じて)。
  4. コードレビューをインポートするローカルプロジェクトを選択します。
  5. 左側のペインで、インポートするタグを選択します。
  6. [割り当て] をクリックして、選択したプロジェクトにタグを割り当てます。
  7. [インポート] をクリックしてコードレビューをインポートします。

アップグレードのテスト

プロジェクトおよびビルドが Klocwork Static Code Analysis に表示されることを確認します。

新しいライセンスファイルをインストールした場合、使用中のライセンス数の確認により、ライセンスファイルが正しくインストールされたことを確認します。

新しくインストールされたサーバーの立ち上げ

新しくインストールされたサーバーが有効で、既存のプロジェクトが正しくインポートされことを確認したら、サーバーを立ち上げます。

新しいサーバーの新規で一意のポート番号を選択したら、ユーザーにこの情報を通知してください。

既存のポート番号を再利用する (ユーザーが自身のローカル設定を更新しなくても済むように) 場合は、すべての Klocwork サーバーを停止して再起動し、新しいサーバーに既存のサーバーのポート番号を指定してください。

すべてのデスクトップ解析プラグインをアップグレードする

Klocwork のすべてのプラグインが Klocwork 2017 にアップグレードしたことを確認します。

Klocwork Desktop Analysis プラグインを一度立ち上げた後は、Klocwork ポータルから適切なプラグインをダウンロードすることによりユーザー自身がプラグインを再インストールできます。サーバーにプラグインをダウンロードおよび展開する方法の手順については、デスクトップ解析プラグインのダウンロードと展開 を参照してください。
注: Klocwork Visual Studio 2010+ 機能拡張にアップグレードする際は、以前のバージョンのプラグインで生成された解析結果データはすべて削除されます。このため、まだサーバーと同期されていないローカルの欠陥更新情報はすべて失われます。新しいプラグインから解析結果を取得するために、使用ソリューションを再解析することができます。

最初の統合ビルド解析の前にKlocwork 2017

通常、新しいリリースの Klocwork には、現在のイベントに対応して顧客の要求に応えるようにチェッカー設定が変更されています。これらの変更は、以前のリリースからのチェッカー設定と新しいリリースの設定が異なっていることを意味している可能性があります。

古い設定に対応する正しいチェッカーが有効になっていることを確認してください。新機能で更新されたチェッカーのリストを確認し、チェッカー設定を変更してください。設定が完了したら、修正されないソースコードで最初の Klocwork 2017 統合ビルド解析を実行します。

注: 既に最初の Klocwork 2017 解析を実行しており、指摘またはステータス変更の一部が欠落している場合は、そのビルドを削除し、チェッカーを再設定して新しい解析を実行します。

最後のプレアップグレード統合ビルド解析と最初のバージョン Klocwork 2017 解析を同じソースコードに実行してから、2 つのビルドを比較することをお勧めします。こうすると、解析エンジンの変化を正しく評価できます。このバージョンのチェッカーの改良、追加、削除の詳細については、新機能を参照してください。