chore: update quickstart documentation #12813

jjohannes · 2024-04-15T15:16:20Z

Description:

Update documentation (quickstart), mainly on Gradle and IntelliJ
Add a runTestClient to allow you to run one of the "test clients" for a services node as a Java process (not as test). This was described in the docs but not easily possible anymore with the current setup. (Do we want this?)

You can browse all the updated "quickstart" docs here:
https://github.com/hashgraph/hedera-services/tree/11568-update-dev-docs/docs

Related issue(s):

#11568

Notes for reviewer:

Checklist

Documented (Code comments, README, etc.)
Tested (unit, integration, etc.)

github-actions · 2024-04-15T16:21:47Z

Node: HAPI Test (Restart) Results

3 tests 3 ✅ 5m 53s ⏱️
3 suites 0 💤
3 files 0 ❌

Results for commit 58e3d23.

♻️ This comment has been updated with latest results.

github-actions · 2024-04-15T16:24:13Z

Node: HAPI Test (Node Death Reconnect) Results

3 tests 3 ✅ 5m 31s ⏱️
3 suites 0 💤
3 files 0 ❌

Results for commit 58e3d23.

♻️ This comment has been updated with latest results.

github-actions · 2024-04-15T16:36:36Z

Node: HAPI Test (Token) Results

20 files 20 suites 5m 54s ⏱️
268 tests 268 ✅ 0 💤 0 ❌
343 runs 343 ✅ 0 💤 0 ❌

Results for commit 58e3d23.

♻️ This comment has been updated with latest results.

github-actions · 2024-04-15T16:53:52Z

Node: HAPI Test (Misc) Results

51 files 51 suites 20m 55s ⏱️
357 tests 357 ✅ 0 💤 0 ❌
375 runs 375 ✅ 0 💤 0 ❌

Results for commit 58e3d23.

♻️ This comment has been updated with latest results.

github-actions · 2024-04-15T16:54:38Z

Node: HAPI Test (Crypto) Results

23 files 23 suites 11m 41s ⏱️
350 tests 350 ✅ 0 💤 0 ❌
356 runs 356 ✅ 0 💤 0 ❌

Results for commit 58e3d23.

♻️ This comment has been updated with latest results.

github-actions · 2024-04-15T17:10:32Z

Node: HAPI Test (Time Consuming) Results

19 tests 19 ✅ 21m 23s ⏱️
4 suites 0 💤
4 files 0 ❌

Results for commit 58e3d23.

♻️ This comment has been updated with latest results.

github-actions · 2024-04-15T17:22:01Z

Node: HAPI Test (Smart Contract) Results

71 files 71 suites 21m 19s ⏱️
604 tests 604 ✅ 0 💤 0 ❌
656 runs 656 ✅ 0 💤 0 ❌

Results for commit 58e3d23.

♻️ This comment has been updated with latest results.

github-actions · 2024-04-15T17:57:51Z

Node: Unit Test Results

2 348 files ±0 2 348 suites ±0 3h 49m 40s ⏱️ ±0s
119 960 tests ±0 119 890 ✅ ±0 70 💤 ±0 0 ❌ ±0
128 533 runs ±0 128 463 ✅ ±0 70 💤 ±0 0 ❌ ±0

Results for commit 58e3d23. ± Comparison against base commit 621c8fe.

This pull request removes 371 and adds 126 tests. Note that renamed tests count towards both.


  
             IssuerDN: CN=s-aaaa
            SubjectDN: CN=s-aaaa
           Final Date: Fri Jan 01 00:00:00 UTC 2100
           Public Key: RSA Public Key [2e:28:bc:1e:d3:83:25:92:8e:cb:98:b1:b6:84:06:9c:d5:d8:14:d5],[56:66:d1:a4]
           Start Date: Sat Jan 01 00:00:00 UTC 2000
         SerialNumber: 12482092706667292405
        modulus: c1a0ff5d2372b53d12d12bb87dd03f5e…
        modulus: c1a0ff5d2372b53d12d12bb87dd03f5…
…

com.hedera.node.app.grpc.impl.netty.GrpcServiceBuilderTest ‑ [4] 

com.hedera.node.app.grpc.impl.netty.GrpcServiceBuilderTest ‑ [6] 

com.hedera.node.app.grpc.impl.netty.GrpcServiceBuilderTest ‑ [7]   
  
