Circle CI 入門 - Speaker Deck

Circle CI 入門

by yutachaos

Slide 1

Slide 1 text

Circle CI 入門 1

Slide 2

Slide 2 text

自己紹介木村勇太サーバーサイドエンジニアプログラミング言語 PHP, node, java , Ruby 主にAWS を使ったシステム構築してます。実装、開発、インフラ構築とかわりかし何でも屋。 2

Slide 3

Slide 3 text

近況 AWS Certified Solutions Architect, AWS Certified DevOps Engineer Professional 取りました。 Qiita 記事に書いてます。 https://qiita.com/yutaChaos/items/2b0b8d9bfe76a597953c https://qiita.com/yutaChaos/items/081ac5b067856206a2a3 3

Slide 4

Slide 4 text

Agenda CI( 継続的インテグレーション) とは? Circle CI の紹介サンプルコードの解説他のCI ツールの紹介 CI 構築する時に私が考えること 4

Slide 5

Slide 5 text

CI is 何? 5

Slide 6

Slide 6 text

継続的インテグレーション、CI（英: continuous integration）とは、主にプログラマーのアプリケーション作成時の品質改善や納期の短縮のための習慣のことである。エクストリーム・プログラミング (XP) のプラクティスの一つで、狭義にはビルドやテスト、インスペクションなどを継続的に実行していくことを意味する (by wikipedia 先生) 6

Slide 7

Slide 7 text

CI はエクストリーム・プログラミングのプラクティスの一つ。 7

Slide 8

Slide 8 text

エクストリーム・プログラミング is 何? 8

Slide 9

Slide 9 text

エクストリーム・プログラミング、XP（英: extreme programming）は、ケント・ベックらによって定式化され、提唱されているソフトウェア開発手法である。柔軟性の高い開発手法であるため、難易度の高い開発やビジネス上の要求が刻々と変わるような状況に向いた開発手法である。事前計画よりも柔軟性を重視する。1999 年に書籍『XP エクストリーム・プログラミング入門― ソフトウェア開発の究極の手法』によって発表された。XP は、軽量開発手法あるいはアジャイルソフトウェア開発手法と呼ばれる、同種の開発手法のなかで代表的なものである。 (by wikipedia 先生) 9

Slide 10

Slide 10 text

具体的にはCI は開発のプラクティスに含まれている 10

Slide 11

Slide 11 text

テスト駆動開発テストコードを書きつつ、機能の実装を行い、常にコードに対してテストコードによる自動テストを行うように開発する手法ペア・プログラミング Observer( 指示する人),Driver( プログラミングを実際に書く人) の二人組になってプログラミングを行う手法 11

Slide 12

Slide 12 text

