Merge pull request #171 from SUPERAndroidAnalyzer/release/0.5.0

Release/0.5.0

.appveyor.yml

@@ -13,11 +13,11 @@ environment:
     MSYS_BITS: 64
   - TARGET: beta-i686-pc-windows-gnu
     MSYS_BITS: 32
-  - TARGET: 1.16.0-x86_64-pc-windows-msvc
-  - TARGET: 1.16.0-i686-pc-windows-msvc
-  - TARGET: 1.16.0-x86_64-pc-windows-gnu
+  - TARGET: 1.30.0-x86_64-pc-windows-msvc
+  - TARGET: 1.30.0-i686-pc-windows-msvc
+  - TARGET: 1.30.0-x86_64-pc-windows-gnu
     MSYS_BITS: 64
-  - TARGET: 1.16.0-i686-pc-windows-gnu
+  - TARGET: 1.30.0-i686-pc-windows-gnu
     MSYS_BITS: 32
 
 install:
@@ -30,8 +30,7 @@ install:
   - cargo -vV
 
 build_script:
-  - cargo build
-  - cargo package
+  - cargo build --features no-color
 
 test_script:
-  - cargo test
+  - cargo test --features no-color

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Bug description**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior (example):
+1. Download '...'
+2. Run '...'
+3. Check report at '...'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Setup (please complete the following information):**
+ - OS: [e.g. Windows 10]
+ - SUPER Version: [e.g. 0.5.0]
+ - Browser (for reports): [e.g. firefox, opera]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -1,7 +1,8 @@
 downloads/*
 dist/*
 results/*
-target
+target/*
+releases/*
 rpmbuild/*
 !rpmbuild/super.spec
 *.bk

.travis.yml

@@ -1,100 +1,97 @@
 language: rust
-# cache: cargo
+cache: cargo
 dist: trusty
 sudo: true
+services:
+- docker
+
 os:
-  - linux
-  - osx
+- linux
+- osx
+
 addons:
   apt:
     packages:
-      - libcurl4-openssl-dev
-      - libelf-dev
-      - libdw-dev
-      - cmake
-      - gcc
-      - binutils-dev
-      - libiberty-dev
-      - zlib1g-dev
+    - libcurl4-openssl-dev
+    - libelf-dev
+    - libdw-dev
+    - cmake
+    - gcc
+    - binutils-dev
+    - libiberty-dev
+    - zlib1g-dev
 
 # Run builds for all the supported trains
 rust:
-  - nightly
-  - beta
-  - stable
-  - 1.16.0
+- nightly
+- beta
+- stable
+- 1.30.0
+
+# Generate packages for multiple distributions.
+matrix:
+  include:
+  - os: linux
+    rust: "stable"
+    env: PACKAGE="debian"
+  - os: linux
+    rust: "stable"
+    env: PACKAGE="ubuntu"
+  - os: linux
+    rust: "stable"
+    env: PACKAGE="fedora"
+  - os: linux
+    rust: "stable"
+    env: PACKAGE="centos"
 
-# Load travis-cargo
 before_script:
-  - |
-      if [[ "$TRAVIS_OS_NAME" == "linux" && "$TRAVIS_RUST_VERSION" == "stable" ]]; then
-        ( cargo install rustfmt --force || true );
-        ( cargo install --git https://github.com/mmstick/cargo-deb.git || true );
-      fi
-  - |
-      if [[ "$TRAVIS_RUST_VERSION" == "nightly" ]]; then
-        ( ( cargo install clippy && export CLIPPY=true ) || export CLIPPY=false );
-      fi
-  - export PATH=$PATH:~/.cargo/bin
+- export PATH=$PATH:~/.cargo/bin
+- "./travis-helper.sh install_deps"
+  # TODO: change tag when bumping version number. (Maintain in sync with Cargo.toml)
+- |
+  if [[ $TRAVIS_TAG ]]; then
+    export TAG=$TRAVIS_TAG;
+  else
+    export TAG="0.5.0";
+  fi
 
-# The main build
+# Run the multiple tests.
 script:
-  - cargo build
-  - cargo package
-  - cargo test
-  - cargo build --features beta
-  - cargo test --features beta
-  - cargo build --features unstable
-  - cargo test --features unstable
-  - |
-      if [[ "$TRAVIS_RUST_VERSION" == "nightly" && $CLIPPY ]]; then
-        cargo clippy
-      fi
-  - |
-      if [[ "$TRAVIS_OS_NAME" == "linux" && "$TRAVIS_RUST_VERSION" == "stable" ]]; then
-        cargo deb
-      fi
-# Turning of format checking due to several rustfmt bugs.
-# - |
-#     if [[ "$TRAVIS_OS_NAME" == "linux" && "$TRAVIS_RUST_VERSION" == "stable" ]]; then
-#         cargo fmt -- --write-mode=diff
-#     fi
+- "./travis-helper.sh build"
+- "./travis-helper.sh package"
+- "./travis-helper.sh test"
+- "./travis-helper.sh test_ignored"
+- "./travis-helper.sh build_unstable"
+- "./travis-helper.sh test_unstable"
+- "./travis-helper.sh test_unstable_ignored"
+- "./travis-helper.sh clippy_run"
+- "./travis-helper.sh dist_test"
+- "./travis-helper.sh fmt_run"
 
-# Send coverage reports and upload docs
+# Upload code coverage report and documentation.
 after_success:
-  # Coverage report
-  - |
-      if [[ "$TRAVIS_OS_NAME" == "linux" && "$TRAVIS_RUST_VERSION" == "stable" ]]; then
-        wget https://github.com/SimonKagstrom/kcov/archive/master.tar.gz &&
-        tar xzf master.tar.gz &&
-        cd kcov-master &&
-        mkdir build &&
-        cd build &&
-        cmake .. &&
-        make &&
-        sudo make install &&
-        cd ../.. &&
-        rm -rf kcov-master &&
-        for file in target/debug/super-*; do mkdir -p "target/cov/$(basename $file)"; kcov --exclude-pattern=/.cargo,/usr/lib --verify "target/cov/$(basename $file)" "$file"; done &&
-        bash <(curl -s https://codecov.io/bash) &&
-        echo "Uploaded code coverage"
-      fi
-  # Documentation upload
-  - |
-      if [[ "$TRAVIS_OS_NAME" == "linux" && "$TRAVIS_RUST_VERSION" == "stable" && "$TRAVIS_PULL_REQUEST" = "false" && "$TRAVIS_BRANCH" == "master" ]]; then
-        cargo doc &&
-        echo "<meta http-equiv=refresh content=0;url=super/index.html>" > target/doc/index.html &&
-        git clone https://github.com/davisp/ghp-import.git &&
-        ./ghp-import/ghp_import.py -n -p -f -m "Documentation upload" -r https://"$GH_TOKEN"@github.com/"$TRAVIS_REPO_SLUG.git" target/doc &&
-        echo "Uploaded documentation"
-      fi
+- "./travis-helper.sh upload_code_coverage"
+- "./travis-helper.sh upload_documentation"
+
+deploy:
+  provider: releases
+  api_key:
+    secure: n19EgLXHFh8pXBulAfOFtzIMFPSm0yM0yi/sXY1bQgr+QztAHwxkGKaCU/y4yqYwDNH0hCFQn+P8X//Yucz/Cvw2Ng2G040hMJqsu/RztX5svq+pjmTNYX9QuwOg/6AnFoQs2zxRMZia4npVDA66q78G5GA+2eKZ/cDc5/6M32uh7RH8d6yYDnyCJ1lOk35tFu7DLZtfC5xQvOeC+iD4QIiKtVitcjRLQPiV71cG42a0wYYjX3sVKCjqF7NX/q5VHLxG0EofaLeyAI2NdK9RkuAfd6y8YyR0XNwlvq0qX8j5iDtc6ljzOtytlPYUlvyF3AqOJdVt+rBiI2/tZDtVkOobO+hS/+Tl680PpiX+m/HaHErgV0pMYCavYQkjPyMVE0DJCMTMCoHFhGMB+gC/piagVBZ9lKFHRgxXYBFhJVoco2vqMZDm85avI7IzL9YNtJqRt0h2JJZ4/42/Hn0+52CtXJI86HwUU4hD0eUsm9yyWNOsrDahmra1H28vxS7fjEb1Sozol3fMRWKMllKqsUr8Xd06wePqtfYow0ufdHTcumQte9Ls11hgZhDSMd7g6P9tPL5P0UeWa3x8xjNk6Lx3ghAVfzF2CePkeg4VQSHMonZEhaIxShdkCl3Z30F4DOe0p6Pq6ZsG6RRA4/qoIYGPvchfAC4L+VaWjC7yQ0k=
+  file: releases/*
+  skip_cleanup: true
+  prerelease: true # TODO: remove on 1.0
+  on:
+    repo: SUPERAndroidAnalyzer/super
+    tags: true
+    rust: stable
+    os: linux
 
 notifications:
   email:
     recipients:
-      - razican@protonmail.ch
-      - brunoop@protonmail.ch
-      - sergiodlo@protonmail.com
-      - jaimesr@protonmail.ch
+    - razican@protonmail.ch
+    - brunoop@protonmail.ch
+    - sergiodlo@protonmail.com
+    - jaimesr@protonmail.ch
     on_success: change
     on_failure: always

CHANGELOG.md

@@ -1,5 +1,64 @@
 # Changelog
 
+## SUPER 0.5.0
+
+This release contains multiple improvements that have been accumulated in the last year. We also
+improved our repository by adding a Code of Conduct and templates for issues and pull requests.
+Packages for Ubuntu, Debian, Fedora and CentOS are now generated automatically in each build, and
+deployed in each release. Here you can find the rest of the changes for this version.
+
+### Features
+
+- Added SDK version strings to Android versions. Reports will now show the Android version of the
+  target and minimum SDKs.
+- SUPER logo is now an SVG, so that it looks great in multiple resolutions.
+- All icons in the source tree viewer are now SVGs too.
+
+### Internal Changes
+
+- SUPER now requires Rust 1.30.0 to be built.
+- Removed `error-chain` dependency in favor of `failure`.
+- Upgraded dependencies:
+  - `clap`: 2.25 => **2.32**
+  - `xml-rs`: 0.4 => **0.8**
+  - `serde`: 0.9 => **1.0**
+  - `chrono`: 0.3 => **0.4**
+  - `toml`: 0.3 => **0.4**
+  - `regex`: 0.2 => **1.0**
+  - `lazy_static`: 0.2 => **1.1**
+  - `bytecount`: 0.1 => **0.4**
+  - `log`: 0.3 => **0.4**
+  - `env_logger`: 0.4 => **0.5**
+  - `sha1`: 0.2 => **0.6**
+  - `sha2`: 0.5 => **0.8**
+  - `abxml`: 0.2 => **0.6**
+  - `handlebars`: 0.25 => **1.1**
+  - Some other minor upgrades.
+- New dependencies:
+  - `failure`: 0.1
+  - `semver`: 0.9
+  - `hex`: 0.3
+  - `num_cpus`: 1.8
+- Multiple documentation improvements.
+- Code quality improved by using new syntax.
+- Fixed multiple performance bottlenecks.
+- Switched to library/binary architechture.
+
+### Bug Fixes
+
+- Fixed decompilation of badly formatted APK files.
+- Fixed strange characters in Windows Console.
+
+## SUPER 0.4.1
+
+### Internal Changes
+
+- Upgraded `abxml` to **0.2.0**.
+
+### Bug Fixes
+
+- SUPER now properly creates `dist` and `results` directories if they do not exist.
+
 ## SUPER 0.4.0
 
 ### Features
@@ -12,12 +71,12 @@
 
 ### Internal Changes
 
-- SUPER now requires Rust 1.16.0.
+- SUPER now requires Rust 1.16.0 to be built.
 - Errors moved to their own module.
 - Upgraded dependencies:
   - `clap`: 2.20 => **2.23**
   - `xml-rs`: 0.3 => **0.4**
-  And some other minor upgrades.
+  - And some other minor upgrades.
 - Dependency in `yaml-rust` has been removed.
 - Dependency in `error-chain` 0.10 has been added.
 - Dependency in `rust-crypto` has been removed and dependencies in `md5`, `sha1` and `sha2` have

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 contact@superanalyzer.rocks. The project team will review and investigate all complaints, and will respond in a way that it deems 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/