Share
Embed
Transcript
42 slides
-
Command-line interface tool design খࢁ݈Ұ / GMO PEPABO inc. 2024.3.8
PHPerKaigi 2024 1 -
ࣗݾհ ٕज़෦ɹٕज़ج൫νʔϜ 2018 த్ೖࣾ খࢁ ݈Ұ Ken’ichiro Oyama গ࣮͠༻తͰখ͞ͳOSSΛॻ͘ͷ͕झຯɻ •
GitHub : k1LoW • Twitter : @k1LoW 2 -
4 ࠷ۙྗΛೖΕ͍ͯΔOSSͷհ runnʢϥϯΤψʣ • runn ( means "Run N". is
pronounced /rʌ́n én/. ) is a package/tool for running operations following a scenario. • https://github.com/k1LoW/runn • γφϦΦΛYAMLͰॻ͍ͯͦΕΛͱʹૢ࡞ʢΦϖϨʔγϣϯʣΛࣗಈԽͰ͖Δύο έʔδ/πʔϧ • ओʹAPIςεςΟϯάπʔϧͱͯ͠࠾༻͞Ε͍ͯΔ • νϡʔτϦΞϧΫοΫϒοΫ͋Δ -
ΞδΣϯμ • Command-line interface • Command-line interface tool design •
ίϚϯυମܥͷσβΠϯ • έʔεελσΟ • πʔϧͱͯ͠ͷ࣮ͷσβΠϯ • έʔεελσΟ • ͓ΘΓʹ 5 -
7 Command-line interface Command-line interfaceͱ • Ϣʔβ͕จࣈྻʢίϚϯυʣΛೖྗͯ͠ϓϩάϥϜʹ໋ྩ͢ΔϢʔβΠϯλʔϑΣʔε • Α͘ରͱͳΔͷ͕GUIʢGraphical user
interfaceʣ • ༨ஊ: ʮCUIʢCharacter user interfaceʣʯΛ͏ͷຊޠͰͷ༻͕ओྲྀΒ͍͠ʢWikipediaௐʣ -
8 Command-line interface ίϚϯυϥΠϯΠϯλϓϦλ • Ϣʔβ͔Βೖྗ͞ΕΔจࣈྻͷߦͷίϚϯυΛղऍ͠ɺOSϓϩάϥϛϯάݴޠॲཧܥͳͲʹ ͢ͷ • ίϚϯυϥΠϯΠϯλϓϦλ࣍ͷ4ͭΛॱʹߦ͏ʢREPLʣɻ 1.
ೖྗͷಡΈऔΓ…Read 2. ೖྗจࣈʢίϚϯυʣΛ࣮ߦʢධՁʣ...Eval 3. ࣮ߦ݁ՌΛදࣔ…Print 4. ೖྗͷಡΈऔΓʹΔ…Loop • BashBourne Shellͱ͍ͬͨUNIXγΣϧRubyͷirbɺPHPͷ`php -a`ͳͲ -
9 Command-line interface CLIπʔϧʢCommand-line interface toolʣ • ຊൃදͰίϚϯυΛೖྗ͢Δ͜ͱͰUNIXγΣϧ͔Β࣮ߦ͞ΕΔϓϩάϥϜΛCLIπʔϧͱݺͿ • lsͳͲɻcomposerͦ͏ɻ
• ʢ࣮cdpwdshell built-in commandͳͷͰҧ͏͜ͱͳΔʣ • ίϚϯυϥΠϯΠϯλϓϦλΛ௨࣮ͯ͡ߦ͞Εग़ྗΛฦ͢ϓϩάϥϜ = CLIπʔϧ • CLIπʔϧ࣮ߦ࣌ʹ Ҿʢargsʣ ϑϥάʢflagsʣɺඪ४ೖྗʢSTDINʣͳͲΛೖྗͱͯ͠ ड͚औΔʢਖ਼֬ʹҾͱϑϥάͷ۠ผCLIπʔϧͰߦ͏ʣ • CLIπʔϧʮCommand-line interfaceΛ࣋ͭπʔϧʯ -
11 Command-line interface tool design CLIπʔϧͷσβΠϯ 2ͭͷଆ໘͔ΒͷCommand-line interface tool design
1. ίϚϯυମܥͷσβΠϯ … interface design • ͲͷΑ͏ͳίϚϯυମܥΛϢʔβʹఏڙ͢Δͷ͔ 2. πʔϧͱͯ͠ͷ࣮ͷσβΠϯ … tool design • ͲͷΑ͏ͳΞʔΩςΫνϟʹ͢Δͷ͔ -
13 ίϚϯυମܥͷσβΠϯ CLIπʔϧ͕࣋ͭϢʔβΠϯλʔϑΣʔεʹٻΊΒΕΔ͜ͱ • WebΞϓϦέʔγϣϯͱରൺͯ͠ΈΔͱɺWebΞϓϦέʔγϣϯʹ͓͚ΔϢʔβΠϯλʔϑΣʔε େ͖͘2ͭ 1. ϒϥβʢ͔ΒݟΔHTMLϖʔδʣ 2. Web
API • GUIͱϒϥβɺCLIͱWebAPI͕ରൺ͞ΕΔΑ͏ʹΈ͑Δ͕ͦ͏Ͱͳ͍ 1. ϒϥβ = ਓΛϢʔβͱͨ͠ϢʔεέʔεʢͱϢʔβΠϯλʔϑΣʔεʣ 2. Web API = ػցΛϢʔβͱͨ͠ϢʔεέʔεʢͱϢʔβΠϯλʔϑΣʔεʣ • CLIπʔϧWebΞϓϦέʔγϣϯͱಉ༷ʹਓͱػցͷ2ͭͷϢʔεέʔε͕͋Γɺ 1ͭͷϢʔβΠϯλʔϑΣʔεͰ2ͭͷϢʔεέʔεΛಉ࣌ʹຬͨ͢ඞཁ͕͋Δ -
17 ίϚϯυମܥͷσβΠϯ ʮ1ͭͷCLIπʔϧʯͱ͍͏ϨΠϠʔ • ίϚϯυೖྗͱ͍͏୯७ͳΠϯλʔϑΣΠεʹ࣮ଟ͘ͷػೳΛؚΊΔ͜ͱ͕Ͱ͖Δ • αϒίϚϯυ • ྫ͑ɺaws-cliͱ͍͏CLIπʔϧ୯ҰͷϢʔβΠϯλʔϑΣʔεͰ༷ʑͳAWSϦιʔεͷૢ࡞ ͕Ͱ͖Δ
• ϒϥβ্ʢAWS Management Console্ʣͰෳͷϖʔδΛߦ͖དྷ͢Δඞཁ͕͋Δ • ͜Ε͚ͩͰेϝϦοτʹͳΔ • ҰํͰଟ͘ͷػೳΛ1ͭͷCLIπʔϧͰૢ࡞͢Δඞཁ͕͋Δ • େલఏͱͯ͠CLIπʔϧͷதͰ౷Ұ͞ΕͨίϚϯυମܥͰ͋Δ͜ͱ͕ٻΊΒΕΔ -
18 ίϚϯυମܥͷσβΠϯ ʮUNIXγΣϧ্ʯͱ͍͏ϨΠϠʔ • UNIXγΣϧ্ͷCLIπʔϧ࣮ߦํ๏ͱೖग़ྗ͕౷Ұ͞Ε͍ͯΔ • fork, execve • STDIN,
STDOUT, STDOUTʢExit code, args, flagsʣ • ύΠϓͱ͍͏ίϚϯυΛΈ߹ΘͤΔͨΊͷڧྗͳػೳ • UNIXγΣϧ্ͰධՁ͞ΕΔϓϩάϥϜʢ·ͨผͷϓϩάϥϜʹΑͬͯධՁ͞ΕΔϓϩάϥ Ϝʣඃ࣮ߦ࣮ߦ͜ͷ୯ҰͷΠϯλʔϑΣʔεʹରԠ͢Εྑ͍ • ݁Ռͱͯ͠࿈ܞࣗಈԽ͕༰қʹͳΔɻͭ·ΓΈ߹ΘͤΔ͜ͱ͕͋Δ • Έ߹ΘͤΛߟྀͨ͠ίϚϯυମܥͰ͋Ε͋Δ΄Ͳ͍͍͢ -
19 ίϚϯυମܥͷσβΠϯ UNIXֶ • ʢ͋ΔʣUNIXֶʢͷ͏ͪͷ1ͭʣ͔ΒCLIπʔϧͷσβΠϯʹؔ͢ΔՕॴΛڧௐ • μάϥεɾϚΩϧϩΠଞόʔδϣϯʢ1978 Bell System Technical
Journalʣ 1. ͦΕͧΕͷϓϩάϥϜ͕1ͭͷ͜ͱΛ͏·͘͜ͳ͢Α͏ʹɻ৽͍͠ࣄΛ͢ΔͨΊʹɺ৽͍͠ʮػೳʯ ΛՃͯ͠ݹ͍ϓϩάϥϜΛෳࡶʹ͢ΔͷͰͳ͘ɺ৽͍͠ϓϩάϥϜΛߏங͢Δɻ 2. ͯ͢ͷϓϩάϥϜͷग़ྗ͕ɺ·ͩݟ͵ผͷϓϩάϥϜͷೖྗʹͳΔ͜ͱɻग़ྗʹ༨ܭͳใΛೖΕͳ ͍Α͏ʹɻݫີʹྻڍ͞ΕͨೖྗܗࣜόΠφϦܗࣜආ͚ΔɻΠϯλϥΫςΟϒͳೖྗʹͩ͜ΘΒͳ ͍ 3. ιϑτΣΞͪΖΜOSͰ͋ͬͯɺૣظʹɺཧͱͯ͠िؒҎʹࢼͤΔΑ͏ઃܭɾߏங͢Δɻෆث༻ͳ෦᪳ͳࣺͯͯ͘࡞Γ ͢Α͏ʹ 4. ճΓಓΛͯ͠ɺ͍ऴΘͬͨޙʹࣺͯΔ͜ͱʹͳͬͯɺϓϩάϥϛϯάͷ࡞ۀΛܰݮ͢ΔͨΊʹɺ͓ख͍͞ΜͰͳ͘πʔϧΛ͏ https://ja.wikipedia.org/wiki/UNIXֶ ΑΓҾ༻ -
21 ίϚϯυମܥͷσβΠϯ ʮೖྗ͍͢͠ʯͱ • ૾͍͢͠ɻ͍֮͑͢ • ౷Ұ͞ΕͨϑϥάαϒίϚϯυͷମܥ • ϑϥάαϒίϚϯυ໊ࢺͳͷ͔ಈࢺͳͷ͔ɺओޠԿͳͷ͔ •
ଞͷΑ͘ΒΕͨCLIπʔϧͱಉ͡Α͏ͳίϚϯυମܥ • ʮৄࡉग़ྗ `-v (--verbose)` ʯͳͲ • ίϚϯυΈ߹ΘͤΔ͜ͱ͕ఆ͞ΕΔͨΊʮࣗͷίϚϯυମܥʯ͚ͩΛߟ͍͍͑ͯͯ ʹ͘͘ͳΔ • ೖྗ͢Δจࣈ͕୯७ʹগͳ͍ • ֮͑Εͯ͠·࣮͑ߦͰ͖Δɻͦ͏͢Δͱසൟʹ࣮ߦ͢ΔίϚϯυͷλΠϓগͳ͍ํ͕ྑ͍ ʢγϣʔτΧοτͱಉ͡ʣ • γϣʔτϑϥάͷఏڙ -
22 ίϚϯυମܥͷσβΠϯ ʮཧղ͍͢͠ʯͱ • ࣮ߦ݁Ռ͕Θ͔Γ͍͢ • ࣮ߦ݁Ռͷग़ྗ͕ɺಡΜͰҙຯΛཧղͰ͖Δ • ࣮ߦ݁Ռͷग़ྗ͕ɺಡ·ͳͯ͘ݟͨͰཧղͰ͖Δ •
৭ʢޭͳΒɺࣦഊͳΒʣ • ࣮ߦ͢ΔίϚϯυ͕ԿΛ࣮ߦ͢Δͷ͔͕Θ͔Γ͍͢ • ಡΜͰҙຯ͕Θ͔ΔίϚϯυମܥɻϩϯάϑϥάͷఏڙ -
23 ίϚϯυମܥͷσβΠϯ ػցΛϢʔβͱͨ͠Ϣʔεέʔε • ίϚϯυͱͯ͠ొͰ͖Ε͍͍ɻͲΜͳίϚϯυମܥͰҰొͯ͠͠·͑ͳΜͰOK • CRONConsul health checksͳͲ •
Ұొͯ͠͠·͑OKͳͷ͔ͩΒΉ͠Ζೖྗ͠ʹ͘͘ͱՄಡੑͷߴ͍ίϚϯυ͕هड़Ͱ ͖Δํ͕ྑ͍ • ొͨ͠ίϚϯυɺޙͰݟͯͦͷҙຯΘ͔Γ·͔͢ʁ͍֮͑ͯ·͔͢ʁ • ػցʹΘ͔Γ͍࣮͢ߦ݁Ռ • ऴྃεςʔλεʢExit codeʣ • STDOUTɺSTDERRͷ͍͚ -
26 έʔεελσΟ ʮௐࠪ࣌ʹҰ࣌తʹ༻͢ΔίϚϯυͳͷͰ֮͑ΒΕͳ͍ʯ • ࣮ߦ͢ΔͱόοΫάϥϯυϓϩηε্ཱ͕͕ͪΓࢦఆظ͚ؒͩαʔόͷϝτϦΫεΛࢹ͠ɺ ࣄલʹઃఆͨ݅͠ʹୡͨ࣌͠ʹҙͷίϚϯυͷ࣮ߦSlack௨Λߦ͏CLIπʔϧ • ʮࠓCPUར༻͕80%Λ͑ͨ࣌ʹtopίϚϯυͷ݁ՌΛͱΓ͍ͨʯͳͲ • ෳࡶͳ݅ઃఆ͕Ͱ͖Δ͕ɺௐࠪ࣌ʹҰ࣌తʹ༻͢ΔίϚϯυͳͷͰͦͦίϚϯυࣗମ֮
͑ΒΕͳ͍ • sheer-heart-attack launch ͚ͩΛ֮͑ͯΒ͍ɺΠϯλϥΫςΟϒϞʔυʹͨ͠ • ೖྗྃޙʹ sheer-heart-attack launch ͷϓϩηε͔Βೖྗͨ͠Λflagsʹมͨ͠͏͑Ͱ sheer-heart-attack task ʢϝΠϯͷࢹίϚϯυʣΛόοΫάϥϯυ࣮ߦ sheer-heart-attack https://github.com/k1LoW/sheer-heart-attack -
28 έʔεελσΟ ʮͨͩͨͩϩάʹ৭͚Λ͍ͨ͠ʯ • ϩάͷ͏ͪಛఆͷΩʔϫʔυ͚ͩ৭͚Λ͢Δπʔϧ • ʮ৭Λ͚͍ͭͨʯͷతཱ͍ͨͤͨ • ͦΕ͚ͩɻ৭Λࢦఆ͍ͨ͠Θ͚Ͱͳ͍ •
ཱ͍ͨͤͨͱߟ͍͑ͯΔͷਓɺػցͰͳ͍ • tail -F /var/log/nginx/access.log | colr POST GET 404 500 search • argsʹΩʔϫʔυΛฒͯΒ͏͚ͩͷίϚϯυମܥʹͨ͠ • ϩάͳͲͷೖྗඪ४ೖྗܦ༝ʹݶఆ͢Δ͜ͱͰίϚϯυମܥΛγϯϓϧʹ • ৭ͷࢦఆػೳͳ͠ colr https://github.com/k1LoW/colr -
29 έʔεελσΟ ʮجຊCIʹΈࠐΉ͜ͱ͕ϝΠϯɻ͔͠͠ϩʔΧϧͰผͷϢʔεέʔε͕͋Δʯ • CI্ͰίʔυΧόϨοδ͚ͩͰͳ͘CIʢGitHub ActionsʣͷAPIΛୟ͍ͯςετ࣮ߦ࣌ؒͷܭଌ ΧόϨοδϨϙʔτͷૹ৴ͳͲΛߦ͏πʔϧ • CI্ͷڥมͱઃఆϑΝΠϧͰڍಈΛܾఆ͢Δ •
ҰํͰʮίʔυΧόϨοδΛ֬ೝ͍ͨ͠ʯϩʔΧϧ্ͷϢʔεέʔεͰ͋Δɻ • ಉ͡ octocov ίϚϯυͰɺڥมʹΑͬͯڍಈΛมߋ͢ΔΑ͏ʹ͠ɺCI্ͰͷॲཧΛޡͬ ࣮ͯߦ͠ͳ͍Α͏ʹ͍ͯ͠Δɻ • ػցͷϢʔεέʔεΛϝΠϯͱͭͭ͠ਓͷϢʔεέʔεͷ߹Λߟྀͨ͠ύλʔϯ octocov https://github.com/k1LoW/octocov -
31 πʔϧͱͯ͠ͷ࣮ͷσβΠϯ CLIπʔϧͱWebΞϓϦέʔγϣϯͱͷൺֱ • WebΞϓϦέʔγϣϯͱରൺͯ͠ΈΔͱɺ • WebΞϓϦέʔγϣϯ • ೖग़ྗHTTPϦΫΤετ-Ϩεϙϯε •
ػೳΛ࣮ݱ͢ΔͨΊʹσʔλϕʔεϑΝΠϧͷಡΈॻ͖֎෦APIͱͷ௨৴ͳͲ͕ߦΘΕ Δɻ • CLIπʔϧ • ೖྗίϚϯυ/STDINɺग़ྗSTDOUT/STDERRʢͱExit codeʣ • ػೳΛ࣮ݱ͢ΔͨΊʹσʔλϕʔεϑΝΠϧͷಡΈॻ͖֎෦APIͱͷ௨৴ͳͲ͕ߦΘΕ Δɻ • ࣮ͱ͍ͯۙɻWebΞϓϦέʔγϣϯͷϓϥΫςΟεΛͦͷ··͏͜ͱ͕Ͱ͖Δ͜ͱ͕΄ͱΜͲɻ -
32 πʔϧͱͯ͠ͷ࣮ͷσβΠϯ WebΞϓϦέʔγϣϯͱҟͳΔಛੑ • ࣮ߦॴ͕ෆಛఆଟ • ʮಛఆͷαʔό্ʯͱ͍͏Θ͚Ͱͳ͍ʢʮͦΕͧΕͷϩʔΧϧʯͳͲʣ • 1ճͷ࣮ߦ͕ྃ͢ΔͱCLIπʔϧͷϓϩηεऴྃ͢Δ •
ΩϟογϡͳͲͷҰ࣌ใͷอ࣋Λ͢Δ߹ɺΠϯϝϞϦΛબͰ͖ͳ͍ • ෆಛఆଟͷϢʔβ͔ΒͷೖྗΛಉ࣌ʹड͚͚Δ͜ͱͳ͍ • ͦͷ༷͕ඞཁͳ߹ɺͦΕ͏CLIπʔϧͰͳ͍΄͏͕ྑͦ͞͏ • Web-DBͷΑ͏ͳӨڹ͕ดͨ͡ߏʹͳΔ͜ͱগͳ͘ɺ֎෦ͷཁૉ࡞༻͢ΔػೳΛ࣋ͭ͜ͱ ͕ଟ͍ -
33 πʔϧͱͯ͠ͷ࣮ͷσβΠϯ CLIπʔϧͷΞʔΩςΫνϟ • ೖग़ྗܾ·͓ͬͯΓɺ࣮͖͢ϏδωεϩδοΫఆٛͰ͖ΔWebΞϓϦέʔγϣϯͱಉ ͡ɻWebΞϓϦέʔγϣϯͰ͍ͬͯΔΞʔΩςΫνϟύλʔϯݪଇCLIπʔϧͰ༗ޮ • ҰํͰɺCLIπʔϧ • UNIXֶΑΓʮ1ͭͷ͜ͱΛ͏·͘ΔʯΑ͏ʹ࣮͞Ε
Δ͜ͱ͕ଟ͍ͨΊEntitiesUse Casesখ͘͞ͳΓ͕ͪ • Presenters/UI͍ͭ ίϚϯυ/STDIN/STDOUT/STDERR/Exit codeͰࣗ໌ • ֎෦ͷཁૉ࡞༻͢ΔػೳΛ࣋ͭ͜ͱ͕ଟ͍ͨΊGateways ʹଟ༷ੑ͕ੜ·Ε͍͢ -
36 έʔεελσΟ ʮ͍Ζ͍ΖͳσʔλϕʔεͷใΛऔಘ͍ͨ͠ʯ • σʔλϕʔεʹଓͯ͠σʔλϕʔεεΩʔϚυΩϡϝϯτΛੜ͢Δπʔϧ • ෳͷछྨͷσʔλϕʔεΛαϙʔτ • ͲͷछྨͷσʔλϕʔεͰಉ͡Α͏ͳεΩʔϚυΩϡϝϯτ Λੜ͢Δඞཁ͕͋Δ
• Gateways͕େ׆༂ • WebΞϓϦέʔγϣϯͷٞʹ͋Γ͕ͪͳ ʮDBΛஔ͖͑ΔͳΜͯΞϓϦέʔγϣϯͷण໋͔Β Έͯଘࡏ͠ͳ͍ʯͱ͍͏͜ͱʹͳΒͳ͍ɻΉ͠Ζ૿͑Δ tbls https://github.com/k1LoW/tbls -
37 έʔεελσΟ ʮ͍Ζ͍ΖͳσʔλετΞʹϨϙʔτΛૹΓ͍ͨʯ • ઌ΄ͲͰ͖ͯͨίʔυϝτϦΫεऩूπʔϧ • ऩूͨ͠ϝτϦΫεΛGitHubͷPull Requestʹίϝϯτ͢ΔҎ֎ʹ ༷ʑͳσʔλετΞʹϨϙʔτ͍ͨ͠ •
ूܭ͢ΔͨΊ • ʮϨϙʔτʯͰநԽ্ͨ͠Ͱଟ͘ͷAPIʹରԠ͍ͤͯ͞Δ • ͜͜ͰGatewaysେگ octocov https://github.com/k1LoW/octocov -
39 έʔεελσΟ ʮྲྀΕΔϩάΛ͍͍ײ۠ͬͯ͡ॲཧ͍ͨ͠ʯʢ2/2ʣ evry https://github.com/k1LoW/evry • ྲྀΕ͍ͯΔϩά=ετϦʔϜͳͷͰͰ͖Δ͚ͩඪ४ೖྗΛܭࢉίετখ͘͞ॲཧ͍ͨ͠ • ϨΠϠʔΛΘ͚ͯஸೡͳDTOͳͲͬͯΒΕͳ͍ •
ʮೖྗͱग़ྗʯͱ͍͏ΠϝʔδͰͳ͘ ʮೖྗ͔Βग़ྗʯͱ͍͏ύΠϓϥΠϯΛΉ • CLIπʔϧʹٻΊΒΕΔϢʔεέʔεͱͯ͠ Α͋͘Δ -
• Command-line interface tool designͱͯ͠ίϚϯυମܥͷσβΠϯͱ࣮ͷσβΠϯʹ͍ͭͯ έʔεελσΟΛަ͑ͯհͨ͠ • CLIπʔϧը໘ͷͳ͍୯७ͳϓϩάϥϜͱࢥ͍͖ҙ֎ʹߟྀͨ͠΄͏͕͍͍͜ͱଟ͘ɺΑ Γྑ͍ϢʔβମݧΛఏڙ͢ΔͨΊʹWebΞϓϦέʔγϣϯͱউΔͱྼΒͳ͍σβΠϯ͕ඞ ཁ
• σβΠϯ͕ఆ·Βͳͯ͘ख͕ࢭ·ͬͨΓਤʹىͨ͜͠Γ͢ΔͷWebΞϓϦέʔγϣϯͱ ಉ͡ • օ͞Μ͕CLIπʔϧΛ։ൃ͢Δࡍͷॿ͚ʹͳΕ͍Ͱ͢ɻ 41 ͓ΘΓʹ ͓ΘΓʹ