Run Code Static Check Via A Temporary Container

cd /tmp
# Get the code of sample project. It could be any repos.
# https://github.com/DennyZhang/devops_public
git clone git@github.com:DennyZhang/devops_public.git
code_dir="/tmp/devops_public"

# Dockerfile: https://github.com/DennyZhang/devops_docker_image/tree/tag_v6/codecheck
image_name="denny/pylintcheck:1.0"
container_name="pylintcheck"

ignore_file="/tmp/pylint_ignore"
cat > "$ignore_file" <<EOF
python/cleanup_old_files/cleanup_old_files.py
check_elasticsearch_shard.py
EOF

# Start container
docker run -t -d -v ${code_dir}:/code \
    -v "$ignore_file":"$ignore_file" \
    --name "$container_name" "$image_name"

# Install pip packages
docker exec -it "$container_name" \
  /usr/bin/pip install elasticsearch flask selenium

# Run the test
docker exec -it "$container_name" \
  python /enforce_pylint.py --code_dir /code --check_ignore_file "$ignore_file"

# Destroy container
docker stop "$container_name"; docker rm "$container_name"

cd /tmp
# Get the code of sample project
# https://github.com/DennyZhang/devops_public
git clone git@github.com:DennyZhang/devops_public.git
code_dir="/tmp/devops_public"

# Dockerfile: https://github.com/DennyZhang/devops_docker_image/tree/tag_v6/codecheck
image_name="denny/shellcheck:1.0"
container_name="shellcheck"

# whitelist: skip checks for certain files
ignore_file="/tmp/shellcheck_ignore"
cat > "$ignore_file" <<EOF
common_library/refresh_common_library.sh
common_library/general_helper.sh
list_os_packages.sh
EOF

# whitelist: skip some shellcheck rules
exclude_code_list="SC1090,SC1091,SC2154,SC2001,SC2002,SC2181,SC2188"

# Start container
# User docker volume: get the source code and check whitelist
docker run -t -d -v ${code_dir}:/code \
    -v "$ignore_file":"$ignore_file" \
    --name "$container_name" "$image_name"

# Run the test
docker exec -it "$container_name" \
      python /enforce_shellcheck.py \
      --code_dir /code \
      --check_ignore_file "$ignore_file" \
      --exclude_code_list "$exclude_code_list"

# Destroy container
docker stop "$container_name"; docker rm "$container_name"

(Related Reading: ShellCheck: Code Check For Shell Scripts)

cd /tmp
# Get the code of sample project
# https://github.com/DennyZhang/chef_community_cookbooks
git clone git@github.com:DennyZhang/chef_community_cookbooks.git

code_dir="/tmp/chef_community_cookbooks/cookbooks"

# Dockerfile: https://github.com/DennyZhang/devops_docker_image/tree/tag_v6/codecheck
image_name="denny/rubocopcheck:1.0"
container_name="rubocopcheck"

# Start the container
docker run -t -d --privileged -v ${code_dir}:/code \
      --name "$container_name" "$image_name"

# Run the test
docker exec -it "$container_name" \
      python /enforce_rubocopcheck.py \
      --code_dir /code

# Destroy container
docker stop "$container_name"; docker rm "$container_name"

(Related Reading: Common Rubocop Errors)

You can support more languages like this. I’m sure you’re capable for it!

So publish your solution to GitHub, once it’s ready. And share it with me, my friend.

Now we have a generic and clean solution of code static check. And it works for almost all repos. Do you agree?

To make the solution even better, I find Jenkins jobs is easier than issuing multiple docker commands.

Here is an example. (You should create your own jobs easily)

(Related Reading: 5 Reasons Why Jenkins Is So Useful And Popular)

Please leave me comments with your thoughts.

And more importantly, give it a try. And improve your projects now.

It’s just 5 minutes away!

Dockerfile for above docker images can be found in GitHub.

GitHub

More Reading:

• ShellCheck: Code Check For Shell Scripts
  
• Common Rubocop Errors
  
• Enforce Pre-check Before Deployment