tfstats 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c8cbe2d7c9f90fda5372250525decbfeee1c5f2ba67444a2bc1064654149bbd
-  data.tar.gz: 36767c31891db3dc03d202a5301b223364d32bb911e7b7f1cb298a1cb630b3a5
+  metadata.gz: 91c8270f08cae5469a806f4bc110ce70d6140e4572abafdaada4057c29340aab
+  data.tar.gz: 58df16ddf2406c6423a4c209beff8fdcb7264e8f4f7255788e1bba123efc8900
 SHA512:
-  metadata.gz: 1522702b467a722c0b70980deeba1a33171cc076a7f38d0efd7ec8d9ddb4c4aa1a3f1dbc320aa99c68530b36bc90fb028663a6a5149cae08756268c33e3b9c29
-  data.tar.gz: 006ea377946e9ad2675e6d5e2454141be5c5ff7661194b756e7b49051dd04a450404c86fbc39a5adfa9df1578550c8e7e97eb76ef9a125e59687305cdf7b75e3
+  metadata.gz: c2936e8d0794de0b5fd625ec0a5f674cb404ff1c18188ecf7b0e3253c36031a7fd8625faea0ab067a7eb8ab7c1231cfe8248e8772531854cc75e615019f5e7b9
+  data.tar.gz: 0573dcbfdc122afe92fbad64246ca1026c7ea67bbf6726c6dd3cb8bea48253eca067e32fa70fe9f005affeec85351c5bc9c258737a7548cd6673f825aadd17d1

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+
+<a name="v1.0.0"></a>
+## [v1.0.0](https://github.com/stonefield/tfstats/compare/v0.1.2...v1.0.0)
+
+* Feature: Display versioning information for a project
+
+<a name="v0.1.2"></a>
+## [v0.1.2](https://github.com/stonefield/tfstats/compare/v0.1.1...v0.1.2)
+
+* Bug: Missed reference to rake/tasklib
+
+<a name="v0.1.1"></a>
+## [v0.1.1](https://github.com/stonefield/tfstats/compare/v0.1.0...v0.1.1)
+
+* Documentation: Updated gem description

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tfstats (0.1.2)
+    tfstats (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -56,11 +56,12 @@ All parameters are optional. The above shows the default:
   Usage: tfstats [options] [directory]
 
   Commands:
-    -r / recursive    : run recursive.
     -f <filespec>     : specify filespec. Defaults to '*.tf' (use single quote!)
-    -v / verbose      : Output debug information
+    -r / recursive    : run recursive.
     -t / tab          : Tab separated output
-
+    -v / verbose      : Output debug information
+    -x / versions.    : Check versions of terraform and providers
+    
   If no directory is specified, statistics is collected from current directory
 ```
 
@@ -71,6 +72,14 @@ All parameters are optional. The above shows the default:
   rake stats:terraform
 ```
 
+### Identify vesions used in a project
+
+The following command will list terraform versions and provider versions used in a project
+
+```bash
+  tfstats -r -x
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/tfstats

@@ -9,6 +9,7 @@ def main
   filespec = "*.tf"
   directory = '.'
   tabseparated = false
+  versions = false
   while arg = ARGV.shift
     case arg
     when 'help', '--help', '-h'
@@ -21,12 +22,17 @@ def main
       Tfstats.verbose = true
     when '-t', 'tab'
       tabseparated = true
+    when '-x', 'versions'
+      versions = true
     else
       directory = arg
     end
   end
-
-  Tfstats::Collector.collect(directory, filespec, recursive, tabseparated)
+  if versions
+    Tfstats::Collector.versions(directory, filespec, recursive, tabseparated)
+  else
+    Tfstats::Collector.collect(directory, filespec, recursive, tabseparated)
+  end
 end
 
 def help
@@ -42,10 +48,11 @@ HELP_TEXT = <<-DOC
   Usage: #{__FILE__.sub(/.*\//,'')} [options] [directory]
 
   Commands:
-    -r / recursive    : run recursive.
     -f <filespec>     : specify filespec. Defaults to '*.tf' (use single quote!)
-    -v / verbose      : Output debug information
+    -r / recursive    : run recursive.
     -t / tab          : Tab separated output
+    -v / verbose      : Output debug information
+    -x / versions.    : Check versions of terraform and providers
 
   If no directory is specified, statistics is collected from current directory
 

data/lib/tfstats/collector.rb

@@ -5,12 +5,23 @@ module Tfstats
   class Collector
     class << self
       def collect(directory, filespec, recursive, tabseparated)
-        statistics = process_dir(directory, filespec, recursive)
+        statistics = {}
+        process_dir(directory, filespec, recursive) do |collector, placeholder|
+          statistics[placeholder] = collector.collect
+        end
         puts output( statistics, tabseparated)
       end
 
+      def versions(directory, filespec, recursive, tabseparated)
+        versions = {}
+        process_dir(directory, filespec, recursive) do |collector, placeholder|
+          versions[placeholder] = collector.versions if collector.any? # Check versions only if there are any relevant files in the directory
+        end
+        puts output_versions( versions, tabseparated)
+      end
+
+
       def process_dir(directory, filespec, recursive)
-        statistics = {}
         basename = File.basename File.expand_path(directory)
         info "directory: #{directory}"
         info "basename: #{basename}"
@@ -20,12 +31,11 @@ module Tfstats
           Dir.glob("#{directory}/**/").each do |dir|
             info "traversing: #{dir}"
             placeholder = dir.sub(/^#{Regexp.escape(directory.to_s)}/, basename).chop
-            statistics[placeholder] = new(dir, filespec).collect
+            yield new(dir, filespec), placeholder
           end
         else
-          statistics[basename] = new(directory,filespec).collect
+          yield new(directory,filespec), basename
         end
-        statistics
       end
 
       def output(statistics, tabseparated)
@@ -54,6 +64,48 @@ module Tfstats
         str
       end
 
+      def output_versions(statistics, tabseparated)
+        str = ''
+        info "statistics collected: #{statistics.inspect}"
+        if tabseparated
+          pattern = (["%s"] * 3).join("\t") + "\n"
+          separator = ''
+          str << (pattern % %w(Directory Provider Version))
+          statistics.each do |dir, info|
+            str << (pattern % [dir, 'terraform-version', info[:terraform_version]])
+            if info[:providers].is_a? Hash
+              info[:providers].each do |provider, version|
+                str << (pattern % [dir, provider, version])
+              end
+            else
+              str << (pattern % [dir, 'providers', info[:providers]])
+            end
+          end
+        else
+          max_name = statistics.map do |dir, info|
+            if info[:providers].is_a? Hash
+              info[:providers].map { |k,v| k.size }
+            else
+              info[:providers].size
+            end
+          end.flatten.max + 1
+          pattern = "    %-#{max_name}.#{max_name}s %8s\n"
+          statistics.each do |dir, info|
+            str << "#{dir}:\n"
+            str << "  terraform-version: #{info[:terraform_version]}\n"
+            if info[:providers].is_a? Hash
+              str << "  providers:\n"
+              info[:providers].each do |provider,version|
+                str << ( pattern % ["#{provider}:",version])
+              end
+            else
+              str << "  providers: #{info[:providers]}\n"
+            end
+          end
+        end
+        str
+      end
+
       def sum(statistics)
         s = {}
         s.default = 0
@@ -84,6 +136,11 @@ module Tfstats
       @stats.default = 0
     end
 
+    def any?
+      spec = File.join(directory, filespec)
+      Dir[spec].any?
+    end
+
     def info(msg)
       self.class.info msg
     end
@@ -123,5 +180,63 @@ module Tfstats
       @stats
     end
 
+    def versions
+      @stats[:terraform_version] = terraform_version
+      @stats[:providers] = provider_versions
+      @stats
+    end
+
+    def terraform_version
+      file = File.join(directory, '.terraform-version')
+      version = ''
+      if File.exist? file
+        info "Fetching version from: #{file}"
+        version = File.read(file).chomp
+      else
+        info "No terraform version file found (#{file})"
+      end
+      version == '' ? 'undefined' : version
+    end
+
+    def provider_versions
+      file = File.join(directory, '.terraform.lock.hcl')
+      providers = {}
+      if File.exist? file
+        state = :root
+        provider = nil
+        begin
+          info "Fetching provider versions from: #{file}"
+          File.read(file).each_line.with_index do |line,i|
+            begin
+              case state
+              when :root
+                if line =~ /^\s*provider\s*\"(.+)\"\s*\{\s*$/
+                  provider = $1
+                  state = :provider
+                end
+              when :provider
+                if line =~ /^\s*version\s*=\s*"(.*)"\s*$/
+                  providers[provider] = $1
+                  state = :version
+                end
+              when :version
+                if line =~ /^\s*\}\s*$/
+                  provider = nil
+                  state = :root
+                end
+              else
+                raise ArgumentError, "File out of sync."
+              end
+            rescue ArgumentError => e
+              STDERR.puts "#{file}:#{i+1} #{e}"
+            end
+          end
+        rescue => e
+          STDERR.puts e
+        end
+      end
+      providers == {} ? 'undefined' : providers
+    end
+
   end # Collector
 end

data/lib/tfstats/version.rb

@@ -1,3 +1,3 @@
 module Tfstats
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tfstats
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - stonefield
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2022-08-26 00:00:00.000000000 Z
 dependencies: []
 description: Collects statistics for terraform - Supports both comman line and rake
   task
@@ -24,6 +24,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -60,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Collects statistics for terraform