devkitkat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ed6fa28306bb394d6f6128300d955ce43eacd9ca81c6a06abe9ac29ea3232f0
+  data.tar.gz: 681ffd8da74c5a2f64e5e118caad29a15a7b99e92c8a7b21da0b9f5329d220ea
+SHA512:
+  metadata.gz: a8648ee8040928383c3e5129a4faa1d82233dd54a42cd71f7bf7273c532e3458212877e1f691229ae44172413d646f131bb11b695c6e58ff67774f412f82ee5e
+  data.tar.gz: f4f857bd6f21acc44e29ba53e1819638afa3a82bac2691592b7692e3e5a1897a238224280e376c294f55ae6e757939e7a8ff68a515640c75539a5eff2c4ddd67

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+services
+.devkitkat.yml

data/.gitlab-ci.yml

@@ -0,0 +1,15 @@
+image: ruby:2.6
+
+rspec:
+  stage: test
+  variables:
+    LANG: C.UTF-8
+    LC_ALL: C.UTF-8
+  before_script:
+  - apt-get update
+  - apt-get install -y cmake
+  - locale
+  - locale -a
+  script:
+  - bin/setup
+  - bundle exec rspec

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shinya@gitlab.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in devkitkat.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    devkitkat (0.1.0)
+      activesupport (~> 6.0.0)
+      colorize (~> 0.8.1)
+      docker-api (~> 1.34.2)
+      parallel (~> 1.17.0)
+      ruby-progressbar (~> 1.10.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    coderay (1.1.2)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docker-api (1.34.2)
+      excon (>= 0.47.0)
+      multi_json
+    excon (0.67.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.12.2)
+    multi_json (1.13.1)
+    parallel (1.17.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rspec-temp_dir (1.1.0)
+      rspec (>= 3.0)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  devkitkat!
+  pry (~> 0.12.2)
+  pry-nav
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-temp_dir (~> 1.1.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Shinya Maeda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,250 @@
+[![pipeline status](https://gitlab.com/dosuken123/devkitkat-cicd/badges/master/pipeline.svg)](https://gitlab.com/dosuken123/devkitkat-cicd/commits/master)
+
+# Devkitkat
+
+Devkitkat is a framework for development kits. It lets you
+bootstrap separate services for running a complex application easily.
+This is especially helpful for local development that runs/compiles everything from source code.
+
+## Features
+
+This tool provides the following features:
+
+- Easy configuration, easiser than docker-compose.
+- Customizable/Flexible scripts for controlling services.
+- Logging command output dy default.
+- Respect the best practice architecture of Cloud Native.
+- Easy to run services in containers (Not available yet).
+- Distrubte machine resources to the cloud VM (Not available yet).
+- No more Makefile for orchestrating services.
+
+## The only config file - `.devkitkat.yml`
+
+The only config file `.devkitkat.yml` has to be placed at the root directory where you want to
+download/prepare services. These are available keys.
+
+|Key                                         |Type        |Required|Default|Description|
+|---                                         |---         |---     |---|---|
+|`application:`                              |String      |Yes     |-|The name of the application that consists of the services|
+|`environment:type:`                         |String      |Yes     |-|The type of the environment. One of `local`, `docker` or `cloud`. Default is `local`.|
+|`environment:image:`                        |String      |Yes     |-|The docker image. Only effective when `type` is `docker` or `cloud`|
+|`services:`                                 |Hash        |Yes     |-|The services to run the application|
+|`services:<name>`                           |Hash        |Yes     |-|The service name e.g. `rails`, `db`, `redis`|
+|`services:<name>:repo: <value>`             |String      |No      |-|The git URL of the repository|
+|`services:<name>:<key>: <value>`            |Hash        |No      |-|The key and value of the environment variable. e.g. `POSTGRES_PASSWORD: abcdef`. |
+|`groups:`                                   |Hash        |No      |-|The groups of the services|
+|`groups:<name>: <service-names>`            |Hash        |No      |-|The name of the group and the service names|
+
+There are pre-occupied special keys, please do not use these keys in your config file: `services:system`, `services:self`
+
+## Sample `.devkitkat.yml`
+
+```yaml
+application: awesome-app
+
+environment:
+  type: local
+
+services:
+  web:
+    repo: https://gitlab.com/gitlab-org/gitlab-ce.git
+    port: 1234
+  db:
+    port: 9999
+```
+
+## Devkitkat image
+
+When you run your application with docker containers, you might need to write up
+[Dockerfile](https://docs.docker.com/engine/reference/builder/) and build the image at first,
+this often is time consuming and repeatable task.
+To avoid this cumbersome step, devkitkat provides some useful pre-built machines, which
+works with your application on the fly.
+These images are defined in devkitkat as a ruby script and easy to customize/extend.
+If you don't find useful machines, you can still define it in `services/<name>/dockerfile` directory,
+however, please consider contributing to this repository for the other people who
+would be stuck into the same pitfall/situation.
+
+- `Devkitkat::Environment::Image::CommonRubyOnRails`
+  - `author`
+  - `homepage`
+  - etc
+
+## Service structure
+
+Each service is stored in the following directories:
+
+|Path                               |Description|
+|---                                |---|
+|`services/<name>/src/`| The directory for source code of the service |
+|`services/<name>/script/`| The directory for scripts that controls the service e.g. start, stop, etc.|
+|`services/<name>/data/`| The directory for storing permanent data e.g. database.|
+|`services/<name>/cache/`| The directory for storing ephemeral data to optimize service boot.|
+|`services/<name>/log/`| The directory for logged console output.|
+|`services/<name>/example/`| The directory for extra example scripts that shouldn't be managed in the source repository. |
+|`services/<name>/dockerfile/`| The directory for the docker file that builds the image for the service|
+
+## How to write scripts
+
+Since your service's startup command could vary per your application preference,
+you have to define start/stop/configure/etc scripts manually.
+
+You can add a script with the following command `devkitkat add-script --name=<name> <target>`.
+It creates a script file at `services/<name>/script/<name>`, and you
+have to code the script details.
+
+As the best practice, you should initialize a script dir at first, to do so, execute
+`devkitkat add-script --basic <target>`. It adds the following basic scripts that you'd need
+
+- configure/unconfigure ... Configure/Unconfigure the service (Typically, initializes the config file, etc)
+- start/stop ... Start/Stop the service
+
+So you might want to execute `devkitkat add-script --basic all` after you've prepared
+.devkitkat.yml. After you write up the commands, you can execute scripts with a command
+like `devkitkat rails configutre` or `devkitkat php start`.
+
+You can also define system scripts that does not belong to a specific service.
+There is a handy command `devkitkat add-script <name> system` and it adds a script to `services/system/script` dir.
+. For the system script execution, you can ommit `<target>` from
+the command line e.g. `devkitkat add-test-domain` will work instead of `devkitkat add-test-domain system`. 
+As always, log files are stored in `services/system/log` (See more [Service structure](#service-structure))
+
+### Shared script
+
+You can create a shared script to be included in service scripts. To do so,
+execute:
+
+```
+devkitkat add-shared-script
+```
+
+This adds `shared` script under `services/system` directory. You can define a
+shared function in the script.
+
+To include the shared script, you need to update your service script as the following:
+
+```shell
+#!/bin/bash
+source ${MI_SYSTEM_SCRIPT_SHARED_DIR}
+
+# Call a function defiend in the `shared` script
+```
+
+## Predefined scripts
+
+Devkitkat provides predefined scripts that are useful in common development scenarios.
+
+|Script name    |Available options        |Description|
+|---            |---                      |---|
+|`clone`        |`GIT_DEPTH` ... Speicify git-depth|Clone source code from the `services:<name>:repo:`|
+|`pull`         |`GIT_DEPTH` ... Speicify git-depth|Pull source code from the `services:<name>:repo:`|
+|`download`     |N/A                      |Download source code from the `services:<name>:repo:`|
+|`clean`        |N/A                      |Remove all files from `data`, `cache`, `log` and `src` dirs|
+|`docker-build` |`TAG`                    |Build a docker image|
+|`docker-push`  |`REGISTRY`               |Push a docker image|
+|`add-user`     |`TAG`                    |Add a user to the current system (It's useful for containerized images)|
+|`add-script`   |`--basic`                |Add a script to services|
+|`poop`         |N/A                      |:poop:|
+
+## Predefined group names
+
+- `all` ... All defined services in `.devkitkat.yml`
+
+## Predefined variables
+
+Devkitkat inject these predefined variables into the scripts by default.
+
+- `MI_<service>_DIR` ... The root directory path of the service.
+- `MI_<service>_SCRIPT_DIR` ... The script directory path of the service.
+- `MI_<service>_SRC_DIR` ... The source directory path of the service.
+- `MI_<service>_CACHE_DIR` ... The cache directory path of the service.
+- `MI_<service>_DATA_DIR` ... The data directory path of the service.
+- `MI_<service>_LOG_DIR` ... The log directory path of the service.
+- `MI_<service>_EXAMPLE_DIR` ... The example directory path of the service.
+- `MI_<service>_<key>` ... The value of the user-defined variable.
+
+NOTE:
+ - User-defined variables are injected with the bare name. e.g. If you define
+   `VERSION: 1`, then you get the value with `echo $VERSION`. From the other services,
+   the variable can be fetched as `MI_<service>_<key>`.
+ - `service` is the *uppercase* service *name*. e.g. if the service name is
+  `rails`, `MI_RAILS_DIR` is the root directory path of the service.
+ - `key` is *uppercase* e.g. `MI_RAILS_HOST`
+ - You can also use `SELF` instead of specifying a service name.
+   The `SELF` indicates that it's a context specific parameter, for example,
+   if you run a script for `workhorse` service, `MI_SELF_DIR` is `services/workhorse`,
+   on the other hand, if you run a script for `gitaly` service, `MI_SELF_DIR` is `services/gitaly`.
+
+## How to control services via scripts
+
+Basically, command execution follows the below convention.
+
+`devkitkat <script-name> <target - service name or group name>`
+
+For example, if you want to start `rails` service, your command would look like
+
+`devkitkat start rails`
+
+, Or, if you want to start all services belong to the `backend` group,
+
+`devkitkat start backend`
+
+, Or, if you want to pass multiple services, use comma separated service names,
+
+`devkitkat start rails,postgres,redis`
+
+, Or, if you want to exclude a specific service from a group, use `--exclude` option,
+
+`devkitkat start backend --exclude redis`
+
+## Sample commands
+
+```
+devkitkat pull default                          # Pull source code for the default group
+devkitkat configure default                     # It configures source code for the default group
+devkitkat start postgresql,redis,gitaly         # It starts `postgresql`, `redis` and `gitaly` services.
+devkitkat seed rails                            # It Seeds for `rails` service
+devkitkat start default                         # It starts services of the `default` group
+```
+
+## Options for `devkitkat`
+
+- `--path /path/to/the` ... The root directory that contains `.devkitkat.yml` and manage the service dirs.
+- `--variables KEY=VAR` ... The additional environment variables for services.
+- `--exclude <name>` ... The excluded service from the group.
+
+Example:
+
+`devkitkat start rails --path $HOME/awesome-app-dev-kit/ --variables AWS_CRED=XXXXX`
+
+## Installation
+
+    $ gem install devkitkat
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Tips
+
+**Execute only fast tests**
+
+`bundle exec rspec /home/shinya/workspace/devkitkat/spec/devkitkat_spec.rb -t ~slow`
+
+**Execute only slow tests**
+
+`bundle exec rspec /home/shinya/workspace/devkitkat/spec/devkitkat_spec.rb -t slow`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dosuken123/devkitkat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Devkitkat project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/devkitkat/blob/master/CODE_OF_CONDUCT.md).