https://github.com/ocp-devspaces-gamification/ds-challenge-03
https://github.com/ocp-devspaces-gamification/ds-challenge-03
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ocp-devspaces-gamification/ds-challenge-03
- Owner: ocp-devspaces-gamification
- Created: 2024-10-08T22:18:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-19T06:49:05.000Z (over 1 year ago)
- Last Synced: 2025-05-22T11:17:11.094Z (about 1 year ago)
- Language: HTML
- Size: 819 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Challenge-03
### Scenario
* Lets continue to enhance the ds-challenge-02
* So far we have done consistent way of creating tooling and extensions. Let's take a step further by enhancing this to create consistent way to build, package, run the programs and also creating standardized end points
### Set Up + verification
* It's time to create standardized commands. You will create two commands in devfile.yaml
* Create 1st command with id "package" and label (1. Package the application) inside devfile to execute below command
```bash
./mvnw package
```
* Create 2nd command with id "livecoding" and lable (2. Start Development mode) inside devfile to execute below command
```bash
./mvnw compile quarkus:dev
```
* Leverage the Resources section and find how you can create commands in devfile.yaml
* Creating Two Endpoints in "tools" container of the devfile
* The "src/main/java/org/acme/GreetingResource.java" has restful endpoints :
* localhost:8080
* localhost:8080/api/hello
* localhost:8080/api/greet/#input
* Create 1st endpoint for "/api/hello" [with name="greet-attendee"]
* Create 2nd endpoint for the root "/" [with name=base-challenge]
* Leverage the Resources section and find how you can create endpoints
* Once you complete the above, reload the devspaces [Click the Arrows symbol(><) in the Bottom Left corner to open a new menu] with option "Restart Workspace from Local Devfile".
* In devspaces, Open a terminal. Run the below command to change the mvnw file to be executable
```bash
chmod 755 mvnw
```
* Run the command "1. Package the application" first. See success criteria on how to run the command
* Run the quarkus application using command "2. Start Development mode" you created in devfile.
* Select your option "y/n" to the question (if asked) : Do you agree to contribute anonymous build time data to the Quarkus community?
* If things don't look OK, delete the workspace, update the devfile directly in source control and recreate the workspace
### Success Criteria
* Commands are created and can be invoked via the "Hamburger Icon --> Terminal --> Run Task --> Devfile --> Select #Commands"
* Endpoints (shown in the bottom left corner of the IDE) can be invoked when live coding is ON
* Invoking "base-challenge" endpoint displays an image of the "Developer Flow"
* Invoking "greet-attendee" endpoint (or executing below command in the terminal) displays a response "Hello Challenge Attendees"
```bash
curl localhost:8080/api/hello
```
### Resources
* https://devfile.io/docs/2.2.2/adding-commands
* https://devfile.io/docs/2.2.2/defining-endpoints
* https://devfile.io/docs/2.2.2/devfile-schema
### What did we learn?
* OpenShift DevSpaces reduces the Developers pain points. As a Developer, your life is getting simpler with the below
* Automatic Extensions (Language Support for Java(TM) by Red Hat) inclusion
* Now we have consitent endpoints and commands. This makes iterative development faster (no more typing commands and or finding endpoints via code)
* The next developer will know exactly how things are done making it a much better experience
* One of the core functions of development is to Test & Debug code. In the next challenge, we will explore debugging inside DevSpaces