• SonarQubeでgoのテスト結果を集約する

    おおよそ以下のURLで説明されているとおり。
    https://docs.sonarqube.org/display/PLUG/SonarGo

    自分の環境ではsonar-scannerを使わずにgradle + sonarqube pluginを用いている。
    gradle wrapperをリポジトリに含めておけば、java以外の事前準備なしで実行できる(ネットにつながる前提で)。

    先にgo testしてカバレッジ/テスト結果をファイル出力しておき、SonarQubeに吸い上げる。

    build.gradle

    plugins {
        id "org.sonarqube" version "2.6.2"
    }
    
    sonarqube {
        properties {
            property "sonar.projectName", "PROJECT-NAME"
            property "sonar.projectVersion", "1.0.0"
    
            property "sonar.go.coverage.reportPaths", "reports/coverage.out"
            property "sonar.go.tests.reportPaths", "reports/test.json"
    
            property "sonar.sources", "."
            // Exclude code generated by stringer.
            property "sonar.exclusions", "**/*_test.go,**/*_string.go,**/vendor/**"
            property "sonar.tests", "."
            property "sonar.test.inclusions", "**/*_test.go"
            property "sonar.test.exclusions", "**/vendor/**"
        }
    }

    SonarQubeがgradleタスクを実行するlinuxと同じ環境(http://localhost:9000)で動いている前提。 stringer生成コードを無視する想定でsonar.exclusionsに「*_string.go」指定している。

    Makefile(抜粋)

    test:
    	go test -coverprofile=reports/coverage.out -json > reports/test.json
    

    カバレッジ/テスト結果の出力形式は以下のページを参照。
    https://docs.sonarqube.org/display/PLUG/Go+Coverage+Results+Import
    https://docs.sonarqube.org/display/PLUG/Unit+Tests+Results+Import

    テストとsonarqubeタスク実行

    $ make test
    $ ./gradlew sonar

    ルートパッケージにテストコードがあると以下のエラーが出て上手く拾ってくれない。デフォルトGOPATHの場合でも環境変数GOPATH=~/goを明示設定しておくと拾ってくれる。

    Failed to find test file for package github.com/tckz/go-split and test TestDecorateReaderNoCompression

    ディレクトリ階層(抜粋)

      ~/go <-- $GOPATH
          src/
            github.com/
              tckz/
                go-split/
                  Makefile
                  build.gradle
                  gradlew 
                  gradle/
                    wrapper/ <-- Gradle wrapper実体
                      ...省略
                  split_test.go <-- 非mainパッケージ
    

    環境

    • CentOS 7.5 x64
      • go 1.11.1
      • openjdk version 1.8.0_181
        • SonarQube Community Edition 7.3.0.15553
          • SonarGo 1.1.0 (build 1612)
      • GNU Make 3.82
  • gitoliteでhook

    入門Git

    素のgitと自作のhookスクリプトを用いて、リポジトリにpushがあったら 「jenkinsのジョブ起動、redmineのRepository.fetch_changesetsを実行・・・」ということをやっていた。

    特定ブランチへのnon fast-forwardなpush禁止をやりたくて、自作することも考えたのだけどgitoliteがやりたいことを網羅していたので移行した。
    http://gitolite.com/gitolite/index.html

    hook設定

    • gitoliteの管理ユーザ(sshユーザ)の~/.gitolite.rcを変更してhookを使えるようにする

      • LOCAL_CODEの部分にコメントで注意書きがあるのでよく読んだうえで。
      %RC = (
      (略)
          # コメント外す
          LOCAL_CODE                =>  "$rc{GL_ADMIN_BASE}/local",
      (略)
      ENABLE => [
      (略)
          # コメント外す
          'repo-specific-hooks',
      (略)
      ]
      
    • gitoliteの管理リポジトリをcheckoutした構造

      gitolite-admin/
        conf/
          gitolite.conf
        keydir/
          user.pub ...
        local/
          hooks/
            repo-specific/
              myhookname.post-receive*
      
    • gitolite.confに起動するhookと条件を設定 * 使っているhookはpost-receiveフック

      repo path/to/repo
        option hook.post-receive = myhookname.post-receive
        RW      =   @dev
      
    • 管理リポジトリにconfとhookスクリプトををpushすると配置されるはず。

      $HOME/.gitolite/
        local/
          hooks/
            repo-specific/
             myhookname.post-receive*
      

    umask

    読取り専用アクセス用にgit-daemonによるリポジトリ公開も行っている。 git-daemonユーザがgitoliteのユーザとは異なるため、gitoliteユーザのhome下の一部についてgroupに対するrxを付与している。

    gitoliteのデフォルトはumask 0077動作なので、この状態のままリポジトリを書き換えるとgit-daemonから見えないdir/fileが出来てしまう。~/.gitolite.rcのUMASK設定を変更して027にした。

    git-daemon経由でfetchすると一部のコミットやブランチが見えなくなってハマった。

    %RC = (
    (略)
                # groupの読み取り可能に
                UMASK                           =>  0027,
    

    環境

    • CentOS 5.11 x64
      • git 1.7.4.1
      • gitolite v3.6.3-10-g4be7ac5
  • redmineのwikiでTOC(目次)の位置を固定する

    経緯

    redmineのwikiで、ページ内のh1.h2.等見出しをまとめたページ内リンクを作ってくれる{{toc}}マクロがある。
    ※大体、右肩に表示したいことが多く{{>toc}}を用いている

    しかし、長いページをスクロールさせると目次がスクロールアウトして見えなくなり、ページ内リンクをクリックできなくて不便だと思っていた。 例えば何かの手順を流れに沿って並べてあるような場合に説明(セクション)を行ったり来たりしたい。
    見出しでセクション分けしていた内容を独立した別ページにするなどしてみたものの、数が多いと面倒だしリンク集部分を自前でメンテするのも大変。

    ということで、tocマクロによる目次をページがスクロールしても画面内に留めるredmine_wiki_fix_tocプラグイン。 https://github.com/tckz/redmine_wiki_fix_toc

    Feature

    • ページ内に右寄せのTOC{{>toc}}がある場合に、同TOCが元々表示されていた位置よりも下にスクロールしたとき、表示位置を固定(position: fixed)する。
      • 左寄せのTOCを画面内にfixすると文章にかぶってしまうので右寄せ限定
    スクロール前
    ↓↓↓ スクロールさせる ↓↓↓
    スクロール後

    補足

    • すべてのページにプラグイン独自のhtmlを差し込むためにview_layouts_base_body_bottomフックを用いる

      class ViewListener < Redmine::Hook::ViewListener
        def view_layouts_base_body_bottom(context)
          context[:controller].send(:render_to_string,
            :template => 'wiki_fix_toc/body_bottom',
            :layout => false,
            :locals => {:context => context})
        end
      end
      
    • 後はplugins/redmine_wiki_fix_toc/app/views/wiki_fix_toc/body_bottom.html.erbでTOCを見つけてイベントを貼り付けるコードを書く。

    環境

    • CentOS 7.1 x64
      • ruby 2.2.0p0 x64
        • redmine 3.1.1
    • Windows 10 Enterprise x64
      • Firefox Developer Edition 43.0a2 x64
  • HugoでLiveReloadされない

    • 出力されたhtmlに</body>がないと、jsコードが差し込まれずLiveReloadされない。

    MTからJekyllを介してHugoに移行」に書いたように、 編集中serverにファイル更新をwatchさせるLiveReloadが便利。

    hugo server --watch --port=3000
    

    </body>の前に以下のようなjsコードが差し込まれ、hugo server側の再生成に連動して開いているページがreloadされる。

    <script data-no-instant>document.write('<script src="http://'
            + (location.host || 'localhost').split(':')[0]
            + ':3000/livereload.js?mindelay=10"></'
            + 'script>')</script>
    

    </body>がないと、jsコードが差し込まれずLiveReloadも行われない。

    利用したテンプレートが先進的でhtml/head/bodyタグがなかったことから、LiveReloadが有効にならず悩んだ。

    環境

    • CentOS 6.6 x64
      • hugo v0.15-DEV
      • ruby 2.2.0p0 x64
        • jekyll-import 0.7.1
  • MTからJekyllを介してHugoに移行

    Googleウェブマスターツールから、サイトのモバイルユーザビリティに問題あるぞという通知が来ていて、デザインを変えたいなーと思っていた。

    • イチから作るのは面倒、モバイルデバイスにも対応している既存デザインを使いたい。
    • サイトは静的ファイル公開で完結したい。
    • MTのテンプレートにちょうどいいのが見つからない(かつ「再構築」待ちがなんだかおっくうになってた)
    • Octopressのテーマにいいのがある
      3rd Party Octopress Themes
    • OctopressはコアがJekyllらしい。
    • Movable TypeからJekyllへのimporterがある

    といことでまずはJekyllに移行。

    Movable Type » Octopress/Jekyll

    やはり移行ツールがあると、ちょっと試してみるかという気になる。
    以下のページを参考にMTのDB(MySQL)接続設定を書いて実行するだけで簡単に MTの記事をjekyll形式のファイルにエクスポートできた。
    http://import.jekyllrb.com/docs/mt/

    テーマを適用しようとしてちょいちょいいじり始めたけどなんだか生成が遅い。 ちょっと修正して確認するのに、130エントリでwatch状態からの生成時間が18secほどかかるのはなかなかつらい。

    Jekyll » Hugo

    調べてみるとHugoというのが速くてよいらしい。

    記事ソースファイルに完全な互換はないけどちょいスクリプト加工でなんとかなりそう。 レスポンシブ対応してるテーマもあるし。
    https://github.com/spf13/hugoThemes/

    記事ソースファイル

    • Jekyll-importでインポートした状態。

      ---
      layout: post
      title: GAEアプリケーションを HRDに移行
      date: '2012-10-14 15:37:05 +0900'
      mt_id: 131
      blog_id: 2
      post_id: 131
      basename: gae_hrd
      categories:
      - gae
      ---
      (本文)
      
    • awkを使って日付の書式と、slug部分を加工。
      *_idは不要だけどなんとなく残した。
      typeはなくてもいい感じがしたけど、テーマの方で生成条件付けに使えるので適当に設定

      ---
      title: GAEアプリケーションを HRDに移行
      date: '2012-10-14T15:37:05+09:00'
      mt_id: 131
      blog_id: 2
      post_id: 131
      categories:
      - gae
      slug: gae-hrd
      type: post
      ---
      (本文)
      

    ディレクトリ構成(抜粋)

    • 元々のURLを変更しない前提で
      • uglyurlsをtrueに
      • publishdirをpublicから一段掘り下げ(MTのときは記事のpathが/mt/archives/YYYY/MM/xxxx.htmlという感じだった)
    • content/下については年単位ぐらいでディレクトリわけたい+年月日でソートできるようにしたいのでこんな感じに。実際の出力先pathはfront matterのslugとconfig.ymlで調整
    config.yml
    content/
      archives/
        2012/
          2012-10-14-gae-hrd.html
          ...
    public/
      index.html <- 手書き
      mt/ <- ここから下がhugoでの生成
        index.html
        archives/
          2012/
            10/
              gae-hrd.html
    static/
      css/
        custom.css <- テーマのcss上書き分
    themes/
      テーマ/
    

    config.yml(抜粋)

    ---
    baseurl: "http://passing.breeze.cc/mt/"
    publishdir: "public/mt/"
    languageCode: "ja"
    title: "あぁ そうだった"
    canonifyurls: true
    builddrafts: false
    uglyurls: true
    pluralizeListTitles: false
    permalinks:
      archives: /archives/:year/:month/:slug.html
      verbose: true
      theme: "beg-modified"
      MetadataFormat: "yaml"
    

    生成

    • あとはディレクトリ構成のトップでhugoコマンドを叩くだけ。生成時間0.5secほど。速い。

    感想など

    • 速い。
    • 編集中LiveReloadがすごく便利。ファイル更新を検知して再生成、ブラウザで生成ページを開いていれば再生成に連動してreloadされる。
      http://gohugo.io/extras/livereload/

      • hugoを仮想マシンlinux内で動かしつつ手元のWindowsからterminalでloginしてviで編集、手元のWindows機でブラウザ実行しているので下記のようなコマンドラインを使っている。

        hugo server -w --baseUrl=http://local-env.local:3000/mt/ --bind=0.0.0.0 --port=3000
        
    • 移行を始めたときはv0.14だったのだけど、テンプレートプロパティのdeprecate予告がありテンプレート修正した。これからも変化しそう。

      • .Site.BaseUrl -> .Site.BaseURL
      • .Site.Recent -> .Site.Pages
      • .Url -> .URL

    環境

    • CentOS 6.6 x64
      • hugo v0.15-DEV
      • ruby 2.2.0p0 x64
        • jekyll-import 0.7.1