• This repository has been archived on 25/Mar/2019
  • Stars
    star
    128
  • Rank 281,044 (Top 6 %)
  • Language
    Ruby
  • License
    Other
  • Created over 9 years ago
  • Updated over 7 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Automatically check if anything is wrong with the code in a pull request

Dokumi

Dokumi is a tool created to automatically check if anything is wrong with the code in a pull request. More details in the following blog article:

Automatic code review is its main feature, but it can also be used to automatically build an application an send it to a service like DeployGate or HockeyApp.

As explained in the LICENSE file, Dokumi is under the MIT license.

How to set it up

Requirements

  • Ruby 2.0 or better (it might work with 1.9) with bundler installed.
  • For building an application with Xcode, the machine running Dokumi must be running OS X and have Xcode installed.
  • The machine running Dokumi must be able to clone repositories from the GitHub server.

Environment setup

The GitHub Enterprise settings are in config/github.yml. You should start with config/github.yml.sample. You can easily create an access token in your GitHub's profile settings, in "Personal access tokens" (depending on your version of GitHub, "Personal access tokens" might be in "Applications"). That token should be able to get information about repositories and post comments in issues and pull requests. For testing purpose, using you personal account is fine, but I highly recommend you create a different account for your CI, as the comments posted by Dokumi will be under the name of the account used to create the token.

For projects using Xcode, there is also a config/xcode_versions.yml settings file for specifying the Xcode versions you have installed on your machine. It will be generated with default settings the first time you do an Xcode build, but you can also create your own starting from config/xcode_versions.yml.sample. Once this settings file is created, changing the system's default Xcode using xcode-select will not change the path to the version of Xcode used.

For Android projects, you also have a android.yml settings file.

To check if your environment is set-up properly, you can first try running the tests before making your own build script.

Build scripts

Once the environment setup is done, you need a script to build your application and review the pull requests. For that, first create a custom/build directory. I highly recommend you create a Git repository for managing the content of your custom directory.

When reviewing or building your code, Dokumi will first clone the repository into source/host/owner/repo (host, owner and repo will be of course the host, owner and the name of the repository). Then it will search for the build script for that repository. It will first look for custom/build/host/owner/repo.rb, and if it does not exist it will try using custom/build/host/fallback.rb and then try custom/build/fallback.rb.

Here is a sample build script: (you need of course to change the value of to_build and also maybe scheme)

to_build = "MyProject.xcworkspace"
scheme = "MyProject" # In Xcode the scheme must have been marked as shared.

xcode.install_pods if File.exist?("Podfile") # Not needed if the content of your Pods directory is stored in the repository.

case action
when :review
  xcode.find_unchanged_storyboards
  xcode.analyze to_build, scheme: scheme
  unless error_found?
    xcode.test(to_build, scheme: scheme, destination: [
      "platform=iOS Simulator,OS=8.4,name=iPhone 4s",
      "platform=iOS Simulator,OS=8.4,name=iPhone 6",
    ])
  end
when :archive
  xcode.archive to_build, scheme: scheme
  artifacts.each do |artifact_path|
    Support.logger.info "#{artifact_path} should be uploaded or copied somewhere"
  end
else
  raise "unknown action #{action.inspect}"
end

action correspond to the command used to run Dokumi: either :review or :archive. The script also has access to the options given to the command line in the options hash (its keys are symbols).

For more information about build scripts, have a look at doc/about_build_scripts.md.

If you have a problem, have a look at doc/FAQ.md.

How to run it

First you need to make sure you have all the required gems installed:

bundle install

Then to review a pull request:

bundle exec bin/review https://host/owner/repo/pull/xxx --option1=value1 --option2=value2 ...

or

bundle exec bin/review host owner repo pull-request-number --option1=value1 --option2=value2 ...

The host can be of course github.com.

option1, option2 are optional.

To build an application you also have the bin/archive command.

Run the tests

First you need to make sure you have all the required gems installed:

bundle install

Then to run the iOS tests:

bundle exec test/review_xcode_project.rb

Supported analysis tools

iOS

Android

How to use Dokumi with Jenkins

If you are using the GitHub pull request builder plugin, making it executing the following might be enough:

set -e
DOKUMI_DIRECTORY=/path/to/dokumi

cd "${DOKUMI_DIRECTORY}"
bundle exec bin/review "${ghprbPullLink}"

with DOKUMI_DIRECTORY set to the proper path.

If you have any signing problem, have a look at doc/FAQ.md.

More Repositories

1

styleguide

Cookpad's coding style guides
1,173
star
2

chanko

