Merge pull request #102 from PLUS-POSTECH/general-improvements

General improvements

Author: KSAlpha

Cargo.lock

@@ -1,14 +1,20 @@
 [package]
 name = "soma"
 version = "0.1.0"
-authors = ["Yechan Bae <qwazpia@gmail.com>", "Kangsu Kim <pica744@gmail.com>"]
 edition = "2018"
+authors = ["Yechan Bae <qwazpia@gmail.com>", "Kangsu Kim <pica744@gmail.com>"]
+license = "MIT OR Apache-2.0"
+description = "Your one-stop CTF problem management tool"
+repository = "https://github.com/PLUS-POSTECH/soma"
+keywords = ["ctf", "hacking"]
+categories = ["command-line-utilities", "config"]
+readme = "README.md"
 
 
 [dependencies]
-bollard = "0.1.3"
+bollard = "0.2.0"
 clap = "~2.32.0"
-crossterm = "0.5.5"
+crossterm = "0.6.0"
 dirs = "1.0.4"
 failure = "0.1.5"
 flate2 = "1.0.6"

Cargo.toml

@@ -80,8 +80,8 @@ Soma team is hoping to ship it in the first quarter of 2019.
 
 * Install Rust stable toolchain.
 * Install `openssl` (Required by `openssl-sys` crate).
-* Install `rustfmt`.
-    * `rustup component add rustfmt`
+* Install `clippy` and `rustfmt`.
+    * `rustup component add clippy rustfmt`
 * Copy files in `hooks` directory to `.git/hooks`.
 
 

README.md

@@ -10,16 +10,18 @@ resources:
     image: rust:latest
 
 jobs:
-- job: style_check
-  displayName: Code Style Check
+- job: quality_check
+  displayName: Code Quality Check
   pool:
     vmImage: 'ubuntu-16.04'
   container: rust
   steps:
-  - script: rustup component add rustfmt
-    displayName: 'Install rustfmt'
+  - script: rustup component add clippy rustfmt
+    displayName: 'Install Prerequisites'
   - script: cargo fmt --all -- --check
-    displayName: 'Check code style'
+    displayName: 'Check Formatting'
+  - script: cargo clippy --all-targets --all-features -- -D warnings
+    displayName: 'Run Lint'
 
 - job: linux_build
   displayName: Linux Build

azure-pipelines.yml

@@ -1,13 +1,13 @@
 #!/bin/bash
 
 # Copyright 2016 Google Inc. All Rights Reserved.
-# Modified by PLUS Owl team
+# Modified by PLUS Soma team
 #
 # Licensed under the MIT License, <LICENSE or http://opensource.org/licenses/MIT>.
 # This file may not be copied, modified, or distributed except according to those terms.
 
 #
-# Pre-commit hook for the tarpc repository. To use this hook, copy it to .git/hooks in your
+# Pre-commit hook for the Soma repository. To use this hook, copy it to .git/hooks in your
 # repository root.
 #
 # This precommit checks the following:
@@ -59,25 +59,20 @@ else
 fi
 
 printf "${PREFIX} Checking for rustfmt ... "
-command -v cargo fmt &>/dev/null
-if [ $? == 0 ]; then
-    printf "${SUCCESS}\n"
-else
+command -v cargo-fmt &>/dev/null
+if [ $? != 0 ]; then
     printf "${FAILURE}\n"
     exit 1
+else
+    printf "${SUCCESS}\n"
 fi
 
 # Just check that running rustfmt doesn't do anything to the file. I do this instead of
 # modifying the file because I don't want to mess with the developer's index, which may
 # not only contain discrete files.
 printf "${PREFIX} Checking formatting ... "
-FMTRESULT=0
 diff="$(cargo fmt --all -- --check)"
-if grep --quiet "at line" <<< "$diff"; then
-    FMTRESULT=1
-fi
-
-if [ ${FMTRESULT} != 0 ]; then
+if [ $? != 0 ]; then
     FAILED=1
     printf "${FAILURE}\n"
     echo "$diff"

hooks/pre-commit

@@ -0,0 +1,49 @@
+#!/bin/bash
+
+# Copyright 2016 Google Inc. All Rights Reserved.
+# Modified by PLUS Soma team
+#
+# Licensed under the MIT License, <LICENSE or http://opensource.org/licenses/MIT>.
+# This file may not be copied, modified, or distributed except according to those terms.
+
+#
+# Pre-push hook for the Soma repository. To use this hook, copy it to .git/hooks in your
+# repository root.
+#
+# This prepush checks the following:
+# 1. clippy is installed
+# 2. clippy suggests nothing on code
+
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[0;33m'
+NC='\033[0m' # No Color
+
+PREFIX="${GREEN}[PREPUSH]${NC}"
+FAILURE="${RED}FAILED${NC}"
+WARNING="${RED}[WARNING]${NC}"
+SKIPPED="${YELLOW}SKIPPED${NC}"
+SUCCESS="${GREEN}ok${NC}"
+
+FAILED=0
+
+printf "${PREFIX} Checking for clippy ... "
+command -v cargo-clippy &>/dev/null
+if [ $? != 0 ]; then
+    printf "${FAILURE}\n"
+    exit 1
+else
+    printf "${SUCCESS}\n"
+fi
+
+printf "${PREFIX} Check lint ... "
+lint_output="$(cargo clippy --all-targets --all-features -- -D warnings)"
+if [ $? != 0 ]; then
+    FAILED=1
+    printf "${FAILURE}\n"
+    echo "${lint_output}"
+else
+    printf "${SUCCESS}\n"
+fi
+
+exit ${FAILED}

hooks/pre-push

@@ -30,11 +30,11 @@ impl SomaCommand for CleanCommand {
 
     fn handle_match(
         &self,
-        mut env: Environment<impl Connect, impl Printer>,
+        env: Environment<impl Connect, impl Printer>,
         matches: &ArgMatches,
     ) -> SomaResult<()> {
         clean(
-            &mut env,
+            &env,
             matches.value_of("problem").unwrap(),
             &mut default_runtime(),
         )

src/bin/soma/commands/clean.rs

@@ -29,7 +29,7 @@ impl SomaCommand for ListCommand {
     ) -> SomaResult<()> {
         let mut repo_iter = env.repo_manager().list_repo().peekable();
 
-        if let None = repo_iter.peek() {
+        if repo_iter.peek().is_none() {
             env.printer().write_line("No repository was added.");
         } else {
             for repository in repo_iter {

src/bin/soma/commands/list.rs

@@ -30,11 +30,11 @@ impl SomaCommand for StopCommand {
 
     fn handle_match(
         &self,
-        mut env: Environment<impl Connect, impl Printer>,
+        env: Environment<impl Connect, impl Printer>,
         matches: &ArgMatches,
     ) -> SomaResult<()> {
         stop(
-            &mut env,
+            &env,
             matches.value_of("problem").unwrap(),
             &mut default_runtime(),
         )

src/bin/soma/commands/stop.rs

@@ -1,5 +1,4 @@
-use crossterm::terminal::ClearType;
-use crossterm::{cursor, terminal, Terminal, TerminalCursor};
+use crossterm::{cursor, terminal, ClearType, Terminal, TerminalCursor};
 
 use soma::prelude::*;
 use soma::Printer;