marine simpleName 対応 by Syogo-Suganoya · Pull Request #56 · givery-technology/marine

Syogo-Suganoya · 2023-09-30T12:26:23Z

image リストの修正（env.yml）
バージョンが最新に保たれる（チャレンジを更新しなくても勝手に変わる）旨の追記
C#に関して注意事項の追記
チャレンジやブックの imageName の修正
チャレンジやブックの C#のcsprojの修正

Syogo-Suganoya · 2023-09-30T12:29:37Z

以下はmappings.ymlとマッチしているものが見当たらなかったため、そのままとしています。

marine/contents/sample/ai/track.yml

Line 11 in 8efafd9

imageName: givery/track-base2

marine/contents/sample/book-cpp/chapter1/exercise/track.yml

Line 17 in 8efafd9

imageName: givery/track-cpp-googletest

marine/docs/ja/how-to-make-ai.md

Line 146 in 8efafd9

imageName: givery/track-base2

Syogo-Suganoya

@snakazawa review me

Syogo-Suganoya · 2023-10-01T10:48:47Z

- imageName: givery/track-nodejs-8
+- imageName: nodejs

 ### hint
-JavaScript(Node.js)を使用するセクションを作成する際にはDockerイメージとして`givery/track-nodejs-8`を使用します。
+JavaScript(Node.js)を使用するセクションを作成する際にはDockerイメージとして`nodejs`を使用します。


チャレンジやブックの imageName の修正

Syogo-Suganoya · 2023-10-01T10:50:12Z

 ### build.gradle
 このサンプルではTestRunnerとしてGradleを使用しています。