Rapidly and safely prototyping your rails application
Ruby
636
star
3

garage

Rails extension for RESTful Hypermedia API
Ruby
511
star
4

kage

Kage (kah-geh) is a shadow proxy server to duplex HTTP requests
Ruby
503
star
5

rrrspec

Distributed RSpec
Ruby
490
star
6

puree-android

A log collector for Android
Java
480
star
7

license-tools-plugin

Gradle plugin to check library licenses and generate license pages.
HTML
331
star
8

arproxy

Arproxy is a proxy between ActiveRecord and database adapter
Ruby
326
star
9

kuroko2

Kuroko2 is a web-based job scheduler / workflow engine.
Ruby
313
star
10

expeditor

Expeditor provides asynchronous execution and fault tolerance for Microservices
Ruby
231
star
11

omniauth-rails_csrf_protection

Provides CSRF protection on OmniAuth request endpoint on Rails application.
Ruby
227
star
12

Puree-Swift

🍯 Awesome log aggregator for iOS
Swift
217
star
13

barbeque

Job queue system to run job with Docker
Ruby
196
star
14

LicenseToolsPlugin

Gradle plugin to check library licenses and generate license pages for Android
HTML
174
star
15

grpc_kit

A kit for creating gRPC server/client in Ruby.
Ruby
161
star
16

puree-ios

