teuton-get 0.1.0

data/README.md

@@ -0,0 +1,29 @@
+
+# Teuton-Get
+
+* Find and download _Teuton Tests_ from remote or local repositories.
+* Create _Teuton Test_ repository.
+
+![logo](./docs/images/logo.png)
+
+# Installation
+
+1. Install Ruby on your system.
+1. `gem install teuton-get`, to install **teuton-get** gem.
+
+# 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.
+* `teutonget download REPONAME:TESTPATH`
+
+# Contact
+
+* **Email**: `teuton.software@protonmail.com`
+
+# Documentation
+
+* [Settings](docs/settings.md)
+* [Get](docs/get.md)
+* [Repository](docs/repo.md)
+* [Commands](docs/commands.md)

data/bin/teutonget

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "teuton-get/cli"
+
+CLI.start(ARGV)

data/docs/commands.md

@@ -0,0 +1,16 @@
+
+# Command reference
+
+Run `teutonget` to show available commands:
+```
+Commands:
+  teutonget create-info [TEST-PATH]     # Create info data for Teuton test
+  teutonget create-repo [SOURCE-DIR]    # Create repo into SOURCE directory
+  teutonget download REPONAME@TESTNAME  # Download Teuton test
+  teutonget help [COMMAND]              # Describe available commands or one specific command
+  teutonget init                        # Create ini config file
+  teutonget refresh                     # Synchronize list of tests available.
+  teutonget repos                       # Show repo list
+  teutonget search [REPONAME@]FILTER    # Search Teuton test with FILTER
+  teutonget version                     # Show the program version
+```

data/docs/get.md

@@ -0,0 +1,50 @@
+[<<back](../README.md)
+
+# Get
+
+Find and download local or remote files.
+
+## Search
+
+At first we need to locate the files according to some criterios.
+
+* `teutonget search FILTER` is used to find files with FILTER criterio.
+
+Example:
+
+```
+❯ teutonget search debian
+(3) teuton.en:en/systems.1/03-debian-conf
+(2) teuton.en:en/systems.2/02-debian-basic-configuration
+```
+
+## Info
+
+Show info about test. Example:
+```
+❯ teutonget info teuton.en:systems.1/03-debian-conf
+
+name    : Debian configuration
+author  : dvarrui
+date    : 2020-09-06
+desc    :
+tags    : Debian, configuration
+files   : README.md, config.yaml, debian.rb, network.rb, start.rb
+```
+
+## Download
+
+Download test by TESTID. Example:
+
+```
+❯ teutonget download teuton.en:systems.1/03-debian-conf
+
+==> Downloading...
+==> File: README.md
+==> File: config.yaml
+==> File: debian.rb
+==> File: network.rb
+==> File: start.rb
+```
+
+Test files will be downloaded into `systems.1_03-debian-conf` local directory.

data/docs/repo.md