-[build.gradle](build.grade)はテストの実行結果を[TAP](https://testanything.org/)形式で出力するようにカスタマイズされています。
+[build.gradle](build.gradle)はテストの実行結果を[TAP](https://testanything.org/)形式で出力するようにカスタマイズされています。


Syogo-Suganoya · 2023-10-01T10:51:50Z


 dependencies {
-    testCompile 'junit:junit:4.12'
+    implementation group: 'junit', name: 'junit', version: '4.13.2'


gradleの compile の書き方が変更されたので、併せて修正しました。

javaのチャレンジってmavenじゃなくてgradleで作るように案内してるんでしたっけ？
gradleの方がversionセンシティブな気がするので、注意が必要です。

この設定がMarine(=OrcaImages 2.1.1)で動くことは多分確認していると思うんですが、現時点でのprodイメージであるOrcaImages2.0.2でも動くかを確認してください。(imageName: givery/track-cli-java:2.0.2としてMarineで動作するかも確認してください。)

また、バージョン番号が明記されている点も気になります。
maven, gradle, junitなどはOrcaImagesにpre-installされています。

なので、installされているバージョンが使用される場合はbuildも高速に動作するんですが、異なるバージョンが使用される場合初回実行でdownloadが走るので、パフォーマンス的に不利になります。(2回目以降の実行ではキャッシュが使えるので実行速度上の不利はありませんが、ブラウザでリロードするとまたdownloadからになります。)

この辺環境変数を活用する方法もあるようなので、

https://docs.gradle.org/current/userguide/build_environment.html#sec:project_properties

次にOrcaImagesを作るときはこの辺の環境変数も合わせて設定した方が良いかもしれません。

Syogo-Suganoya · 2023-10-01T10:53:10Z

  secret: 1
 envConf:
-  imageName: givery/track-java-8
+  imageName: java


contents/sample/coding-java/ はコンテンツ作成マニュアルに使用するサンプルですが、notionの方も併せて修正しました。
https://www.notion.so/givery/c71f8d3ba35a45a08c25c73666ed4fc1

また、マニュアルに使用予定の未マージの下記プルリクのイメージも併せて修正しました。

チュートリアル C#コーディング問題(xUnit版) #48

チュートリアル Javaコーディング問題(TestRunner版) 作り込み編 #45

チュートリアル Javaコーディング問題(JUnit版) #41

Syogo-Suganoya · 2023-10-01T10:53:36Z

+    <DOTNET_FRAMEWORK_VERSION Condition=" '$(DOTNET_FRAMEWORK_VERSION)' == '' ">net6.0</DOTNET_FRAMEWORK_VERSION>
    <OutputType>Exe</OutputType>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>$(DOTNET_FRAMEWORK_VERSION)</TargetFramework>
    <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
+    <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+    <AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath>


チャレンジやブックの C#のcsprojの修正

Syogo-Suganoya · 2023-10-01T10:54:03Z

- givery/track-rust-1.39
- givery/track-haskell-14.11
- givery/track-python3.7-anaconda
+- cpp


image リストの修正（env.yml）

Syogo-Suganoya · 2023-10-01T10:55:11Z

+これらのイメージは[DockerHub](https://hub.docker.com/u/givery)で公開されているイメージと次のようにマッピングされています。`cacheDirs`などを含んだマッピングではデフォルトでその設定が反映されます。例えば`java`イメージを使用する時、envConfに`cacheDirs`を記載しなくても、自動で`cacheDirs`に`/root/.m2`の設定が反映されます。
+
+<details><summary>イメージのマッピング(クリックして展開)</summary>


image リストの修正（env.yml）

image リストの後ろに下記も追記しておきました。

DockerHub 参照時のイメージ名

cacheDirsの自動反映の説明

Syogo-Suganoya · 2023-10-01T10:55:38Z

+### イメージのバージョンについて
+イメージは自動で最新に保たれます。envConfを逐一更新する必要はありません。


バージョンが最新に保たれる（チャレンジを更新しなくても勝手に変わる）旨の追記

Syogo-Suganoya · 2023-10-01T10:55:53Z

+### C#の注意事項
+C#に使用するcsprojファイルの`PropertyGroup`には以下の設定を記載してください。バージョンが変わっても動作するようにするためです。


C#に関して注意事項の追記

Syogo-Suganoya · 2023-10-01T10:57:43Z

+#### バージョンの依存について
+バージョンに依存するライブラリを利用している場合はご相談ください。


dotnet のバージョンに依存するライブラリを利用している場合はこれだけだと動かなくなる可能性があるためご相談ください。

バージョンの依存についても追記しました。

https://givery.slack.com/archives/C39R16W7J/p1695969539480769?thread_ts=1695966255.249269&cid=C39R16W7J

snakazawa

LGTM

shunjikonishi · 2023-10-02T03:57:32Z

+- perl
+- php
+- python
+- python3


pythonとpython3はどちらも同じイメージ(python3)が使われます。
(SimpleNameではpython2はサポートされません)

以下の書き方に修正しました。

- python - `python3`でも可能です。どちらも同じ `givery/track-cli-python3` のイメージが使用されます。

shunjikonishi · 2023-10-02T03:59:52Z

  username: "postgres"
  baseDir: "/home/postgres"
-```
+```


imageName: postgresとした場合はusernameとbaseDirの指定は必要なくなりました。

「postgresの注意事項」のセクションを削除しました。

shunjikonishi · 2023-10-02T04:23:03Z


 dependencies {
-    testCompile 'junit:junit:4.12'
+    implementation group: 'junit', name: 'junit', version: '4.13.2'


javaのチャレンジってmavenじゃなくてgradleで作るように案内してるんでしたっけ？
gradleの方がversionセンシティブな気がするので、注意が必要です。

この設定がMarine(=OrcaImages 2.1.1)で動くことは多分確認していると思うんですが、現時点でのprodイメージであるOrcaImages2.0.2でも動くかを確認してください。(imageName: givery/track-cli-java:2.0.2としてMarineで動作するかも確認してください。)

また、バージョン番号が明記されている点も気になります。
maven, gradle, junitなどはOrcaImagesにpre-installされています。

なので、installされているバージョンが使用される場合はbuildも高速に動作するんですが、異なるバージョンが使用される場合初回実行でdownloadが走るので、パフォーマンス的に不利になります。(2回目以降の実行ではキャッシュが使えるので実行速度上の不利はありませんが、ブラウザでリロードするとまたdownloadからになります。)

この辺環境変数を活用する方法もあるようなので、

https://docs.gradle.org/current/userguide/build_environment.html#sec:project_properties

次にOrcaImagesを作るときはこの辺の環境変数も合わせて設定した方が良いかもしれません。

Syogo-Suganoya

@shunjikonishi review me

javaのチャレンジってmavenじゃなくてgradleで作るように案内してるんでしたっけ？

metatestを使わずに済むという点からgradleを採用しました。詳しくはこちら↓を参照ください。
#49

OrcaImages2.0.2でも動くかを確認してください。

正常に動作することを確認しました。

この辺環境変数を活用する方法もあるようなので、

すみません環境変数などは疎いので、一旦保留としました。

Syogo-Suganoya · 2023-10-02T11:09:00Z

+- perl
+- php
+- python
+- python3


以下の書き方に修正しました。

- python - `python3`でも可能です。どちらも同じ `givery/track-cli-python3` のイメージが使用されます。

Syogo-Suganoya · 2023-10-02T11:09:26Z

  username: "postgres"
  baseDir: "/home/postgres"
-```
+```


「postgresの注意事項」のセクションを削除しました。

Syogo-Suganoya · 2023-10-02T11:09:55Z


 dependencies {
-    implementation group: 'junit', name: 'junit', version: '4.13.2'
+    implementation group: 'junit', name: 'junit', version: '4.+'


バージョン番号が明記されている点も気になります。

バージョンはJunit4のみを指定して、それ以下はワイルドにしました。

shunjikonishi

LGTM

mappings.ymlの内容をまるごと転記しているのが少し気になりましたが、一旦このままでOKです。

最終的には社外のコンテンツ開発者が指定するのはimageNameだけにしたいと思っており、今のsimpleNameでほぼ実現できているとも思っています。

なので、cacheDirsとかworkingDirみたいな内容が説明なしででてくるのは微妙かなと思ったり、mappings.ymlが変わった時に追随するの面倒じゃないかな、と思ったりもするんですが秘密情報ではないし、テスト実行の仕組みを深く知る上では有益な情報でもあるのでとりあえずはこれでOKとします。

fix #55

eb6d144

Syogo-Suganoya self-assigned this Sep 30, 2023

Syogo-Suganoya linked an issue Sep 30, 2023 that may be closed by this pull request

marine simpleName 対応 #55

Closed

Syogo-Suganoya commented Oct 1, 2023

View reviewed changes

Syogo-Suganoya requested a review from snakazawa October 1, 2023 11:06

Syogo-Suganoya assigned snakazawa Oct 1, 2023

Syogo-Suganoya added the Review me! label Oct 1, 2023

snakazawa reviewed Oct 1, 2023

View reviewed changes

mitsuruog requested a review from shunjikonishi October 2, 2023 01:08

shunjikonishi reviewed Oct 2, 2023

View reviewed changes

Syogo-Suganoya added 2 commits October 2, 2023 20:06

fix env.md

3faf983

fix version指定

120a4ec

Syogo-Suganoya commented Oct 2, 2023

View reviewed changes

shunjikonishi approved these changes Oct 3, 2023

View reviewed changes

Syogo-Suganoya added 2 commits October 4, 2023 09:41

Merge branch 'master' into fix/simpleName

6d3fc64

fix #46の取り込み

6efbf3a

Syogo-Suganoya added Ship it! and removed Review me! labels Oct 4, 2023

shunjikonishi approved these changes Apr 8, 2024

View reviewed changes

shunjikonishi merged commit 52d87c5 into master Apr 8, 2024

		これらのイメージは[DockerHub](https://hub.docker.com/u/givery)で公開されているイメージと次のようにマッピングされています。`cacheDirs`などを含んだマッピングではデフォルトでその設定が反映されます。例えば`java`イメージを使用する時、envConfに`cacheDirs`を記載しなくても、自動で`cacheDirs`に`/root/.m2`の設定が反映されます。

		<details><summary>イメージのマッピング(クリックして展開)</summary>

		### イメージのバージョンについて
		イメージは自動で最新に保たれます。envConfを逐一更新する必要はありません。

		### C#の注意事項
		C#に使用するcsprojファイルの`PropertyGroup`には以下の設定を記載してください。バージョンが変わっても動作するようにするためです。

		#### バージョンの依存について
		バージョンに依存するライブラリを利用している場合はご相談ください。

Conversation

Syogo-Suganoya commented Sep 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Syogo-Suganoya commented Sep 30, 2023

Uh oh!

Syogo-Suganoya left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Syogo-Suganoya Oct 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

snakazawa left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Syogo-Suganoya left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shunjikonishi left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Syogo-Suganoya commented Sep 30, 2023 •

edited

Loading

Syogo-Suganoya Oct 1, 2023 •

edited

Loading