set up working environment, with java #8

urmishukla · 2023-01-26T05:50:13Z

Development environment setup for Urmi Shukla at the DSI. Outlines the entire process of setting up small dev environment, building Dockerfile and running a small helloWorld.java program.

Closes #3

matthewfeickert · 2023-02-10T02:11:06Z

@urmishukla 👋 Because I didn't plan things all the way through 😬 when PR #11 got merged it could possibly create merge conflicts for everyone else who had a PR open. To get around this (a normal thing in development so no worries) just click the update branch button that is open

and then select the merge option. Afterwards, run

git fetch --all --prune

and then on your feature branch (this branch)

git pull

If you have any trouble just escape with git merge --abort and first google for resources and if you don't find any helpful ones let me know.

urmishukla · 2023-02-21T10:11:11Z

Finished onboarding.

matthewfeickert · 2023-02-22T08:09:08Z

@urmishukla I'm gone to a conference this week with limited internet access. I'll review this later this week.

urmishukla · 2023-03-01T15:53:45Z

Okay, sure. Let me know if there’s anything else I can work on in the meantime!

matthewfeickert

@urmishukla this is a good start 👍. In addition to the review comments I've got a few pieces of general feedback.

In Issue #3 it mentioned

Use a GitHub keyword in the body of the PR description to automatically close this Issue when the PR is merged.

At the moment this PR doesn't do that, and in addition the PR title and body (the main text area) need some improvement. The PR title should be a short description which gives an overview, though I find it useful to structure it in a similar way to how you would a good commit message — something short that tells you what it will do if you apply it / accept it. Also in general you should add some short text to the PR body (doesn't have to be long) that explains to the maintainer of the project what this PR does, why you're doing it, what Issues it might address. So you should add just a few sentences here as well. 👍

Select and install an IDE to your local machine. If you do not know or care what IDE to use, select VS Code. You are not required to use this IDE for the rest of the exercise if you would prefer to only use a text editor, but use of an IDE is a good thing to know at some level.

It would be good to document this as well. If you can also add some context on what OS you're working on that can be relevant for future information and projects.

Finally, this isn't something you need to document, but as a check when you setup your SSH keys were you able to add them to your ssh agent / keychain on your OS so that you don't need to enter your password every time you try to do a git push? I didn't make this explicitly clear, so I thought I would check with everyone to make sure that using ssh keys isn't a painful experience.

matthewfeickert · 2023-03-02T08:23:47Z

shukla/.pre-commit-config.yaml

+# See https://pre-commit.com for more information
+# # See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files


This is good. Though, given the comment that I made #8 (comment) I'm just going to have everyone use the one that is already in the main branch so can you delete this file?

matthewfeickert · 2023-03-02T08:24:53Z

shukla/Dockerfile

@@ -0,0 +1,9 @@
+FROM ubuntu


Suggested change

FROM ubuntu

FROM ubuntu:22.04

While this is valid, this is subject to breakage as you haven't specified a tag of the ubuntu image.

matthewfeickert · 2023-03-02T08:25:19Z

shukla/Dockerfile

