[C++][IWYU] Include What You Use CL を VS2019 対応しました

include-what-you-use-cl を VS2017/VS2019 に対応しました。

include-what-you-use-ci (以下 IWYU-CL) は include-what-you-use (以下 IWYU) を Visual Studio のプラットフォームツールセットとして選択できるようにするツールです。

プラットフォームツールセットとすることでプロジェクトの設定（インクルードパスなど）をそのまま利用して IWYU をかけることを目的に作りました。

VS2017 から VS{version}COMNTOOLS 環境変数がなくなったりと、インクルード関連の構成が一新されてから更新が滞ってましたが、最近 vswhere の存在を知り更新することにしました。

あと同僚に突っ込まれたので README も更新して、使い方を書きました。

Include-What-You-Use-CL

Include-What-You-Use-CL is Visual Studio toolset for Include-What-You-Use

Dependency

Include-What-You-Use

Install

git clone https://github.com/srz-zumix/include-what-you-use-cl.git
cd include-what-you-use-cl
install.bat

Usage

1. Project Settings > Platform toolset
   Select "Include-What-You-Use" 
2. Compile
3. Get Include-What-You-Use result
   

Uninstall

uninstall.bat

IWYU は cpplint にも組み込まれてたりするようなので、わざわざ cl から呼ぶ必要性はない気もしますが。。

お手軽に試せるので IWYU-CL も試してみてくださいmm

今回は以上です。

では。

lizard で C++ コードメトリクス

今の会社に来てから OS が Windows とは限らない。むしろ macOS が多くなったので CCCC の代わりに lizard を使ってみました。

インストール

pip install lizard

で終わりです。

使い方

ヘルプ見たらだいたい分かると思いますが、パス指定したら解析してくれます。

-l で言語指定ができます。（e.g. -l cpp）

--xml で cppncss xml 形式で print されるのでファイルに出力したら Jenkins でも簡単に可視化できます。

--html で HTML レポート出力もできるのでさっと確認したい人はこれで見ると良いでしょう。

iutest の結果

lizard 入りの Docker image 作って GitHub Actions でレポートを取ってみました。

作成したイメージはこちらです。 https://hub.docker.com/r/srzzumix/lizard

GitHub Actions の YAML は以下のようになります。

lizard で出力した HTML レポートを成果物として保存しています。

  lizard:
    runs-on: ubuntu-18.04
    needs: prepare
    steps:
    - uses: actions/checkout@master
    - name: Lizard
      uses: docker://srzzumix/lizard
      with:
        args: -o lizard.html --html ./include
    - name: Archive code metrics results
      uses: actions/upload-artifact@v1
      with:
        name: lizard.html
        path: lizard.html

実行結果はこのようになります。

https://github.com/srz-zumix/iutest/actions?query=workflow%3A%22GitHub+Actions+-+metrics%22

成果物から HTML レポートをダウンロード可能です。

最後に

今回はメトリクスを集計するところまでをやりました。

xml を取得して閾値チェックなどできると良いかもしれません。

取得したメトリクスを利用する事例ができたら、また記事にしたいと思います。

今回は以上。では。

OpenSTF を Windows の Docker 上で動かす

CEDEC での講演もあって OpenSTF を使い始めた人も多いようなのでメモ。

CEDEC2020: AirtestとPocoとOpenSTFによるUnity製スマートフォン向けゲームの実機自動テスト環境構築とその利用方法

CEDiL: AirtestとPocoとOpenSTFによるUnity製スマートフォン向けゲームの実機自動テスト環境構築とその利用方法

講演でもお話ありましたが、 OpenSTF は DeviceFarmer に変わったそうですね。 （DeviceFarm と似てて検索とかしづらそう） 

OpenSTF のセットアップについては以下の記事が参考になります。

Androidのリモート操作/管理ツール「OpenSTF」をDocker for Windowsで使う | script life 千夜一夜 プログラミング別館

OpenSTF+Dockerで社内Android端末管理システムをMac上に構築する - Qiita

openstfの環境をdockerを使ってLinux上にゼロから構築する方法 - Qiita

筆者もネットの情報を参考に立ち上げました。

OpenSTF 便利