com.hedera.node.app.state.merkle.StateMetadataTest ‑ [11] 

com.hedera.node.app.state.merkle.StateMetadataTest ‑ [203] Some Legal Characters 

com.hedera.node.app.state.merkle.StateMetadataTest ‑ [395] 
 Some Legal Characters
com.swirlds.platform.crypto.KeysAndCertsTest ‑ [1] AddressBook {
   Address[id=0,nickname=WsTKgqhl,selfName=aaaa,weight=1000,hostnameInternal=127.0.0.1,portInternalIpv4=36610,hostnameExternal=138.191.111.158,portExternalIpv4=36610,sigPublicKey=<null>,agreePublicKey=<null>,sigCert=com.swirlds.platform.crypto.SerializableX509Certificate@719e1c26,agreeCert=com.swirlds.platform.crypto.SerializableX509Certificate@25ea076d,memo=X47u7wyw],
   Address[id=2,nickname=Tb2l3kss,selfName=aaab,weight=1000,hostnameInternal=127.0.0.1,portInternalIpv4=49175,hostnameExterna…, {0=KeysAndCerts[sigKeyPair=java.security.KeyPair@20d9ea6, agrKeyPair=java.security.KeyPair@24fa8, sigCert=[
[
  Version: V3
  Subject: CN=s-aaaa
  Signature Algorithm: SHA384withRSA, OID = 1.2.840.113549.1.1.12

  Key:  Sun RSA public key, 3072 bits
  params: null
  modulus: 3993597839710083868231945175919139090761808006636174301522933223628513549165622405392179927490525437989266705657795380522223992433641724878847443931065713607200936674817049095003247060840820816825608104539722939764219883909214899161434…
com.swirlds.platform.crypto.KeysAndCertsTest ‑ [2] AddressBook {
   Address[id=0,nickname=AvReWSmN,selfName=aaaa,weight=1000,hostnameInternal=127.0.0.1,portInternalIpv4=15376,hostnameExternal=96.181.154.129,portExternalIpv4=15376,sigPublicKey=<null>,agreePublicKey=<null>,sigCert=com.swirlds.platform.crypto.SerializableX509Certificate@4d2da8e6,agreeCert=com.swirlds.platform.crypto.SerializableX509Certificate@27e1be76,memo=cLdgdD7d],
   Address[id=2,nickname=VySQA9x6,selfName=aaab,weight=1000,hostnameInternal=127.0.0.1,portInternalIpv4=50573,hostnameExternal…, {0=KeysAndCerts[sigKeyPair=java.security.KeyPair@260fb925, agrKeyPair=java.security.KeyPair@4c372496, sigCert=  [0]         Version: 3
         SerialNumber: 12482092706667292405
             IssuerDN: CN=s-aaaa
           Start Date: Sat Jan 01 00:00:00 UTC 2000
           Final Date: Fri Jan 01 00:00:00 UTC 2100
            SubjectDN: CN=s-aaaa
           Public Key: RSA Public Key [2e:28:bc:1e:d3:83:25:92:8e:cb:98:b1:b6:84:06:9c:d5:d8:14:d5],[56:66:d1:a4]
        modulus: c1a0ff5d2372b53d12d12bb87dd03f5…
com.swirlds.platform.crypto.KeysAndCertsTest ‑ [3] AddressBook {
   Address[id=0,nickname=6yXMzTWq,selfName=aaaa,weight=1000,hostnameInternal=127.0.0.1,portInternalIpv4=21228,hostnameExternal=93.194.215.83,portExternalIpv4=21228,sigPublicKey=<null>,agreePublicKey=<null>,sigCert=com.swirlds.platform.crypto.SerializableX509Certificate@78f00ec,agreeCert=<null>,memo=niTT0gl3],
   Address[id=3,nickname=LlymMtio,selfName=aaab,weight=1000,hostnameInternal=127.0.0.1,portInternalIpv4=12935,hostnameExternal=43.30.5.249,portExternalIpv4=12935,sigPublicKey=<null>,agre…, {0=KeysAndCerts[sigKeyPair=java.security.KeyPair@4af6e801, agrKeyPair=java.security.KeyPair@20e202db, sigCert=[
[
  Version: V3
  Subject: CN=s-aaaa
  Signature Algorithm: SHA384withRSA, OID = 1.2.840.113549.1.1.12

  Key:  Sun RSA public key, 3072 bits
  params: null
  modulus: 399359783971008386823194517591913909076180800663617430152293322362851354916562240539217992749052543798926670565779538052222399243364172487884744393106571360720093667481704909500324706084082081682560810453972293976421988390921489916…
com.swirlds.platform.network.connectivity.InboundConnectionHandlerTest ‑ [1] AddressBook {
   Address[id=0,nickname=Otzm3xRP,selfName=aaaa,weight=1000,hostnameInternal=127.0.0.1,portInternalIpv4=19877,hostnameExternal=43.208.43.196,portExternalIpv4=19877,sigPublicKey=<null>,agreePublicKey=<null>,sigCert=com.swirlds.platform.crypto.SerializableX509Certificate@340d2540,agreeCert=com.swirlds.platform.crypto.SerializableX509Certificate@35a27c09,memo=aJVTheo0],
   Address[id=2,nickname=Mi7EwSUW,selfName=aaab,weight=1000,hostnameInternal=127.0.0.1,portInternalIpv4=5675,hostnameExternal=3…, {0=KeysAndCerts[sigKeyPair=java.security.KeyPair@243e4bd8, agrKeyPair=java.security.KeyPair@4d7ab3f7, sigCert=[
[
  Version: V3
  Subject: CN=s-aaaa
  Signature Algorithm: SHA384withRSA, OID = 1.2.840.113549.1.1.12

  Key:  Sun RSA public key, 3072 bits
  params: null
  modulus: 399359783971008386823194517591913909076180800663617430152293322362851354916562240539217992749052543798926670565779538052222399243364172487884744393106571360720093667481704909500324706084082081682560810453972293976421988390921489916…
…

♻️ This comment has been updated with latest results.

codecov · 2024-05-15T09:16:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (621c8fe) to head (fa91e3f).

❗ Current head fa91e3f differs from pull request most recent head 58e3d23

Please upload reports for the commit 58e3d23 to get more accurate results.

Additional details and impacted files

@@       Coverage Diff        @@
##   develop   #12813   +/-   ##
================================
================================

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mhess-swl

Looks great!

Signed-off-by: Jendrik Johannes <[email protected]>

rbair23 · 2024-06-13T15:20:06Z

docs/intellij-quickstart.md

+
+### Starting a local single-node network
+
+You can start the `ServicesMain` process via the `modrun` Gradle task. You will see an output like the following:


I have filed a new issue (#13836) that removes modrun and just uses run. We needed modrun because we needed the ability to run both the modular version of services and the mono version of services. But now that we have moved everything to modular code, we can just let run be the task.

jjohannes changed the title ~~chore: update quickstart documentation~~ chore: update quickstart documentation / update Gradle plugins Apr 15, 2024

jjohannes force-pushed the 11568-update-dev-docs branch from d4af5b0 to 5f93bf0 Compare April 15, 2024 15:31

jjohannes force-pushed the 11568-update-dev-docs branch 4 times, most recently from e593691 to 1419a6d Compare April 25, 2024 09:28

jjohannes changed the title ~~chore: update quickstart documentation / update Gradle plugins~~ chore: update quickstart documentation Apr 25, 2024

jjohannes force-pushed the 11568-update-dev-docs branch 3 times, most recently from 40ee387 to d3b62ed Compare April 25, 2024 09:44

jjohannes marked this pull request as ready for review April 25, 2024 10:30

jjohannes requested review from a team as code owners April 25, 2024 10:30

jjohannes requested a review from a team April 25, 2024 10:30

jjohannes requested a review from a team as a code owner April 25, 2024 10:30

jjohannes requested review from JeffreyDallas, nathanklick, rbair23, kimbor and hendrikebbers April 25, 2024 10:30

jjohannes force-pushed the 11568-update-dev-docs branch from d3b62ed to 5a1108b Compare April 25, 2024 15:13

jjohannes self-assigned this Apr 30, 2024

jjohannes force-pushed the 11568-update-dev-docs branch from fdeebab to 4a9b7c2 Compare May 7, 2024 13:08

jjohannes mentioned this pull request May 7, 2024

build: require a fixed 'major.minor.patch' Java version to be installed #13108

Merged

2 tasks

jjohannes force-pushed the 11568-update-dev-docs branch 2 times, most recently from 69d2fec to 1667adc Compare May 15, 2024 07:45

jjohannes force-pushed the 11568-update-dev-docs branch 2 times, most recently from fe24797 to 84926b3 Compare May 17, 2024 05:23

hendrikebbers previously approved these changes May 23, 2024

View reviewed changes

jjohannes dismissed hendrikebbers’s stale review via e436c87 May 23, 2024 15:08

jjohannes force-pushed the 11568-update-dev-docs branch from 84926b3 to e436c87 Compare May 23, 2024 15:08

jjohannes requested a review from hendrikebbers May 23, 2024 15:08

hendrikebbers approved these changes May 24, 2024

View reviewed changes

jjohannes force-pushed the 11568-update-dev-docs branch from e436c87 to bdc2917 Compare June 4, 2024 10:19

jjohannes added this to the v0.51 milestone Jun 4, 2024

jjohannes force-pushed the 11568-update-dev-docs branch from bdc2917 to 51477d4 Compare June 4, 2024 10:22

jjohannes mentioned this pull request Jun 8, 2024

Chore: Bump Gradle to version 8.8 #13753

Closed

mhess-swl approved these changes Jun 12, 2024

View reviewed changes

mhess-swl assigned jjohannes and unassigned jjohannes Jun 12, 2024

jeromy-cannon approved these changes Jun 13, 2024

View reviewed changes

jjohannes force-pushed the 11568-update-dev-docs branch from 51477d4 to fa91e3f Compare June 13, 2024 12:33

jjohannes added 4 commits June 13, 2024 15:50

chore: Update quickstart docs

635ab82

Signed-off-by: Jendrik Johannes <[email protected]>

chore: note about IntelliJ plugins

d724d97

Signed-off-by: Jendrik Johannes <[email protected]>

chore: be more precise on the JDK version

113e8aa

Signed-off-by: Jendrik Johannes <[email protected]>

chore: adjust locations and names of Gradle plugins to latest changes

58e3d23

Signed-off-by: Jendrik Johannes <[email protected]>

jjohannes force-pushed the 11568-update-dev-docs branch from fa91e3f to 58e3d23 Compare June 13, 2024 13:51

jjohannes merged commit a757df8 into develop Jun 13, 2024
45 checks passed

jjohannes deleted the 11568-update-dev-docs branch June 13, 2024 15:17

rbair23 mentioned this pull request Jun 13, 2024

Chore: Replace modrun with run #13836

Open

11 tasks

rbair23 reviewed Jun 13, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: update quickstart documentation #12813

chore: update quickstart documentation #12813

jjohannes commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

codecov bot commented May 15, 2024 •

edited

Loading

mhess-swl left a comment

rbair23 Jun 13, 2024


		### Starting a local single-node network

		You can start the `ServicesMain` process via the `modrun` Gradle task. You will see an output like the following:

chore: update quickstart documentation #12813

chore: update quickstart documentation #12813

Conversation

jjohannes commented Apr 15, 2024 • edited Loading

github-actions bot commented Apr 15, 2024 • edited Loading

Node: HAPI Test (Restart) Results

github-actions bot commented Apr 15, 2024 • edited Loading

Node: HAPI Test (Node Death Reconnect) Results

github-actions bot commented Apr 15, 2024 • edited Loading

Node: HAPI Test (Token) Results

github-actions bot commented Apr 15, 2024 • edited Loading

Node: HAPI Test (Misc) Results

github-actions bot commented Apr 15, 2024 • edited Loading

Node: HAPI Test (Crypto) Results

github-actions bot commented Apr 15, 2024 • edited Loading

Node: HAPI Test (Time Consuming) Results

github-actions bot commented Apr 15, 2024 • edited Loading

Node: HAPI Test (Smart Contract) Results

github-actions bot commented Apr 15, 2024 • edited Loading

Node: Unit Test Results

codecov bot commented May 15, 2024 • edited Loading

Codecov Report

mhess-swl left a comment

Choose a reason for hiding this comment

rbair23 Jun 13, 2024

Choose a reason for hiding this comment

jjohannes commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

github-actions bot commented Apr 15, 2024 •

edited

Loading

codecov bot commented May 15, 2024 •

edited

Loading