[Obsoleted] A log collector for iOS (new version! -> https://github.com/cookpad/Puree-Swift)
Objective-C
149
star
17

dmemo

Ruby
130
star
18

s3ar

A massively fast S3 downloader/uploader
Rust
113
star
19

griffin

gRPC server and client for Ruby
Ruby
102
star
20

android-code-style

Cookpad Android Code Style
Java
89
star
21

elasticfox-ec2tag

Patched Elasticfox (for EC2 Tag) branched from http://aws.amazon.com/developertools/609 and provide standalone version based on http://code.google.com/p/efoxapp/. ELB Tab from hybridfox http://code.google.com/p/hybridfox/
JavaScript
78
star
22

cookpad-pad

Cookpad Pad — A six keys macro pad made by Cookpad.
73
star
23

trice

Provides reference time concept to application. Use it instead of ad-hoc `Time.now`.
Ruby
72
star
24

terraform-aws-eks

A Terraform module to Provision AWS Elastic Kubernetes (EKS) clusters and worker nodes
HCL
70
star
25

global-style-guides

Official style guides for Cookpad Global
66
star
26

issue-reporter-android

Java
61
star
27

cookpad-internship-2015-summer

http://techlife.cookpad.com/entry/2015/09/08/113442
60
star
28

mixed_gauge

A simple and robust database sharding with ActiveRecord.
Ruby
58
star
29

garage_client

Ruby client library for the Garage application API
Ruby
53
star
30

aws-xray

The unofficial AWS X-Ray Tracing SDK for Ruby
Ruby
50
star
31

blouson

Filter tools to mask sensitive log data for rails
Ruby
49
star
32

presentations

The presentations of Cookpad staff
Ruby
48
star
33

deepalert

Serverless SOAR (Security Orchestration, Automation and Response) framework for automatic inspection and evaluation of security alert
Go
44
star
34

pendaxes

Send reminder to developers about their left pending tests!
Ruby
43
star
35

BottomNavWatson

Bottom navigation bar library that allows multiple back stacks and one single navigation graph
Kotlin
40
star
36

cookpad-internship-2016-summer

Docs and materials at Cookpad Internship 2016 Summer
Ruby
39
star
37

react-native-puree

A log collector for React Native
TypeScript
39
star
38

gradle-android-sdk-manager

DEPRECATED
39
star
39

murakumo

Murakumo is the internal DNS server which manages name information using a gossip protocol.
Ruby
38
star
40

RxT4A

DEPRECATED
Java
38
star
41

tokite

Ruby
35
star
42

r53-fox

AWS Route53 GUI client
JavaScript
31
star
43

daifuku

A markdown parser and compiler for log definitions in mobile applications
Ruby
31
star
44

android-crud-paging-v3

Kotlin
30
star
45

kumonos

Moved to https://github.com/cookpad/itacho
Ruby
30
star
46

itacho

itacho to manage and operate envoy based service mesh.
Go
28
star
47

gem_collector

Collect gems used by applications
Ruby
27
star
48

iam-fox

AWS IAM GUI client
JavaScript
26
star
49

sds

Envoy's v1 Service Discovery Service API and v2 Endpoint Discovery Service API
Rust
24
star
50

ViewsWaiter

A reactive approach for updating views that you don't view
Kotlin
23
star
51

streamy

Basic toolset for hooking into event stream
Ruby
22
star
52

cpc1.0

Cookpad Parsed Corpus: a dataset of linguistically annotated recipes (Linguistic Annotation Workshop 2020)
Python
21
star
53

denv

Loads environment variables to `ENV` from `.env` file
Ruby
19
star
54

guard_against_physical_delete

guard_against_physical_delete is monkey patch for ActiveRecord. This patch prevent deleting record physically.
Ruby
19
star
55

2018-newgrads-engineer-portfolio

クックパッド 2018 年度新卒採用選考エントリーシート提出方法と、その時に利用するファイル一式です。
19
star
56

OkReport

Android library to submit reports without leaving the app.
Kotlin
18
star
57

cp8_cli

Cookpad Global CLI
Ruby
18
star
58

cookpad-internship-2019-summer

Swift
18
star
59

armg

Add MySQL geometry type to Active Record.
Ruby
18
star
60

StringsPatcher

An android lib for updating string resources on the fly
Kotlin
14
star
61

sisito

It is sisimai collected data frontend.
Ruby
14
star
62

rgossip2

Basic implementation of a gossip protocol. This is a porting of Java implementation. see http://code.google.com/p/gossip-protocol-java/
Ruby
13
star
63

Phakchi

Pact consumer client library in Swift
Swift
13
star
64

ecamo

SSL image proxy with JWT authentication
Rust
12
star
65

janiConverter

Online transcoder: from movie file to jani-format. Supports VAST integration
Ruby
12
star
66

session_store_relocator

Supports Rails session store relocation with duplicate write session data to multiple stores
Ruby
11
star
67

cookpad-internship-2017-summer

Jupyter Notebook
11
star
68

reuse_query_results

reuse mysql query results
Ruby
11
star
69

onesky-gradle-plugin

Kotlin
11
star
70

techconf2017-network

Ruby
10
star
71

aws-falcon-data-forwarder

CrowdStrike Falcon log forwarder from falcon S3 bucket to your S3 bucket
Go
10
star
72

cookpad-internship-2018-summer

Ruby
10
star
73

raven-transports-fluentd

Send error logs to sentry via fluentd
Ruby
10
star
74

prism

Streaming loader for Amazon Redshift Spectrum
Java
10
star
75

2016-internship-engineer-portfolio

クックパッド 2016 インターンの応募方法と、その時に利用するファイル一式です。
9
star
76

2017-internship-engineer-portfolio

クックパッド サマーインターンシップ 2017 への応募方法についての説明です。
9
star
77

minerva

Serverless Log Search Architecture for Security Monitoring based on Amazon Athena
Go
8
star
78

oicy-taste

design information of condiment dispenser "OiCy Taste"
C++
8
star
79

swift-user-defaults

A series of Swift friendly utilities for Foundation's UserDefaults class.
Swift
8
star
80

spring-internship-2021-lecture-code

TypeScript
7
star
81

dango

A service for managing i18n
Elixir
6
star
82

garage-doorkeeper

Garage extension to integrate doorkeeper gem
Ruby
5
star
83

griffin-interceptors

Ruby
5
star
84

cookpad_departure_defaults

Ruby
5
star
85

cookpad-internship-2020-summer-ios

Swift
4
star
86

android-studio-templates

Provides a set of templates for scaffolding architectural repetitive tasks.
Kotlin
4
star
87

cookpad-performance

Some performance tools we use across our Rails applications
Ruby
4
star
88

cookpad-internship-2020-summer-web

Ruby
4
star
89

barbeque_client

barbeque client for Ruby
Ruby
4
star
90

wait-side-car

Wait essential side-car containers to be available.
Go
4
star
91

rsolr_cookpad

A Ruby client for Apache Solr (saving weights of the repository by cutting down disused branches and tags)
Ruby
3
star
92

cookpad-internship-2021-summer-ios

Swift
3
star
93

package-scanner-android

WIP
Java
3
star
94

mirin

Redirection Service
Haskell
3
star
95

cookpad_mysql_defaults

Cookpad's MySQL defaults
Ruby
3
star
96

cookpad-internship-1day-ruby

Ruby
3
star
97

SocialConnect

OAuth library for Android: retrieves OAuth tokens from multiple social networks.
Kotlin
3
star
98

github-app-installation-token-action

A GitHub Action that can be used to generate scoped credentials for use within your workflow using an App integration.
JavaScript
3
star
99

bitrise-step-github-app-installation-token

Go
2
star
100

rubyists-on-rails

Passenger Announcement for Rubyists on Rails.
2
star