drone-hunter 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 656d8a52817c26e8a3dc5d956cd458b4c3c6ae8354523968bfdfba0acf3d6358
-  data.tar.gz: df60380cea37bcd2817000df50fd60050c1a3e0e8ba6e6675050a74f325007f9
+  metadata.gz: 6e480e4c3cedc73d1c18070de5285a2a9ec12a01e203d87d96d33a4b3cd4239a
+  data.tar.gz: 5d5ff07a714bad22fac37ee885fa65f020a2a1c77f25975a375a54aa6083b512
 SHA512:
-  metadata.gz: fd3f1e3932c15708c5afcff7405bfd534f7779c7e36d66f305566cfab96ce0820299a4edacb2069df8b8fd95ba6f0c63574c21ad63c8dbd8faa9d707c99ac2b8
-  data.tar.gz: 46525d26161abbbbd93401936ef6a3a38254d693761f2c26884b97baafcef57c5cc778377af8e184d1015ace32eeff8ab99d709a436e60baeac331048cf2809b
+  metadata.gz: e59220a2943629071563fe2d3c05571a31637801ef42782c40d44a60676d537e29d303868bc2f1021a3e69952acc26de41409eb6b60f429b18e0d5b6b51b235a
+  data.tar.gz: a3d03c03c714a27d1091f228473f638181008780dd665afb0d7fcf0d59a59515a029cbcbf49541a2bd4c1078209f38023e03569e284c0ede4158abe8e2f3ec26

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '35 6 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/gem-push.yml

@@ -0,0 +1,45 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+#     - name: Publish to RubyGems
+#       run: |
+#         mkdir -p $HOME/.gem
+#         touch $HOME/.gem/credentials
+#         chmod 0600 $HOME/.gem/credentials
+#         printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+#         gem build *.gemspec
+#         gem push *.gem
+#       env:
+#         GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+## 0.3.0
+
+- [feature] added `--ignore-archived` option to skip archived repositories.
+
+## 0.2.0
+
+- [config] added `--github-auto-paginate` option if you want to turn this off for some reason.
+- [feature] added `--output-normalize` option to remove cosmetic differences from dronefiles.
+
+## 0.1.1
+
+- [fix] `--output-format=files` actually works now.
+
+## 0.1.0
+
+- initial release

data/README.md

@@ -76,6 +76,12 @@ drone-hunter.output/rancherlabs/support-tools/.drone.yml
 
 The only limits are your imagination (and the GitHub API Rate Limit).
 
+## Output Normalization
+
+As of `0.2.0`, you can pass use the `--output-normalize` option to
+remove formatting differences in the dronefiles. This reduces false
+negatives when trying to identify which files are the same.
+
 ## License
 
 `drone-hunter` is available under the [MIT License](https://tldrlegal.com/license/mit-license). See `LICENSE.txt` for the full text.

data/bin/drone-hunter

@@ -49,6 +49,15 @@ def log_level_from(input)
     end
 end
 
+# accepts the same values as YAML: https://yaml.org/type/bool.html
+def boolean_from(input)
+    case input
+    when /1|true|yes|on|enabled?/i   then true
+    when /0|false|no|off|disabled?/i then false
+    else raise NotImplementedError
+    end
+end
+
 #########################
 # Default Configuration #
 #########################
@@ -59,15 +68,19 @@ config = {
         dir: File.expand_path(ENV.fetch("DRONE_HUNTER_CACHE_DIR", './drone-hunter.cache'))
     },
     github: {
-        auto_paginate: true,
+        auto_paginate: boolean_from(ENV.fetch("DRONE_HUNTER_GITHUB_AUTO_PAGINATE", "true")),
         access_token: github_access_token_from_environment
     },
+    ignore: {
+        archived: boolean_from(ENV.fetch("DRONE_HUNTER_IGNORE_ARCHIVED", "false"))
+    },
     log: {
         level: log_level_from(ENV.fetch("DRONE_HUNTER_LOG_LEVEL", "info"))
     },
     output: {
         format: output_format_from(ENV.fetch("DRONE_HUNTER_OUTPUT_FORMAT", "json")),
         path: File.expand_path(ENV.fetch("DRONE_HUNTER_OUTPUT_PATH", "./drone-hunter.output")),
+        normalize: boolean_from(ENV.fetch("DRONE_HUNTER_OUTPUT_NORMALIZE", "false")),
     }
 }
 
