Skip to content

Hardcoded no yaml #746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 29, 2025
Merged

Hardcoded no yaml #746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d0895c
Lab hardcoded: remove YAML
david-a-wheeler Jan 29, 2025
08e3e24
Clean up hardcoded.js
david-a-wheeler Jan 29, 2025
00b6488
Lab hardcoded: Move answers into JavaScript
david-a-wheeler Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 1 addition & 82 deletions docs/labs/hardcoded.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,91 +7,10 @@
<link rel="stylesheet" href="checker.css">
<script src="js-yaml.min.js"></script>
<script src="checker.js"></script>
<script src="hardcoded.js"></script>
<link rel="license" href="https://creativecommons.org/licenses/by/4.0/">

<!-- See create_labs.md for how to create your own lab! -->

<!-- Sample expected answer -->
<script id="expected0" type="plain/text">
conn = DriverManager.getConnection(url,
System.getenv("USERNAME"), System.getenv("PASSWORD"));
</script>

<!-- Full pattern of correct answer -->
<script id="correct0" type="plain/text">
\s* conn = DriverManager \. getConnection \( url \,
System \. getenv \( "USERNAME" \) \,
System \. getenv \( "PASSWORD" \) \) \; \s*
</script>

<script id="info" type="application/yaml">
---
hints:
- absent: |
^ \s* conn = DriverManager \. getConnection \( url \,
text: >
Your answer should start with
`conn = DriverManager.getConnection( url,`
just as the initial value did. You might want to use the `Reset` button.
- absent: |
System \. getenv
text: >
Use `System.getenv` to retrieve an environment variable value.
For example, use `System.getenv("USERNAME")` to retrieve the username.
- present: |
System \. getenv \( \"admin\" \)
text: >
You need to pass to
`System.getenv` the name of an environment variable value, not the
result you might get.
Do not use constructs like `System.getenv("admin")`.
Instead, for example,
use `System.getenv("USERNAME")` to retrieve the username.
- absent: |
System \. getenv \( \"PASSWORD\" \)
text: >
Use `System.getenv` to retrieve an environment variable value.
For example, use `System.getenv("USERNAME")` to retrieve the username.
- present: "admin"
text: >
The term 'admin' should not be in your code.
You should be retrieving both the username and the password
from somewhere else, in this case, from environment variables.
- present: |
(system|Getenv|GetEnv)
text: >
Java is case-sensitive. You need to use
`System.getenv` and not some other variation of uppercase or lowercase.
- absent: |-
\; \s* $
text: >
Java statements must end with a semicolon.
- absent: |
\) \) \; \s* $
text: >
Double-check your closing parentheses at the end of the statement.
- present: |
new\s+String
text: >
You do not need to construct a new string to retrieve an
environment variable value.
- present: |
^ conn = DriverManager \. getConnection \( url \) \; \s* $
text: >
In some sense this is correct, as long as the url is not hardcoded.
However, it's often better if administrators can easily change the
username or password separately, and it makes out point clearer.
Please provide the username and password and separate values.
- present: |
^ \s* conn = DriverManager \. getConnection \( url \,
System \. getenv \( "PASSWORD" \) \,
System \. getenv \( "USERNAME" \) \) \; \s* $
text: >
The order of parameters is wrong. Provide the url, then the username,
then the password. You're providing the url, then the password, then
the username, which swaps the second and third parameters.
# debug: true
</script>
</head>
<body>
<!-- For GitHub Pages formatting: -->
Expand Down
60 changes: 60 additions & 0 deletions docs/labs/hardcoded.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
info =
{
hints: [
{
absent: String.raw`^ \s* conn = DriverManager \. getConnection \( url \,`,
text: "Your answer should start with `conn = DriverManager.getConnection( url,` just as the initial value did. You might want to use the `Reset` button."
},
{
absent: String.raw`System \. getenv`,
text: "Use `System.getenv` to retrieve an environment variable value. For example, use `System.getenv(\"USERNAME\")` to retrieve the username."
},
{
present: String.raw`System \. getenv \( \"admin\" \)`,
text: "You need to pass to `System.getenv` the name of an environment variable value, not the result you might get. Do not use constructs like `System.getenv(\"admin\")`. Instead, for example, use `System.getenv(\"USERNAME\")` to retrieve the username."
},
{
absent: String.raw`System \. getenv \( \"PASSWORD\" \)`,
text: "Use `System.getenv` to retrieve an environment variable value. For example, use `System.getenv(\"USERNAME\")` to retrieve the username."
},
{
present: "admin",
text: "The term 'admin' should not be in your code. You should be retrieving both the username and the password from somewhere else, in this case, from environment variables."
},
{
present: "(system|Getenv|GetEnv)",
text: "Java is case-sensitive. You need to use `System.getenv` and not some other variation of uppercase or lowercase."
},
{
absent: String.raw`\; \s* $`,
text: "Java statements must end with a semicolon."
},
{
absent: String.raw`\) \) \; \s* $`,
text: "Double-check your closing parentheses at the end of the statement."
},
{
present: String.raw`new\s+String`,
text: "You do not need to construct a new string to retrieve an environment variable value."
},
{
present: String.raw`^ conn = DriverManager \. getConnection \( url \) \; \s* $`,
text: "In some sense this is correct, as long as the url is not hardcoded. However, it's often better if administrators can easily change the username or password separately, and it makes out point clearer. Please provide the username and password and separate values."
},
{
present: String.raw`^ \s* conn = DriverManager \. getConnection \( url \,
System \. getenv \( "PASSWORD" \) \,
System \. getenv \( "USERNAME" \) \) \; \s* $`,
text: "The order of parameters is wrong. Provide the url, then the username, then the password. You're providing the url, then the password, then the username, which swaps the second and third parameters."
}
],
expected: [
`conn = DriverManager.getConnection(url,
System.getenv("USERNAME"), System.getenv("PASSWORD"));`
],
correct: [
String.raw`\s* conn = DriverManager \. getConnection \( url \,
\s* System \. getenv \( "USERNAME" \) \,
\s* System \. getenv \( "PASSWORD" \) \) \; \s*`
],
}