+	apt-get -y install default-jre-headless && \
+	apt-get clean && \
+	rm -rf /var/lib/apt/lists/*
+RUN apt-get update && apt-get install make


This RUN step could be combined with the previous one above it.

matthewfeickert · 2023-03-02T08:31:24Z

shukla/Dockerfile

+CMD ["make", "run"]
+CMD ["make", "clean"]


There can be only one CMD per Dockerfile, so the last one effectively clobbers the first. So at runtime only

make clean

will get run.

matthewfeickert · 2023-03-02T08:34:55Z

shukla/README.md

+7. Created Dockerfile which runs helloWorld.java.
+
+8. To build this Dockerfile, execute the following build commands:
+	A) sudo docker image build -t urmishukla/ubuntu-java:v1 .


Suggested change

A) sudo docker image build -t urmishukla/ubuntu-java:v1 .

A) sudo docker build -t urmishukla/ubuntu-java:v1 .

while not technically wrong, you're not going to see this syntax very often and docker build is fine. If you need to use sudo here then it seems that you haven't added yourself and docker to the proper user groups to avoid this. Do you know how to do this?

matthewfeickert · 2023-03-02T08:36:29Z

shukla/README.md

+8. To build this Dockerfile, execute the following build commands:
+	A) sudo docker image build -t urmishukla/ubuntu-java:v1 .
+	B) run "sudo docker image ls" to check that this new Docker image is present.
+	C) rsudo docker container run --mount type=bind,source=${PWD},target=/temp urmishukla/ubuntu-java:v1 java/temp/helloWorld.java


Instead of trying to bind mount the files in here (which is sometimes a useful approach) try to COPY the relevant files that you need into the Docker image when you're defining the Dockerfile. This is a more common approach as then the built Docker image is a binary that has the executable inside of it, which can then be distributed.

matthewfeickert · 2023-03-07T20:19:49Z

@urmishukla just checking in to see if you have questions. Is there anything you want to discuss that is currently blocking you?

urmishukla · 2023-03-08T02:47:06Z

@matthewfeickert Hi Matthew! So far, no. I've begun implementing some of these changes, but might be busy until Wednesday since I have midterms all week until then. I can probably update my pull request by Thursday afternoon or so, if that works

matthewfeickert · 2023-03-08T02:49:08Z

but might be busy until Wednesday since I have midterms all week until then

SGTM! 👍 Hope that your midterms go great!

urmishukla · 2023-03-20T05:29:08Z

Hi Matthew, I made all the changes you mentioned, but for some reason my Dockerfile won't correctly run my program. When I type "make build", "make run", and "make clean" into the shukla directory, my java program runs. But the Dockerfile I have gives me the error: "make: *** No rule to make target 'clean'. Stop"
I looked online, and found solutions, but none seemed to fix the issue (naming the Makefile something other than "Makefile", which I haven't, or using spaces instead of tabs in the actual Makefile).
Other than that, I think I should be ready to merge. Let me know if there's anything else I need to change!

urmishukla · 2023-03-31T14:52:03Z

Hi Matthew, in the meantime, should I begin to work through the Intermediate Research Software Development in Python module?

matthewfeickert

Hi @urmishukla. My apologies that we haven't touched base in a very long time — this is due to me having too many conflicts of time come up and is my fault and not the result of anything you did.

should I begin to work through the Intermediate Research Software Development in Python module?

I think these fixes shouldn't take long to implement, so yeah starting work on that module would be a good idea. It should all be open and public now, but if for some reason you're paywalled let me know.

shukla/Dockerfile

matthewfeickert · 2023-04-10T07:50:58Z

shukla/Dockerfile

+	apt-get update && apt-get install make 
+
+CMD ["make", "build"] && ["make", "run"] && ["make", "clean"]


Compiling is an expensive operation which you don't want to have to do at runtime. It would be better to compile the program while building the image and then only run it at container runtime.

@urmishukla This suggestion still need to be addressed.

matthewfeickert · 2023-04-10T07:52:28Z

shukla/README.md

@@ -0,0 +1,22 @@
+1. Forked repository, cloned onto local device
+
+2. Download VSCode for Ubuntu Virtual Machine.


Along the lines of #8 (review) it would be good to get a bit more information on what the IDE setup is like. Linking to existing docs from VS Code is good too.

shukla/README.md

matthewfeickert · 2023-04-10T07:56:51Z

.pre-commit-config.yaml

We don't want to delete the existing .pre-commit-config.yaml file, but just use it instead of making a new one. So you'll want to restore this file to the state of origin/main.

Co-authored-by: Matthew Feickert <[email protected]>

matthewfeickert

@urmishukla thanks for adding the suggested changes that I had left in the last review. There are still parts of the last review that weren't addressed though, so please look at those.

If you have questions on what do to or how to address them please ask.

matthewfeickert · 2023-04-20T06:02:25Z

.pre-commit-config.yaml

@urmishukla as I mentioned in #8 (comment) you don't want to delete the file altogether.

So just

git fetch --all --prune git checkout upstream/main -- .pre-commit-config.yaml # Assuming you named the remote that you forked from "upstream"

and add that back in.

matthewfeickert · 2023-04-20T06:02:53Z

shukla/Dockerfile

+	apt-get update && apt-get install make 
+
+CMD ["make", "build"] && ["make", "run"] && ["make", "clean"]


@urmishukla This suggestion still need to be addressed.

matthewfeickert · 2023-04-26T07:32:21Z

👋 Hi @urmishukla. Did you have any questions on my comments from my previous review?

first commit

cf39c21

matthewfeickert assigned urmishukla Jan 27, 2023

Urmi Shukla added 3 commits February 6, 2023 19:46

Write simple java program

5e37b62

add Makefile to build and execute java program

396cd12

include instructions on building and running helloWorld.java

606f3b8

matthewfeickert added the enhancement New feature or request label Feb 8, 2023

Urmi Shukla and others added 4 commits February 21, 2023 02:46

add pre-commit config file

ba20805

create Dockerfile to run helloWorld.java

26b1751

update README.md with build instructions for Dockerfile

b5a1ca4

Merge branch 'main' into ukshukla

eff5bba

urmishukla marked this pull request as ready for review February 21, 2023 10:09

urmishukla closed this Feb 21, 2023

urmishukla reopened this Feb 21, 2023

matthewfeickert requested changes Mar 2, 2023

View reviewed changes

Urmi Shukla and others added 5 commits March 19, 2023 22:39

removed pre-confg file

aac0bd2

Delete .pre-commit-config.yaml

12751a5

removed pre-confg file

ca64d51

optimize dockerfile commands

ccff168

update instructions

fee3dfc

urmishukla changed the title ~~first commit~~ Setup onboarding instructions with Java Mar 20, 2023

urmishukla changed the title ~~Setup onboarding instructions with Java~~ set up working environment, with java Mar 20, 2023

edit dockerfile

9afa5cf

matthewfeickert requested changes Apr 10, 2023

View reviewed changes

urmishukla and others added 2 commits April 19, 2023 06:21

Update shukla/Dockerfile

c7dbb9d

Co-authored-by: Matthew Feickert <[email protected]>

add -rm flag

79e5fdd

Co-authored-by: Matthew Feickert <[email protected]>

matthewfeickert requested changes Apr 20, 2023

View reviewed changes

Urmi Shukla added 3 commits April 30, 2023 22:32

add pre-commit config file

6f63b06

update readme.md with vscode config

0712d26

compile makefile when building image

e9b9d22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

set up working environment, with java #8

set up working environment, with java #8

urmishukla commented Jan 26, 2023 •

edited

Loading

matthewfeickert commented Feb 10, 2023

urmishukla commented Feb 21, 2023

matthewfeickert commented Feb 22, 2023

urmishukla commented Mar 1, 2023

matthewfeickert left a comment •

edited

Loading

matthewfeickert Mar 2, 2023

matthewfeickert Mar 2, 2023

matthewfeickert Mar 2, 2023

matthewfeickert Mar 2, 2023

matthewfeickert Mar 2, 2023

matthewfeickert Mar 2, 2023

matthewfeickert commented Mar 7, 2023

urmishukla commented Mar 8, 2023

matthewfeickert commented Mar 8, 2023

urmishukla commented Mar 20, 2023

urmishukla commented Mar 31, 2023

matthewfeickert left a comment

matthewfeickert Apr 10, 2023

matthewfeickert Apr 20, 2023

matthewfeickert Apr 10, 2023

matthewfeickert Apr 10, 2023

matthewfeickert left a comment

matthewfeickert Apr 20, 2023 •

edited

Loading

matthewfeickert Apr 20, 2023

matthewfeickert commented Apr 26, 2023

	A) sudo docker image build -t urmishukla/ubuntu-java:v1 .
	A) sudo docker build -t urmishukla/ubuntu-java:v1 .

		apt-get update && apt-get install make

		CMD ["make", "build"] && ["make", "run"] && ["make", "clean"]

		@@ -0,0 +1,22 @@
		1. Forked repository, cloned onto local device

		2. Download VSCode for Ubuntu Virtual Machine.

set up working environment, with java #8

Are you sure you want to change the base?

set up working environment, with java #8

Conversation

urmishukla commented Jan 26, 2023 • edited Loading

matthewfeickert commented Feb 10, 2023

urmishukla commented Feb 21, 2023

matthewfeickert commented Feb 22, 2023

urmishukla commented Mar 1, 2023

matthewfeickert left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthewfeickert commented Mar 7, 2023

urmishukla commented Mar 8, 2023

matthewfeickert commented Mar 8, 2023

urmishukla commented Mar 20, 2023

urmishukla commented Mar 31, 2023

matthewfeickert left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthewfeickert left a comment

Choose a reason for hiding this comment

matthewfeickert Apr 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthewfeickert commented Apr 26, 2023

urmishukla commented Jan 26, 2023 •

edited

Loading

matthewfeickert left a comment •

edited

Loading

matthewfeickert Apr 20, 2023 •

edited

Loading