teuton-get 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9a7d30a57e1d17315bdc1a70eca4bb76e397c901c46cb5a5709fd72802945ea
-  data.tar.gz: 12d9f68bfbd6a1f4c3107acb4059527b829def841e2049753f4ed77e3c70c362
+  metadata.gz: b783cab2c10f1a23f61fe5b8e53e108dcce79fb8b97a0ab1a717b4244a0f193c
+  data.tar.gz: 576048fe21ce48012784d2ff48ba21198f94d63cff33f55d8091a5dc137947e4
 SHA512:
-  metadata.gz: 6b5a55be18579de050724e9cc48dfdd1aebd0e87108b3810d2a785034b94de87c392fdff0f85ba87858227bda8f604e77173193bd65b5efe9867aecf02e31011
-  data.tar.gz: 23a880ed0a732db0891947a828a12188a034cc4b6f9611b30748916751e7104f530eb77b61b95a492bc2db574a46b5a59e97ca7dcbf48354573e8adb25592909
+  metadata.gz: 93a9660d795aabc86399f2a7393175b07359ff22294d9c66487367478dd234fbf93f764a5c9310c89fb2de176876a9a7860acb74081e5a9cc1e7919d4eea4493
+  data.tar.gz: 4bc2009d8d715113336b0970beef9d4e92b949c48689358d328238dcc851aa88747d6ee6d4efe86c54ed2a1beeb212f0d51c94670ba9604f28fef4084dc5eae1

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/teuton-get.svg)](https://badge.fury.io/rb/teuton-get)
 
 # Teuton-Get
 
@@ -13,21 +14,69 @@
 
 # Use
 
-* At first, create config file with `teutonget init`.
-* Then, search tests with `teutonget search FILTER`. Example: `teutonget search linux`, will show a list with "linux" related tests.
+1. `teutonget init`, at first, create config file.
+1. `teutonget refresh`, to refresh repo catalog.
+1. `teutonget search FILTER`. then, search tests.
+1. `teutonget download REPONAME:TESTPATH`, download test files.
 
+## Examples
 
-* `teutonget download REPONAME:TESTPATH`
+**Example 1: search and download**
 
-## Example
+* Create config files:
 
-* Search and download test:
+```
+> teutonget init
 
-![](docs/images/teutonget-download.png)
+==> Creating configuration files
+    ✔ Create dir       : /home/quigon/.config/teuton
+    ✔ Create file      : /home/quigon/.config/teuton/repos.ini
+```
 
-* Refresh repos and show test details:
+* Refresh repo catalog:
 
-![](docs/images/teutonget-info.png)
+```
+> teutonget refresh
+
+==> Refreshing active repos
+    ✔ Repo teuton.en (10 tests)
+    ✔ Repo teuton.es (4 tests)
+```
+
+* Search test:
+
+```
+> teutonget search usermin
+(x3) teuton.es:sistemas.3/scripting/usermin
+```
+
+* Show details:
+
+```
+> teutonget info teuton.es:sistemas.3/scripting/usermin
+
+name    : usermin
+author  : fvarrui, dvarrui
+date    : 2022-11-05
+desc    : Usermin. Script para la gestión de usuarios
+tags    : script, usuario, crear, consultar, listar, eliminar
+files   : INSTALL.md, README.md, bin/docker.run, bin/up_environ.sh, config.yaml, lib/docker/consultar.rb, lib/docker/eliminar.rb, lib/docker/help.rb, lib/docker/listar.rb, lib/docker/nuevo.rb, lib/vm/consultar.rb, lib/vm/eliminar.rb, lib/vm/help.rb, lib/vm/listar.rb, lib/vm/nuevo.rb, start.rb, tt-info.yaml, vagrant/install-software.sh, vagrant/profesor.rb, vm.rb, vm.yaml
+```
+
+* Download test:
+
+```
+> teutonget download teuton.es:sistemas.3/scripting/usermin
+
+==> Progress [█████████████████████] 100%
+==> Download OK
+```
+
+**Example 2: Locate TEST ID**
+
+Teuton test ID (TESTID) is `REPONAME:TESTPATH`.
+
+![](docs/images/teutonget-search-debian.png)
 
 # Contact
 

data/docs/get.md

@@ -2,23 +2,51 @@
 
 # Get
 
-Find and download local or remote files.
+Find and download local or remote test files.
 
-## Search
+1. [Search](#1-search)
+2. [Info](#2-info)
+3. [Download](#3-download)
 
-At first we need to locate the files according to some criterios.
+## 1. Search
 
-* `teutonget search FILTER` is used to find files with FILTER criterio.
+At first we need to locate the test according to some criterios.
+
+```
+teutonget search FILTER
+```
+
+| Command               | Description |
+| --------------------- | ----------- |
+| teutonget search TEXT | Find test that contains TEXT |
+| teutonget search :TEXT | |
+| teutonget search ALL:TEXT | |
+| teutonget search TEXT1,TEXT2 | Find test that contains TEXT1 or TEXT2 |
+| teutonget search REPONAME:TEXT | Find test from REPONAME, that contains TEXT f|
+| teutonget search REPONAME:ALL | Find all test from REPONAME |
 
 Example:
 
 ```
-❯ teutonget search debian
-(3) teuton.en:en/systems.1/03-debian-conf
-(2) teuton.en:en/systems.2/02-debian-basic-configuration
+❯ teutonget se window
+(x3) teuton.en:systems.1/01-windows-conf
+(x1) teuton.en:systems.1/04-winserver-conf
+(x1) teuton.en:systems.2/01-install-w10-vbox
+
+```
+
+As a result we have a list of tests ordered from highest to lowest value according to the search requirement. In this example, the test with value x3 has greater weight than x1 and therefore appears recommended in the first position.
+
+Ejample:
 ```
+❯ teutonget se script,fvarrui
+(x6) teuton.es:sistemas.3/scripting/usermin
+(x1) teuton.en:systems.2/01-install-w10-vbox
+```
+
+In this example, the filter is form by multiple words separated by commas. As result, will be shown tests that contain word 1 or word 2, or both. And appear in order from highest to lowest according to the number of times these words appear in the test metadata.
 
-## Info
+## 2. Info
 
 Show info about test. Example:
 ```
@@ -32,9 +60,9 @@ tags    : Debian, configuration
 files   : README.md, config.yaml, debian.rb, network.rb, start.rb
 ```
 
-## Download
+## 3. Download
 
-Download test by TESTID. Example:
+Download teuton test files identified by TESTID. Example:
 
 ```
 ❯ teutonget download teuton.en:systems.1/03-debian-conf

data/docs/repo.md

@@ -4,7 +4,12 @@
 
 Manage repositories: configure and creation.
 
-## Create info
+1. Create info
+2. Create repository
+3. Configure remote repository
+4. Configure local repository
+
+## 1. Create info
 
 Teuton test files are located into remote machines. Every Teuton test requires
 a special info file that acts as manifest or test metadata.
@@ -23,11 +28,11 @@ desc? Practice basic commands into Debian host.
 tags? practice,basic,command,debian,host
 ```
 
-Every Teuton test that you want to be downdable, requires test info file (tt-info.yaml).
+Every downdable Teuton test requires metadata file. Test info file called `tt-info.yaml`.
 
-## Create repository
+## 2. Create repository
 
-We need to summarize all our test information into repo info file (tt-repo-yaml).
+All tests metadata is summarized into repo metadata. Repo info file called `tt-repo-yaml`.
 
 * Go to your remote repository server host.
 * Move to your repository root directory.
@@ -48,7 +53,7 @@ Example:
     Created file ./tt-repo.yaml with 7 tests.
 ```
 
-## Configure remote repository
+## 3. Configure remote repository
 
 Finaly we have to configure the new remote repo.
 
@@ -60,9 +65,31 @@ Example:
 
 ```
 [REPONAME]
+type = teutontest
 description = WRITE REPO DESCRIPTION
 URL = https://write.here/your/repo/url
 enable = true
 ```
 
 * Run `teutonget repos` to check configuration.
+
+> Every repo is showed with different color automatically.
+
+## 4. Configure local repository
+
+The usual thing will be to have remote repositories from where to download the tests. This process requires a network connection between our local machine and the remote repository.
+
+But it is possible to have a repository on our local machine and not use the network for test downloads.
+
+To do this we will create the repository on our local machine as indicated above, but instead of using https:// the URL will use a path to a local directory.
+
+
+Example:
+
+```
+[LOCALREPONAME]
+type = teutontest
+description = WRITE LOCAL REPO DESCRIPTION
+URL = /path/to/your/local/repo/folder
+enable=true
+```

data/lib/teuton-get/cli.rb

@@ -6,56 +6,59 @@ require_relative "version"
 require_relative "../teuton-get"
 
 class CLI < Thor
-  map ["h", "-h", "--help"] => "help"
+  map ["-help", "--help"] => "help"
 
-  map ["v", "-v", "--version"] => "version"
+  map ["-version", "--version"] => "version"
   desc "version", "Show the program version"
 
   def version
     puts "#{Version::EXECUTABLE} (version #{Version::VERSION})"
   end
 
-  map ["ci", "-ci", "--create-info"] => "create_info"
+  map ["ci", "-ci", "--create-info", "create-info"] => "create_info"
   desc "create-info [DIRPATH]", "Create info data for Teuton test"
   long_desc <<-LONGDESC
-  Create info data for Teuton test.
+    Create info data for Teuton test. Example: "teutonget create-info systems.1/02-opensuse-conf"
   LONGDESC
+
   def create_info(testpath)
     TeutonGet.create_info(testpath)
   end
 
-  map ["i", "-i", "--info"] => "info"
-  desc "info TESTID", "Show info data for Teuton test"
-  long_desc <<-LONGDESC
-  Show info data for Teuton test.
-  LONGDESC
-  def info(test_id)
-    TeutonGet.show_info(test_id)
-  end
-
-  map ["cr", "-cr", "--create-repo"] => "create_repo"
+  map ["cr", "-cr", "--create-repo", "create-repo"] => "create_repo"
   desc "create-repo", "Create repo into current directory"
   long_desc <<-LONGDESC
-  Create index from SOURCE directory.
+    Create index from SOURCE directory. Example: "teutonget create-repo"
   LONGDESC
   def create_repo
     TeutonGet.create_repo(".")
   end
 
-  map ["i", "-i", "--init"] => "init"
+  map ["--init"] => "init"
   desc "init", "Create ini config file"
   long_desc <<-LONGDESC
-    Create ini config file
+    Create ini config file. Example: "teutonget init"
   LONGDESC
   def init
     TeutonGet.init
   end
 
+  map ["i", "-i", "--info"] => "info"
+  desc "info TESTID", "Show info data for Teuton test"
+  long_desc <<-LONGDESC
+    Show info data for Teuton test. Example: "teutonget info teuton.en:systems.1/02-opensuse-conf"
+  LONGDESC
+
+  def info(test_id)
+    TeutonGet.show_info(test_id)
+  end
+
   map ["--repos"] => "repos"
   desc "repos", "Show repo list"
   long_desc <<-LONGDESC
-    Show repo list.
+    Show repo list. Example: "teutonget repos"
   LONGDESC
+
   def repos
     TeutonGet.show_repo_list
   end
@@ -63,7 +66,7 @@ class CLI < Thor
   map ["r", "-r", "--refresh"] => "refresh"
   desc "refresh", "Synchronize list of available tests."
   long_desc <<-LONGDESC
-    Synchronize list of tests available.
+    Synchronize list of tests available. Example: "teutonget refresh"
   LONGDESC
   def refresh
     TeutonGet.refresh
@@ -72,18 +75,20 @@ class CLI < Thor
   map ["s", "-s", "--search"] => "search"
   desc "search [REPONAME:]FILTER", "Search Teuton test with FILTER"
   long_desc <<-LONGDESC
-  Search Teuton test with FILTER.
+    Search Teuton test using FILTER. Example: "teutonget search opensuse"
   LONGDESC
   def search(filter)
     TeutonGet.search(filter)
   end
 
-  map ["d", "-d", "--download"] => "download"
+  map ["d", "-d", "--download", "clone", "--clone"] => "download"
+  # option :dirname # FIXME
   desc "download TESTID", "Download Teuton test"
   long_desc <<-LONGDESC
-    Download Teuton test. Example: "teutonget main@system/opensuse"
+    Download Teuton test. Example: "teutonget download teuton.en:systems.1/02-opensuse-conf"
   LONGDESC
   def download(testname)
-    TeutonGet.download(testname)
+    puts options unless options.empty?
+    TeutonGet.download(testname, options)
   end
 end

data/lib/teuton-get/downloader.rb

@@ -1,4 +1,5 @@
 require "fileutils"
+require "tty-progressbar"
 require_relative "writer/file_writer"
 require_relative "writer/terminal_writer"
 require_relative "reader/inifile_reader"
@@ -56,16 +57,19 @@ class Downloader
   end
 
   def download(reponame, url, path, files)
-    @dev.writeln "==> Downloading '#{path}' from repo '#{reponame}'...", color: :light_yellow
+    bar = TTY::ProgressBar.new("==> Progress [:bar] :percent", total: files.size, bar_format: :block)
+
     localpath = path.tr("/", "_")
     FileUtils.mkdir(localpath) unless File.exist? localpath
     files.each do |filename|
-      @dev.writeln "==> File: #{filename} ", color: :white
+      bar.advance
+
       uri = "#{url}/#{path}/#{filename}"
       out = FileWriter.new
       out.open(File.join(localpath, filename))
       out.write(URLReader.new(uri).read)
       out.close
     end
+    @dev.writeln "==> Download OK", color: :white
   end
 end

data/lib/teuton-get/files/repos.ini

@@ -1,11 +1,13 @@
 # version 1
 
 [teuton.en]
+type = teutontest
 description = Main Teuton repo
 URL = https://raw.githubusercontent.com/teuton-software/teuton-tests/master/en
 enable = true
 
 [teuton.es]
+type = teutontest
 description = Repositorio principal de Teuton Test
 URL = https://raw.githubusercontent.com/teuton-software/teuton-tests/master/es
 enable = true

data/lib/teuton-get/repo/local_info.rb

@@ -4,6 +4,7 @@ require_relative "../reader/yaml_reader"
 require "erb"
 require "tty-prompt"
 
+# Create metadata for local user teuton test
 class LocalInfo
   def initialize(dev = TerminalWriter.new)
     @dev = dev

data/lib/teuton-get/repo/local_repo.rb

@@ -2,6 +2,7 @@ require_relative "../application"
 require_relative "../writer/file_writer"
 require_relative "../writer/terminal_writer"
 
+# Create metadata for local user teuton repository
 class LocalRepo
   def initialize(args)
     @repoindex_writer = args[:repoindex_writer]

data/lib/teuton-get/repo/repo_config.rb

@@ -1,9 +1,10 @@
 require "fileutils"
 require_relative "../application"
-require_relative "../format"
 require_relative "../reader/inifile_reader"
+require_relative "../utils/format"
 require_relative "../writer/terminal_writer"
 
+# Create Teuton Repo config file
 class RepoConfig
   attr_reader :data
 
@@ -27,7 +28,7 @@ class RepoConfig
   end
 
   def create
-    @dev.writeln "\n==> Creating configuration files", color: :light_yellow
+    @dev.writeln "\n==> Creating configuration files"
     create_dir
     create_ini_file
   end
@@ -56,12 +57,12 @@ class RepoConfig
   def create_dir
     dirpath = @config_dirpath
     if Dir.exist? dirpath
-      @dev.write "    \u{2716} Exists dir!      : "
-      @dev.writeln dirpath, color: :yellow
+      @dev.write "    \u{2716} Exists dir!      : ", color: :white
+      @dev.writeln dirpath, color: :white
     else
       begin
         FileUtils.mkdir_p(dirpath)
-        @dev.write "    \u{2714} Create dir       : "
+        @dev.write "    \u{2714} Create dir       : ", color: :white
         @dev.writeln dirpath, color: :green
       rescue => e
         @dev.write "    \u{2716} Create dir  ERROR: "
@@ -78,13 +79,13 @@ class RepoConfig
 
   def copyfile(target, dest)
     if File.exist? dest
-      @dev.write "    \u{2716} Exists file!     : "
-      @dev.writeln dest, color: :yellow
+      @dev.write "    \u{2716} Exists file!     : ", color: :white
+      @dev.writeln dest, color: :white
       return true
     end
     begin
       FileUtils.cp(target, dest)
-      @dev.write "    \u{2714} Create file      : "
+      @dev.write "    \u{2714} Create file      : ", color: :white
       @dev.writeln dest, color: :green
     rescue => e
       @dev.write "    \u{2716} Create file ERROR: "

data/lib/teuton-get/repo/repo_data.rb

@@ -28,7 +28,7 @@ class RepoData
     dirpath = @cache_dirpath
     FileUtils.rm_r(dirpath) if Dir.exist? dirpath
 
-    @dev.writeln "\n==> Refreshing active repos", color: :light_yellow
+    @dev.writeln "\n==> Refreshing active repos"
     @data.keys.sort.each do |key|
       refresh_repo key
     end
@@ -58,6 +58,12 @@ class RepoData
 
   def database_filename
     # REVISE: Used by teutonget search... replace by #get()
+    unless Dir.exist? @cache_dirpath
+      puts "    [WARN] Create Teuton config files!"
+      puts "    Usage: teutonget init"
+      exit 1
+    end
+
     File.join(@cache_dirpath, "database.yaml")
   end
 
@@ -65,7 +71,7 @@ class RepoData
 
   def refresh_repo(reponame)
     unless enabled? reponame
-      @dev.writeln "    \u{2716} Skiping repo #{reponame}"
+      @dev.writeln "    \u{2716} Skiping repo #{reponame}", color: :yellow
       return false
     end
     dirpath = File.join(@cache_dirpath)

data/lib/teuton-get/searcher.rb

@@ -1,8 +1,8 @@
 require_relative "application"
-require_relative "format"
 require_relative "reader/yaml_reader"
 require_relative "repo/repo_data"
 require_relative "searcher/result"
+require_relative "utils/format"
 require_relative "writer/terminal_writer"
 
 class Searcher
@@ -33,7 +33,7 @@ class Searcher
 
   def show_result
     @results.each do |i|
-      @dev.write "(x#{i[:score]}) ", color: :white
+      @dev.write ("(x%02d) " % i[:score]), color: :white
       reponame = TeutonGet::Format.colorize(i[:reponame], i[:repoindex])
       @dev.writeln "#{reponame}#{Application::SEPARATOR}#{i[:testname]}"
     end

data/lib/teuton-get/version.rb

@@ -1,6 +1,6 @@
 module Version
   NAME = "teuton-get"
   EXECUTABLE = "teutonget"
-  VERSION = "0.2.1"
+  VERSION = "0.2.3"
   HOMEPAGE = "https://github.com/teuton-software/#{NAME}"
 end

data/lib/teuton-get/writer/terminal_writer.rb

@@ -1,6 +1,6 @@
 require "tty-table"
 require_relative "writer"
-require_relative "../format"
+require_relative "../utils/format"
 
 class TerminalWriter < Writer
   def write(text = "", args = {})

data/lib/teuton-get.rb

@@ -6,19 +6,28 @@ require_relative "teuton-get/searcher"
 require_relative "teuton-get/downloader"
 
 module TeutonGet
+  # Create metadata for local user teuton test
   def self.create_info(testpath)
     LocalInfo.new.user_create(testpath)
   end
 
+  # Create metadata for local user teuton repository
   def self.create_repo(dirpath)
     LocalRepo.new_by_default.create(dirpath)
   end
 
+  # Download remote teuton test
+  def self.download(test_id, options)
+    Downloader.new.run(test_id)
+  end
+
+  # Create Teuton Repo config file
   def self.init
     RepoConfig.new_by_default.create
     refresh # Auto repo refresh
   end
 
+  # Refresh Teuton Repo Data
   def self.refresh
     RepoData.new_by_default.refresh
   end
@@ -38,8 +47,4 @@ module TeutonGet
     searcher.get(filter)
     searcher.show_result
   end
-
-  def self.download(test_id)
-    Downloader.new.run(test_id)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teuton-get
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 description: "    Find and download Teuton Test.\n"
 email: teuton.software@protonmail.com
 executables:
@@ -109,7 +123,6 @@ files:
 - lib/teuton-get/downloader.rb
 - lib/teuton-get/files/repos.ini
 - lib/teuton-get/files/tt-info.yaml
-- lib/teuton-get/format.rb
 - lib/teuton-get/reader/inifile_reader.rb
 - lib/teuton-get/reader/linux_environment_reader.rb
 - lib/teuton-get/reader/reader.rb
@@ -121,6 +134,7 @@ files:
 - lib/teuton-get/repo/repo_data.rb
 - lib/teuton-get/searcher.rb
 - lib/teuton-get/searcher/result.rb
+- lib/teuton-get/utils/format.rb
 - lib/teuton-get/version.rb
 - lib/teuton-get/writer/file_writer.rb
 - lib/teuton-get/writer/null_writer.rb
@@ -138,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.5.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="