OpenSTF はリモート操作のためのツールの印象が強いですが、開発者がローカルで実機確認するときにも便利です。

なぜなら、わざわざ端末を操作して社内システムにログインするためのユーザーID/パスワードの入力が必要なかったり、スクリーンショットも簡単に PC 側で取れちゃうからです。

Docker の勉強がてらローカル環境に立ててみることをオススメします。

docker-compose.yml と起動手順

使っている docker-compose.yml がこちら。コメントに手順も書いてます。

メモ

Windows でボリュームマウント

Windows だとホストマシンでマウントできる場所が限られてたりして面倒くさかったので、ホストマシンに DB の永続化をするのではなく、docker volume create したボリュームに永続化するようにしてます。（今はなんか Docker Desktop がいい感じにマウントできるようにする？って聞いてくれるので面倒くささ減ったみたいだけど）

端末が認識しない場合

adb サーバーが起動してないかも。

adb start-server をしてみてください。

端末を返却した際にインストールしたアプリをアンイストールしないようにする

デフォルト設定だと、OpenSTF で端末操作して返却するとその間の変更がクリーンナップされます。これはこれで便利なのですが、個人環境で利用する場合は不便にもなります。

クリーンナップしなくない場合は stf の起動オプションに  --no-cleanup を追加しましょう。

使ってみて困っていること・知りたいこと

たまに操作できない状態になる

USBの抜き差しで復旧したりするが、リモートワークな昨今、物理的な挿抜は難しい。

adb kill-server / start-server で復旧したりもする。

リモートで電源の通電操作が可能な機材（リブーター）が存在するので、それを使って AC 給電な USB-HUB の電源切断で、USB 挿抜をエミュレートできないかと思っている。（未検証）

ポートフォワーディング機能の使い方

端末上で実行しているアプリと特定ポートでお話できるかな？と思っているのだが、うまくいってない。機能を勘違いしているのかもしれないし、使い方・設定の問題かもしれない。

最後に

利用者が増えて知見が増えていくと嬉しいですね。

Airtest も便利なんでそっちも情報増えると嬉しい。（Android 10 になって minitouch 使えなくてツラミ）

以上。

GitHub Actions のコンテナに setup-python したときの error while loading shared libraries 対応

python: error while loading shared libraries: libpython3.8.so.1.0: cannot open shared object file: No such file or directory

GitHub Actions で setup-python 使って python のテストをしていたのですが、とあるときから上記エラーが出るようになっていたので、以下の修正で対応しました。

修正前

 
zapcc-basic-test:
    runs-on: ubuntu-18.04
    container: docker://srzzumix/zapcc
    needs: prepare
    steps:
    - uses: actions/checkout@master
    - uses: actions/setup-python@v2
      with:
        python-version: 3.8
    - name: zapcc test
      run: |
        make -C test clean
        make -C test showcxxversion
        make -C test check_stdlib
        make -C test -j1 IUTEST_REQUIRE_PYTHON=1
        make -C test test

修正後

zapcc-basic-test:
    runs-on: ubuntu-18.04
    container: docker://srzzumix/zapcc
    needs: prepare
    steps:
    - uses: actions/checkout@master
    - uses: actions/setup-python@v2
      with:
        python-version: 3.8
   #### ここを追加 ####
    - name: Set Python environment variable
      run: echo "LD_LIBRARY_PATH=${{ env.pythonLocation }}/lib" >> $GITHUB_ENV
   ################
    - name: zapcc test
      run: |
        make -C test clean
        make -C test showcxxversion
        make -C test check_stdlib
        make -C test -j1 IUTEST_REQUIRE_PYTHON=1
        make -C test test

setup-python が pythonLocation 環境変数をセットしてくれるのでそれを使って LD_LIBRARY_PATH を設定します。

以上。

2020/10/6 追記

set-env コマンドは Deprecated だったので修正しました。
GitHub Actions: Deprecating set-env and add-path commands - GitHub Changelog

修正前： echo '::set-env name=LD_LIBRARY_PATH::${{ env.pythonLocation }}/lib'
修正後： echo "LD_LIBRARY_PATH=${{ env.pythonLocation }}/lib" >> $GITHUB_ENV