@@ -0,0 +1,68 @@
+[<< back](../README.md)
+
+# Repository
+
+Manage repositories: configure and creation.
+
+## 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.
+
+Supose we are on remote machine (Repository host).
+
+* Run `teutonget create-info PATH/TO/TEUTON/TEST/DIR` to create Teuton test info.
+
+Example:
+```
+❯ teutonget create-info 03-debian-mkdir-command
+name? 03-debian-mkdir-command
+author? david
+date? 2022-08-29
+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).
+
+## Create repository
+
+We need to summarize all our test information into repo info file (tt-repo-yaml).
+
+* Go to your remote repository server host.
+* Move to your repository root directory.
+* Then run `teutonget create-repo`.
+
+Example:
+```
+❯ teutonget create-repo
+
+==> Creating repository
+    Reading systems.1/01-windows-conf
+    Reading systems.1/02-opensuse-conf
+    Reading systems.1/03-debian-conf
+    Reading systems.1/04-winserver-conf
+    Reading systems.2/01-install-w10-vbox
+    Reading systems.2/02-debian-basic-configuration
+    Reading systems.2/03-debian-mkdir-command
+    Created file ./tt-repo.yaml with 7 tests.
+```
+
+## Configure remote repository
+
+Finaly we have to configure the new remote repo.
+
+* Go to your local host. Where your will download tests.
+* Modify repo config file (`HOME/.config/teuton/repos.ini`)
+* Add your new remote repo.
+
+Example:
+
+```
+[REPONAME]
+description = WRITE REPO DESCRIPTION
+URL = https://write.here/your/repo/url
+enable = true
+```
+
+* Run `teutonget repos` to check configuration.

data/docs/settings.md

@@ -0,0 +1,40 @@
+[<< back](../README.md)
+
+# Settings
+
+* `teutonget init`, the first time it is necessary to run this command to create the configuration files. From now on you can use the tool.
+
+```
+==> Creating configuration files
+    ✔ Create dir       : /home/quigon/.config/teuton
+    ✔ Create file      : /home/quigon/.config/teuton/repos.ini
+
+==> Refreshing active repos
+    Repo teuton.en (6 tests)
+    Repo teuton.es (2 tests)
+```
+
+> Config files are saved into `HOME/.config/teuton` folder.
+
+* `teutonget repos` will show repositories list.
+
+```
+Repository list
++-+---------+------------------------------------+
+|E|NAME     |DESCRIPTION                         |
++-+---------+------------------------------------+
+|✔|teuton.en|Main Teuton repo                    |
+|✔|teuton.es|Repositorio principal de Teuton Test|
++-+---------+------------------------------------+
+Config: /home/quigon/.config/teuton/repos.ini
+```
+
+> Repositories are configured into HOME/.config/teuton/repos.ini
+
+* `teutonget refresh`, from time to time it is advisable to refresh the information of the repositories using this command.
+
+```
+==> Refreshing active repos
+    Repo teuton.en (6 tests)
+    Repo teuton.es (2 tests)
+```

data/lib/teuton-get/application/environment.rb

@@ -0,0 +1,9 @@
+class Environment
+  def initialize(reader = nil)
+    @env = ENV
+  end
+
+  def get(key)
+    @env[key]
+  end
+end

data/lib/teuton-get/application.rb

@@ -0,0 +1,39 @@
+require "singleton"
+require_relative "application/environment"
+
+class Application
+  include Singleton
+
+  CONFIGFILE = "repos.ini"
+  INDEXFILENAME = "tt-repo.yaml"
+  INFOFILENAME = "tt-info.yaml"
+  MAGICNUMBER = 999
+  SEPARATOR = ":"
+
+  def initialize
+    @env = Environment.new
+    init_params
+  end
+
+  def get(key)
+    return @env.get(key) if key.instance_of? String
+
+    @params[key] || "NODATA"
+  end
+
+  private
+
+  def init_params
+    @params = {}
+    home = get("HOME")
+    config_dirpath = File.join(home, ".config", "teuton")
+    @params[:config_dirpath] = config_dirpath
+
+    filename = Application::CONFIGFILE
+    config_filepath = File.join(config_dirpath, filename)
+    @params[:config_filepath] = config_filepath
+
+    cache_dirpath = File.join(config_dirpath, "cache")
+    @params[:cache_dirpath] = cache_dirpath
+  end
+end

data/lib/teuton-get/cli.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "application"
+require_relative "version"
+require_relative "../teuton-get"
+
+class CLI < Thor
+  map ["h", "-h", "--help"] => "help"
+
+  map ["v", "-v", "--version"] => "version"
+  desc "version", "Show the program version"
+
+  def version
+    puts "#{Version::EXECUTABLE} (version #{Version::VERSION})"
+  end
+
+  map ["ci", "-ci", "--create-info"] => "create_info"
+  desc "create-info [DIRPATH]", "Create info data for Teuton test"
+  long_desc <<-LONGDESC
+  Create info data for Teuton test.
+  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"
+  desc "create-repo", "Create repo into current directory"
+  long_desc <<-LONGDESC
+  Create index from SOURCE directory.
+  LONGDESC
+  def create_repo
+    TeutonGet.create_repo(".")
+  end
+
+  map ["i", "-i", "--init"] => "init"
+  desc "init", "Create ini config file"
+  long_desc <<-LONGDESC
+    Create ini config file
+  LONGDESC
+  def init
+    TeutonGet.init
+  end
+
+  map ["--repos"] => "repos"
+  desc "repos", "Show repo list"
+  long_desc <<-LONGDESC
+    Show repo list.
+  LONGDESC
+  def repos
+    TeutonGet.show_repo_list
+  end
+
+  map ["r", "-r", "--refresh"] => "refresh"
+  desc "refresh", "Synchronize list of available tests."
+  long_desc <<-LONGDESC
+    Synchronize list of tests available.
+  LONGDESC
+  def refresh
+    TeutonGet.refresh
+  end
+
+  map ["s", "-s", "--search"] => "search"
+  desc "search [REPONAME:]FILTER", "Search Teuton test with FILTER"
+  long_desc <<-LONGDESC
+  Search Teuton test with FILTER.
+  LONGDESC
+  def search(filter)
+    TeutonGet.search(filter)
+  end
+
+  map ["d", "-d", "--download"] => "download"
+  desc "download TESTID", "Download Teuton test"
+  long_desc <<-LONGDESC
+    Download Teuton test. Example: "teutonget main@system/opensuse"
+  LONGDESC
+  def download(testname)
+    TeutonGet.download(testname)
+  end
+end

data/lib/teuton-get/downloader.rb

@@ -0,0 +1,71 @@
+require "fileutils"
+require_relative "writer/file_writer"
+require_relative "writer/terminal_writer"
+require_relative "reader/inifile_reader"
+require_relative "reader/url_reader"
+require_relative "repo/repo_config"
+require_relative "repo/repo_data"
+
+class Downloader
+  def initialize
+    @dev = TerminalWriter.new
+    @repo_config = RepoConfig.new_by_default.data
+    cache_dirpath = Application.instance.get(:cache_dirpath)
+    @repo_data = RepoData.new(
+      config_reader: IniFileReader.new,
+      progress_writer: TerminalWriter.new,
+      cache_dirpath: cache_dirpath
+    )
+  end
+
+  def run(id)
+    reponame, testpath = id.split(Application::SEPARATOR)
+
+    repo_url, status = get_url_for reponame
+    unless status == :ok
+      @dev.writeln "    #{status}"
+      return false
+    end
+
+    files, status = get_files_for_test id
+    unless status == :ok
+      @dev.writeln "    #{status}"
+      return false
+    end
+
+    download(reponame, repo_url, testpath, files)
+  end
+
+  private
+
+  def get_url_for(reponame)
+    repo = @repo_config[reponame]
+    return nil, "ERROR: undefined repo name!" if repo.nil?
+    url = repo["URL"]
+    return nil, "ERROR: undefined repo URL!" if url.nil?
+    [url, :ok]
+  end
+
+  def get_files_for_test(id)
+    testdata = @repo_data.get(id)
+    return [], "ERROR: not found!" if testdata.nil?
+    files = testdata["files"]
+    return [], "WARN: files no defined!" if files.nil?
+    return [], "WARN: 0 files defined!" if files.size.zero?
+    [files, :ok]
+  end
+
+  def download(reponame, url, path, files)
+    @dev.writeln "==> Downloading #{path} from #{reponame}...", color: :light_yellow
+    localpath = path.tr("/", "_")
+    FileUtils.mkdir(localpath) unless File.exist? localpath
+    files.each do |filename|
+      @dev.writeln "==> File: #{filename} ", color: :white
+      uri = "#{url}/#{path}/#{filename}"
+      out = FileWriter.new
+      out.open(File.join(localpath, filename))
+      out.write(URLReader.new(uri).read)
+      out.close
+    end
+  end
+end

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

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

data/lib/teuton-get/files/tt-info.yaml

@@ -0,0 +1,21 @@
+#####################################################
+# DONT CHANGE THESE ATTRIBUTES (Created by teutonget)
+#
+version: 1
+type: teutontest
+
+#########################################################
+# UPDATE THESE VALUES (Keep names and update their values
+#
+name: <%=@data[:name] + "\n"%>
+author: <%=@data[:author] + "\n"%>
+date: <%=@data[:date] + "\n"%>
+desc: <%=@data[:desc] + "\n"%>
+tags:
+<% @data[:tags].each do |tag| %>
+- <%=tag.strip + "\n"%>
+<% end %>
+
+###################################
+# Custom attributes after this line
+#

data/lib/teuton-get/reader/inifile_reader.rb

@@ -0,0 +1,24 @@
+require "inifile"
+require_relative "reader"
+
+class IniFileReader < Reader
+  def initialize(filepath = "")
+    @filepath = filepath
+  end
+
+  def source
+    @filepath
+  end
+
+  def read(filepath = :default)
+    @filepath = filepath unless filepath == :default
+    return {} unless File.exist? @filepath
+
+    inifile = IniFile.load(@filepath)
+    data = {}
+    inifile.sections.each do |section|
+      data[section] = inifile[section]
+    end
+    data
+  end
+end

data/lib/teuton-get/reader/linux_environment_reader.rb

@@ -0,0 +1,19 @@
+require_relative "reader"
+
+class LinuxEnvironmentReader < Reader
+  def initialize(command)
+    @command = command
+  end
+
+  def read
+    lines = @command.split("\n")
+    data = {}
+    lines.sort.each do |line|
+      items = line.split("=")
+      if items.size == 2
+        data[items[0].strip] = items[1].strip
+      end
+    end
+    data
+  end
+end

data/lib/teuton-get/reader/reader.rb

@@ -0,0 +1,9 @@
+class Reader
+  def source
+    raise "Define method"
+  end
+
+  def read
+    raise "Define method"
+  end
+end

data/lib/teuton-get/reader/url_reader.rb

@@ -0,0 +1,18 @@
+require "net/http"
+require "uri"
+require_relative "reader"
+
+class URLReader < Reader
+  def initialize(url = "")
+    @url = url
+  end
+
+  def source
+    @url
+  end
+
+  def read(url = :default)
+    @url = url unless url == :default
+    Net::HTTP.get(URI.parse(@url))
+  end
+end

data/lib/teuton-get/reader/yaml_reader.rb

@@ -0,0 +1,24 @@
+require "date"
+require "yaml"
+require_relative "reader"
+
+class YamlReader < Reader
+  def initialize(filepath = "")
+    @filepath = filepath
+  end
+
+  def source
+    @filepath
+  end
+
+  def read(filepath = :default)
+    @filepath = filepath unless filepath == :default
+    return {} unless File.exist? @filepath
+
+    content = File.open(@filepath)
+    YAML.safe_load(
+      content,
+      permitted_classes: [Array, Date, Hash, Symbol]
+    )
+  end
+end

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

@@ -0,0 +1,71 @@
+require_relative "../application"
+require_relative "../writer/terminal_writer"
+require_relative "../reader/yaml_reader"
+require "erb"
+require "tty-prompt"
+
+class LocalInfo
+  def initialize(dev = TerminalWriter.new)
+    @dev = dev
+    @data = {}
+  end
+
+  def default_create(testpath)
+    set_default_data(testpath)
+    create(testpath)
+  end
+
+  def user_create(testpath)
+    ask_data(testpath)
+    create(testpath)
+  end
+
+  def read(filepath)
+    dirpath = File.dirname(filepath)
+    @dev.writeln "    Reading #{dirpath}"
+    data = YamlReader.new(filepath).read
+
+    filepaths = Dir.glob("#{dirpath}/**/*.*")
+    files = filepaths.map { |i| i[dirpath.size + 1, i.size] }
+    data["files"] = files
+    data
+  end
+
+  private
+
+  def set_default_data(testpath)
+    @data[:name] = File.basename(testpath)
+    @data[:author] = ENV["USER"]
+    @data[:date] = Time.now.strftime("%Y-%m-%d")
+    @data[:desc] = "Write your description"
+    @data[:tags] = ["Write your", "comma separated", "tags"]
+  end
+
+  def ask_data(testpath)
+    set_default_data(testpath)
+    prompt = TTY::Prompt.new
+    @data[:name] = prompt.ask("name?", default: @data[:name])
+    @data[:author] = prompt.ask("author?", default: @data[:author])
+    @data[:date] = prompt.ask("date?", default: @data[:date])
+    @data[:desc] = prompt.ask("desc?", default: @data[:desc])
+    input = prompt.ask("tags?", default: @data[:tags].join(","))
+    @data[:tags] = input.split(",")
+  end
+
+  def create(testpath)
+    startfile = File.join(testpath, "start.rb")
+    unless File.exist?(startfile)
+      @dev.writeln "    ERROR: File start.rb not found!", color: :light_red
+      return false
+    end
+
+    infofilename = Application::INFOFILENAME
+    sourcepath = File.join(File.dirname(__FILE__), "..", "files", infofilename)
+    template = File.read(sourcepath)
+    content = ERB.new(template, trim_mode: "%>")
+    targetpath = File.join(testpath, infofilename)
+    File.write(targetpath, content.result(binding))
+
+    true
+  end
+end