リファクタリング書いたコードの内容を修正・改善を行うこと集団的な所有権 git やsvn などのVCS( バージョン管理システム) を使い、誰でも同じコードを編集出来るようにする CI( 継続的インテグレーション) ← これ！作成したテスト、ソースのビルドやデプロイ、自動で実行される環境を作る YAGNI(You ain't gonna need it) 機能は必要になるまで実装しない 12

Slide 13

Slide 13 text

エクストリーム・プログラミングでは出来るだけ小さい単位で開発を行い、細かい単位でのフィードバックをするように提唱されています。テストコードを作成しつつ開発する場合、テスト実行を毎回ローカルで行うのは大変。自動化することによって実行コストを下げて、より早くフィードバックを行おう！というのがCI です。( ざっくり) 13

Slide 14

Slide 14 text

Circle CI について 14

Slide 15

Slide 15 text

CI を行う環境を提供してくれるSaaS。同種で最近流行りなものに T r a v i s C I , W e r c k e r とか色々あります。すごいたくさんあるので多くは語りません。 15

Slide 16

Slide 16 text

何が出来るの? 16

Slide 17

Slide 17 text

A. 基本的になんでも出来ます。 17

Slide 18

Slide 18 text

Circle CI が提供してくれること公式からのコピペ& 翻訳(https://circleci.com/product/) 18

Slide 19

Slide 19 text

VCS との連携 CircleCI は、GitHub、GitHub Enterprise、およびBitbucket と統合されています。コードをコミットするたびにCircleCI はビルドを作成します自動テスト CircleCI は、コンテナまたは仮想マシンでビルドを自動的にテストします。 19

Slide 20

Slide 20 text

通知ビルドに失敗した場合にチームに通知されるので、問題を迅速に解決できます。自動デプロイ成功したビルドはさまざまな環境にデプロイされ、あなたのプロダクトはより早く市場に投入されます。 20

Slide 21

Slide 21 text

料金 1 コンテナ一月につき1500 分まで無料。コンテナを追加する場合は50 ドル/ 月 21

Slide 22

Slide 22 text

ユースケーステストの実行、アプリケーションのデプロイ、アプリのビルド etc・・・ 22

Slide 23

Slide 23 text

サンプルコード公式のyml ファイルを少しいじってruby で書きました。 https://github.com/yutachaos/circleci‑initial 23

Slide 24

Slide 24 text

使い方 GitHub、Bitbucket で管理されたrepository を用意します。 circleCI の設定ファイルを用意します。( 後述) CircleCI とVCS を連携します。 git にpush します Circle CI が動いてテストが動きます。以上 24

Slide 25

Slide 25 text

yml ファイルの解説 version Circle CI のversion 1 と2 がある。1 は2018 年8 月に終了することがアナウンスされているので、基本的にいまから使うには2 が推奨 jobs job を定義する箇所の上位定義 docker 実行環境をdocker で行う場合の定義部分 image コンテナの実行イメージを指定する Docker hub,private repository, ECR,circleCI の公式イメージなど使用出来る circleci/ruby:2.4‑node 25

Slide 26

Slide 26 text

environment 該当のjob の中で利用出来る環境変数を記載する。 steps job の中で実行されるコマンドを記載していく。 run 実行するコマンドを記載していく name 実行するコマンドの説明、CircleCI の画面に表示される。必須項目ではないが設定してあったほうが見やすい command 実行するコマンド、sh のファイルなどを設定することが出来る。 26

Slide 27

Slide 27 text

save_cache CircleCI はjob にデータをキャッシュすることが出来る指定したkey ででbundle やnode_modules などの依存するライブラリをキャッシュすることで次回build 時に採用することが可能 restore_cache save_cache で保存したキャッシュを読み込み直して、再利用することが出来る。 store_test_results テストの実行結果(JUnit XML or Cucumber JSON) をここで指定したpath の下に置くことでCircleCI のUI からtest の実行結果を確認すること出来る。 workflow workflow に記載する、job の並行実行や、実行する条件を設定することが出来る。 27

Slide 28

Slide 28 text

他のCI ツールの紹介最近はSaas でも、自前で入れて使う形でもたくさんのCI ツールがあります。たくさんあるので少しでも触ったものだけを書きます (><) Jenkins Jenkins おじさん。通常自前のサーバーにいれて使うことが多い。老舗だが、実績と使用率はNo1 といえる。Jenkins2 から出来るようになったpipeline が結構便利最近はSaas 版もある。 CircleCI やDocker もCI はJenkins で回されている。 TravisCI 最近のイケイケな会社はCircleCI かTravisCI というイメージ。 private で使うためには有料プランが必要。public で使う場合は無料でOSS での使用例が多いのでサンプルを探しやすくもある。 28

Slide 29

Slide 29 text

GitLabCI gitlab に連携出来るCI ツール。gitlab 本体とは別にserver を容易し、runner として実行出来る。 Bitrise iOS 向けのCI ツール。同僚エンジニアいわく結構使いやすい。無料枠がやや貧弱だが、50 ドルからの有料枠なので、頻繁にビルドするのであれば便利。 Concourse Go 製のCI ツール、最近流行っている。Saas ではなく自前で環境を容易する。Container 環境での実行、pipeline ベースの構築が出来るので大規模な処理を纏めるのに適している印象。 29

Slide 30

Slide 30 text

CI ツールは結構なんでも出来る。だからどのくらいではじめるかが重要 30

Slide 31

Slide 31 text

CI 構築する時に私が考えること 31

Slide 32

Slide 32 text

目的・どういうことをやるかを考える例コードに統一感をもたせたい lint を行うコードの不具合を素早く検出したい単体テストを行う要件にあったもの他との依存性を調べたい結合テストを行うライブラリを常に最新にするのがめんどい日時でbundle のupdate を行う CI 回すのかっこいいから、やりたい! この理由もありだけど、何やるかはちゃんと決めよう 32

Slide 33

Slide 33 text

どのツールを使うのか考えるチームで使っているバージョン管理システムを調べる git github gitlab gitbucket codeCommit etc・・・ svn cvn 33

Slide 34

Slide 34 text

Saas のCI を考慮する場合、使っているツールによって連携のしやすさが異なる github 使ってる、gitlab 使っているでも設定する所が異なる。 (github ならすぐ連携出来るよ！) CircleCI の場合( というか一般的なSaas の場合) 一度インターネット経由で接続するため、private なネットワーク限定でしかセキュリティポリシーが定められている場合、基本的に導入が困難。自前で入れられるツール(Jenkins など) を利用した場合が良い時もある。 34

Slide 35

Slide 35 text

粒度を考える CI を動かす粒度を考える push ごとに動かす PR 毎に動かす master にpush されたときに動かすなど時間での定期実行する(cron 的設定も出来ます) 35

Slide 36

Slide 36 text

CI を設定するコストメリットを考える単体テストや結合テストを常に実行する設定は有用であるが、設定するコストが多い。まずはlint だけを設定するところから始めるのも１つの考え方となる効果と設定へのコストは得てして反比例しがち CI は設定したけど、テストをメンテするのが大変になった・・・ CI 自体が一人にしか設定出来なくて動かなくなった時につらい。インフラの設定とかが属人化しやすい(Jenkins おじさん管理おじさんの誕生) 36

Slide 37

Slide 37 text

まとめ Docker でやるから環境依存解決楽、Docker かわいいよ、Docker Saas だから、インフラ維持コスト少ない。 CI 回すと便利だけど、一気にやると大変だから、少しずつやろう。 37