@@ -76,11 +89,14 @@ config = {
 ################################
 
 OptionParser.new do |options|
-    options.on("-C", "--cache-dir=DIR",             "env: DRONE_HUNTER_CACHE_DIR")           { |argument| config[:cache][:dir]           = File.expand_path(argument) }
-    options.on(      "--github-access-token=TOKEN", "env: DRONE_HUNTER_GITHUB_ACCESS_TOKEN") { |argument| config[:github][:access_token] = argument }
-    options.on("-L", "--log-level=LEVEL",           "env: DRONE_HUNTER_LOG_LEVEL")           { |argument| config[:log][:level]           = log_level_from(argument) }
-    options.on("-o", "--output-format=FORMAT",      "env: DRONE_HUNTER_OUTPUT_FORMAT")       { |argument| config[:output][:format]       = output_format_from(argument) }
-    options.on("-p", "--output-path=PATH",          "env: DRONE_HUNTER_OUTPUT_PATH")         { |argument| config[:output][:path]         = File.expand_path(argument) }
+    options.on("-C", "--cache-dir=DIR",             "env: DRONE_HUNTER_CACHE_DIR")            { |argument| config[:cache][:dir]            = File.expand_path(argument) }
+    options.on(      "--github-access-token=TOKEN", "env: DRONE_HUNTER_GITHUB_ACCESS_TOKEN")  { |argument| config[:github][:access_token]  = argument }
+    options.on(      "--[no-]github-auto-paginate", "env: DRONE_HUNTER_GITHUB_AUTO_PAGINATE") { |argument| config[:github][:auto_paginate] = argument}
+    options.on("-L", "--log-level=LEVEL",           "env: DRONE_HUNTER_LOG_LEVEL")            { |argument| config[:log][:level]            = log_level_from(argument) }
+    options.on("-o", "--output-format=FORMAT",      "env: DRONE_HUNTER_OUTPUT_FORMAT")        { |argument| config[:output][:format]        = output_format_from(argument) }
+    options.on("-p", "--output-path=PATH",          "env: DRONE_HUNTER_OUTPUT_PATH")          { |argument| config[:output][:path]          = File.expand_path(argument) }
+    options.on("-N", "--[no-]output-normalize",     "env: DRONE_HUNTER_OUTPUT_NORMALIZE")     { |argument| config[:output][:normalize]     = argument }
+    options.on("-A", "--[no-]ignore-archived",      "env: DRONE_HUNTER_IGNORE_ARCHIVED")      { |argument| config[:ignore][:archived]      = argument }
 end.parse!
 
 #################
@@ -122,13 +138,20 @@ cache = Moneta.new(:File, dir: config[:cache][:dir])
 # Main Program #
 ################
 
-hunt = DroneHunter.new(owners: ARGV, log: log, github: github, cache: cache)
+hunt = DroneHunter.new(owners: ARGV, log: log, github: github, cache: cache, ignore: config[:ignore])
 
 if config[:hacking]
     require "pry"
     binding.pry
 else
-    hunt.dronefiles.then do |dronefiles|
+    hunt.dronefiles.each do |dronefile|
+        if config[:output][:normalize]
+            require "yaml"
+            original = dronefile["content"]
+            normalized = YAML.dump(YAML.load(original))
+            dronefile["content"] = normalized
+        end
+    end.then do |dronefiles|
         case config[:output][:format]
         when :JSON
             require "json"
@@ -140,8 +163,8 @@ else
             require "fileutils"
             Dir.chdir(File.expand_path(*FileUtils.mkdir_p(config[:output][:path]))) do |output|
                 dronefiles.each do |file|
-                    Dir.chdir(File.expand_path(*FileUtils.mkdir_p(File.join(output, file[:repository])))) do |repo|
-                        File.write(File.join(".", file[:path]), file[:content])
+                    Dir.chdir(File.expand_path(*FileUtils.mkdir_p(File.join(output, file["repository"])))) do |repo|
+                        File.write(File.join(".", file["path"]), file["content"])
                     end
                 end
             end

data/lib/drone_hunter.rb

@@ -21,12 +21,18 @@ class DroneHunter
         @github ||= options.fetch(:client) { Octokit::Client.new(auto_paginate: true) }
         @cache  ||= options.fetch(:cache) { Moneta.new(:File, dir: 'drone-hunter.cache') }
         @owners ||= Set.new(options.fetch(:owners, []))
+        @ignoring ||= { archived: false }.merge(options.fetch(:ignore, {}))
     end
 
     attr_reader :log
     attr_reader :github
     attr_reader :cache
     attr_reader :owners
+    attr_reader :ignoring
+
+    def ignoring_archived?
+        ignoring.fetch(:archived, false)
+    end
 
     def cached(key, *rest, &block)
         if cache.key?(key)
@@ -41,7 +47,9 @@ class DroneHunter
     def repositories(owner = nil)
         case owner
         when String then cached("repositories/#{owner}") { github.repositories(owner) }
-        when nil    then owners.flat_map { |owner| repositories(owner) }
+        when nil    then owners.flat_map { |owner| repositories(owner) }.reject do |repo|
+            ignoring_archived? && repo.archived
+        end
         else raise TypeError
         end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: drone-hunter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Olstrom
@@ -57,6 +57,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/gem-push.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md