Finish the document
This commit is contained in:
Rui Hu
parent
d4bf67e122
commit
06665d3c1d
120
README.md
120
README.md
@ -1,93 +1,53 @@
|
||||
# Padlock
|
||||
|
||||
Welcome to stage 3 of the interview. At this stage, you're going to write a software to crack a padlock.
|
||||
|
||||
The padlock, of course, is not real, it's only a metaphor for a physical padlock, so there is no legal issues.
|
||||
|
||||
The padlock has several features:
|
||||
|
||||
1. The keys/buttons on the numpad of the padlock are used exactly once.
|
||||
This means for a 4 button padlock, code like 1234, 1324 are valid,
|
||||
but code like 1123 and 122 are invalid.
|
||||
2. The padlock is modified for you so you can operate it from Java.
|
||||
The hardware part need to do some heavy work to figure out the input buffer memory.
|
||||
So every time you write a digit of the input buffer, it takes a long time to do (almost 1 second).
|
||||
3. The test process is fast. There is no heavy work occurs when asking the padlock if the input is correct.
|
||||
4. If the input passcode is rejected (aka wrong code), the input buffer will stay untouched.
|
||||
So if 1234 is the wrong one, after test it's still 1234 in the memory.
|
||||
5. The correct passcode is chosen randomly.
|
||||
|
||||
|
||||
## Getting started
|
||||
## Your task
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
1. Implement a cracking software that will work with any number of buttons (there is at least 1 button).
|
||||
2. Try to make the process as fast as possible.
|
||||
3. Currently, the padlock is a simple Java object, but in the future we may want to connect it
|
||||
using TCP socket, RESTful API, a cli program, or something else. Please use your software
|
||||
design techniques to make your software be easier to add those features.
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
Your code should be placed in the root project, where the `padlock-impl` subproject is the actual
|
||||
implementation of the padlock.
|
||||
Please leave it untouched when you submit your work.
|
||||
|
||||
## Add your files
|
||||
You're encouraged to iterate through your solutions, just like how we solve the real world hard problems.
|
||||
Start with a simple but slow one, then figure out how to make it faster, bit by bit.
|
||||
By the end of the day, you have to choose one solution to submit even if you have multiple solutions available.
|
||||
Just like we need to choose one implementation for the production environment.
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
## Criteria
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://git.cleverthis.com/hurui200320/padlock.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
The algorithm used to crack the padlock is not that important.
|
||||
You have to write a working solution that will crack the padlock no matter how long it take.
|
||||
The faster the better, but a slow one is also acceptable.
|
||||
|
||||
## Integrate with your tools
|
||||
Proper software design techniques are also evaluated from the code.
|
||||
You shouldn't slap everything into one giant Java file.
|
||||
You should design the proper architectures for your code.
|
||||
|
||||
- [ ] [Set up project integrations](https://git.cleverthis.com/hurui200320/padlock/-/settings/integrations)
|
||||
Last but not least, readability and maintainability are also important.
|
||||
Take this project as a show off to your designing and coding skills.
|
||||
|
||||
## Collaborate with your team
|
||||
## Still have unclear problems?
|
||||
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
|
||||
## Test and Deploy
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
|
||||
***
|
||||
|
||||
# Editing this README
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
|
||||
## Suggestions for a good README
|
||||
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
Feel free to contact Jeffrey Freeman (jeffrey.freeman@cleverthis.com).
|
||||
@ -11,6 +11,10 @@ repositories {
|
||||
|
||||
dependencies {
|
||||
implementation(project(":padlock-impl"))
|
||||
// if you ever need import more dependencies, following this format:
|
||||
// implementation("group-id:project-id:version")
|
||||
// just like the logback classic
|
||||
// implementation("ch.qos.logback:logback-classic:1.5.3")
|
||||
|
||||
testImplementation(platform("org.junit:junit-bom:5.9.1"))
|
||||
testImplementation("org.junit.jupiter:junit-jupiter")
|
||||
|
||||
@ -1,12 +1,11 @@
|
||||
package com.cleverthis.interview;
|
||||
|
||||
import com.cleverthis.interview.padlock.PadlockImpl;
|
||||
import sun.reflect.generics.reflectiveObjects.NotImplementedException;
|
||||
|
||||
/**
|
||||
* This is a placeholder class showing a simple boilerplate.
|
||||
* This class is not required, so you can replace with your own architecture.
|
||||
* */
|
||||
*/
|
||||
public class Solution {
|
||||
public void solve(PadlockImpl padlock) {
|
||||
throw new RuntimeException("TODO");
|
||||
|
||||
Loading…
Reference in New Issue
Block a user