CASSANDRA-18035: Add quick start development guide and ant targets for local docker development #1996

pauloricardomg · 2022-11-10T22:02:11Z

No description provided.

QUICKSTART.md

…velopment Patch by Paulo Motta; Reviewed by X for CASSANDRA-18035

smiklosovic · 2022-12-20T11:37:32Z

README.asc

@@ -11,16 +11,18 @@ For more information, see http://cassandra.apache.org/[the Apache Cassandra web

 Issues should be reported on https://issues.apache.org/jira/projects/CASSANDRA/issues/[The Cassandra Jira].


@pauloricardomg this whole file should be called "README.adoc". "asc" suffix does not make the document rendered in IDEA automatically.

smiklosovic · 2022-12-20T12:07:15Z

README.asc

+-----
+
+[start=2]
+2. On IntelliJ IDEA startup screen, open the the directory of your Cassandra project (/path/to/cassandra). It may take a little bit until the IDE loads all dependencies and indexes the project. Please refer to the troubleshooting items below if you face any issues when loading Cassandra on IntelliJ IDEA:


double "the the"

smiklosovic · 2022-12-20T12:08:30Z

README.asc

+* ⛔ If a `JDK11 is missing` error message pops up, click `configure` > `Add new JDK` and point to the installed JDK, usually located in `/usr/lib/jvm/<jdk>` in Debian-based systems or `/Library/Java/JavaVirtualMachines/<jdk>` on macOS.
+
+[start=3]
+3. In order to check that the project is loaded orrectly, open the test class https://github.com/apache/cassandra/blob/trunk/test/distributed/org/apache/cassandra/distributed/test/RepairTest.java[test/distributed/org/apache/cassandra/distributed/test/RepairTest.java] and attempt to run this test suite by right-clicking in the test class name (`RepairTest`) and selecting the option `Run RepairTest` or using the shortcut `Ctrl+Shift+F10` after clicking on the class name.


missing "c" in "orrectly"

smiklosovic · 2022-12-20T12:21:24Z

.build/docker/stop.sh

@@ -0,0 +1,33 @@
+#!/bin/bash


shouldnt this be #!/bin/sh ?

smiklosovic · 2022-12-20T12:21:59Z

.build/docker/stop.sh

+fi
+
+if [ $( docker ps -a -f name=cassandra-test | wc -l ) -eq 2 ]; then
+  CONTAINER=`docker rm --force cassandra-test`


IDEA says Use $(...) notation instead of legacy backticked ....

smiklosovic · 2022-12-20T12:22:43Z

.build/docker/start.sh

+## Create network if does not exist
+docker network create cassandra-test 2>/dev/null || true
+
+CONTAINER_ID=`docker run --rm --name cassandra-test --network cassandra-test -d apache/cassandra-test`


IDEA says: Use $(...) notation instead of legacy backticked

smiklosovic · 2022-12-20T12:23:01Z

.build/docker/start.sh

+fi
+
+# Check if container is already running
+if [ $( docker ps -a -f name=cassandra-test | wc -l ) -eq 2 ]; then


IDEA says: Quote this to prevent word splitting. Probably should be something like this:

if [ "$(docker ps -a -f name=cassandra-test | wc -l)" -eq 2 ]; then

smiklosovic · 2022-12-20T12:24:45Z

.build/docker/start.sh

@@ -0,0 +1,64 @@
+#!/bin/bash


#!/bin/sh ?

smiklosovic · 2022-12-20T12:26:39Z

.build/docker/Dockerfile

+EXPOSE 7000 7001 7199 9042 9160
+
+# Container is healthy when JMX port is up
+HEALTHCHECK CMD /usr/bin/nc localhost -z 7199 || exit 1


This might be replaced by nodetool status returning 0 exit code. The fact that this port is up does not necessarily mean that nodetool status will be successful as port is open but the node is still booting anyway under the hood.

smiklosovic · 2022-12-20T12:28:16Z

.build/docker/docker-entrypoint.sh

+}
+
+if [ "$1" = 'cassandra' ]; then
+	: ${CASSANDRA_RPC_ADDRESS='0.0.0.0'}


all of these in this if in IDEA emit issues like: "This default assignment may cause DoS due to globbing. Quote it."

smiklosovic · 2022-12-20T12:28:54Z

.build/docker/docker-entrypoint.sh

+fi
+
+# allow the container to be started with `--user`
+if [ "$1" = 'cassandra' -a "$(id -u)" = '0' ]; then


Prefer [ p ] && [ q ] as [ p -a q ] is not well defined.
See SC2166.

slachiewicz reviewed Nov 14, 2022

View reviewed changes

QUICKSTART.md Outdated Show resolved Hide resolved

slachiewicz approved these changes Nov 14, 2022

View reviewed changes

smiklosovic reviewed Nov 15, 2022

View reviewed changes

QUICKSTART.md Outdated Show resolved Hide resolved

smiklosovic reviewed Nov 15, 2022

View reviewed changes

QUICKSTART.md Outdated Show resolved Hide resolved

smiklosovic reviewed Nov 15, 2022

View reviewed changes

QUICKSTART.md Outdated Show resolved Hide resolved

pauloricardomg force-pushed the CASSANDRA-18035 branch from 2d79c03 to af6d62b Compare November 15, 2022 23:41

pauloricardomg mentioned this pull request Nov 16, 2022

WEBSITE - Add link to quick start development guide on "Contributing to Cassandra" section apache/cassandra-website#195

Open

pauloricardomg force-pushed the CASSANDRA-18035 branch from af6d62b to d1f5759 Compare November 16, 2022 20:55

pauloricardomg changed the title ~~CASSANDRA-18035: Add "Hello World" docker-based quick start guide~~ CASSANDRA-18035: Add quick start development guide and ant targets for local docker development Nov 16, 2022

pauloricardomg force-pushed the CASSANDRA-18035 branch 3 times, most recently from c934c6b to 0ccf661 Compare November 30, 2022 18:57

pauloricardomg force-pushed the CASSANDRA-18035 branch from 0ccf661 to 058fd52 Compare December 15, 2022 22:03

Add quick start development guide and ant targets for local docker de…

18e77fe

…velopment Patch by Paulo Motta; Reviewed by X for CASSANDRA-18035

pauloricardomg force-pushed the CASSANDRA-18035 branch from 058fd52 to 18e77fe Compare December 19, 2022 21:00

smiklosovic reviewed Dec 20, 2022

View reviewed changes

.build/docker/stop.sh

@@ -0,0 +1,33 @@

#!/bin/bash

Copy link

Contributor

smiklosovic Dec 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldnt this be #!/bin/sh ?

smiklosovic reviewed Dec 20, 2022

View reviewed changes

.build/docker/start.sh

@@ -0,0 +1,64 @@

#!/bin/bash

Copy link

Contributor

smiklosovic Dec 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#!/bin/sh ?

smiklosovic reviewed Dec 20, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

CASSANDRA-18035: Add quick start development guide and ant targets for local docker development #1996

CASSANDRA-18035: Add quick start development guide and ant targets for local docker development #1996

Uh oh!

pauloricardomg commented Nov 10, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

smiklosovic Dec 20, 2022 •

edited

Loading

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

smiklosovic Dec 20, 2022

Uh oh!

Uh oh!

		@@ -11,16 +11,18 @@ For more information, see http://cassandra.apache.org/[the Apache Cassandra web

		Issues should be reported on https://issues.apache.org/jira/projects/CASSANDRA/issues/[The Cassandra Jira].

CASSANDRA-18035: Add quick start development guide and ant targets for local docker development #1996

Are you sure you want to change the base?

CASSANDRA-18035: Add quick start development guide and ant targets for local docker development #1996

Uh oh!

Conversation

pauloricardomg commented Nov 10, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

smiklosovic Dec 20, 2022 • 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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

smiklosovic Dec 20, 2022 •

edited

Loading