sct 0.1.17 → 0.1.22

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Reshad Farid
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/README.md

@@ -1,134 +0,0 @@
-# SCT
-The **SCT** command line tool helps developers set up and maintain a Kubernetes (k8s) cluster on their development machine which closely resembles the production setup.
-
-The tool is geared towards the implementation of a local development environment in compliance with the [*Visma Cloud Delivery Model*](https://www.visma.com/blog/our-large-scale-devops-transformation/) (SCT) to be deployed on *Google Cloud Services*.
-
-The SCT tool is a collection of commands that can be run from your local development environment. These commands will take care of some steps necessary to initialize the development environment, but also of some recurring tasks to keep this environment going on a daily base.
-
-This README will provide an installation guide, an overview of the available commands and a brief guide for developers that need to contribute to the **SCT** CLI tool.
-
-The tool is written in Ruby and is meant to run on *Windows, Linux and Mac* environments.
-
-## Installation
-
-1) Open a terminal or bash window and make sure [**Ruby**](https://www.ruby-lang.org/en/documentation/installation/) is installed on your machine with _version >= 2.6.*_
-
-        $ which ruby
-        $ ruby --version
-
-2) As this Ruby Gem is not yet published, you will need to install the *SCT* tool from this repository and use Ruby [**bundler**](https://bundler.io/) to manage dependencies.
-
-        $ gem install bundler
-
-3) Navigate to a (new) folder where you want the SCT code, and clone this repository:
-
-        $ git clone https://github.com/reshadf/sct.git
-
-4) Then let **bundler** manage the dependencies:
-
-        $ bundle
-
-5) And let **gem** create a binary:
-
-        $ gem install sct
-
-6) Now, the **sct** tool is available anywhere from the command line
-
-        $ sct --help
- 
-
-## Usage
-
-SCT offers a number of commands to help developers set up a local development environment for Visma Cloud To get an overview of what **sct** can do, run
-
-    $ sct --help
-
-To initialize a **sct** configuration file
-
-    $ sct init
-
-To patch the hostfile with the local IP of the k8s cluster:
-
-    $ sct hostfile
-
-To add the secret for the MySQL proxy:
-
-    $ sct mysql_proxy
-
-
-## Development
-
-For development of the **sct** tool, the installation needs to be a bit different.
-
-Repeat steps 1-3 from the installation instruction above.
-
-4) We will use [**rake**](https://github.com/ruby/rake) as a Ruby develoment tool for running tests and generating binaries:
-
-        $ gem install rake
-
-5) Use the setup script from the repo to install dependencies:
-
-        $ bin/setup
-
-5) Do tests to make sure everything works fine before you start:
-
-        $ rake spec
-
-6) Install dependency gems:
-
-        $ bundle exec rake install
-
-7) Your development environment is now ready. After you have made edits to the code, you can generate a new binary to test the code like this:
-
-        $ rake install
-
-8) You can then run the binary directly from the command line:
-
-        $ sct --help
-
-### Development tips
-
-- To release a new version, update the version number in `version.rb`, and then run:
-
-        $ bundle exec rake release
-
-    This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-### Adding commands
-
- Adding a new command is as simple as adding a new 'Command' Class to the *lib/sct/commands* folder. As long as you implement the constants and methods of  *lib/sct/command_interface.rb*, your new Command will automatically appear in the CLI Help and can be called. Use the *lib/sct/command_option.rb* to define command options. Examples of Command Classes can be found inside the *lib/sct/commands* folder.
-
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://gitlab.com/proactive-software/packages/sct. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## Releasing
-
-#### Ownership
-Owners of the Ruby Gem project are able to release a new version. You can check the ownership status at https://rubygems.org/gems/sct. If you are an owner you can continue with the following steps. If not you may request to become an owner, or ask an existing owner to do the release for you. 
-
-#### Authentication
-Owners should update their credentials once before they can actually release new versions. The steps to do this are:
-```$bash
-curl -u [YOUR-RUBYGEM-USERNAME] https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials
-chmod 0600 ~/.gem/credentials
-```
-
-### Release steps
-#### Update version
-Before releasing you are required to update the version of the new release. You can do this manually by incrementing the value in the file `./sct/lib/sct/version.rb`. After this you need to commit this change and push it to the master branch.
-
-#### Release
-You are now ready to release. You can do this with a simple command in the SCT repository's root directory:
-```$xslt
-rake release
-```
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Sct project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/proactive-software/packages/sct/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/lib/sct.rb

@@ -1,61 +0,0 @@
-require 'sct'
-require "sct/config"
-require 'sct/command'
-require "sct/version"
-require 'colored'
-require 'commander'
-
-module Sct
-  class SctCore
-
-    program :name, 'sct'
-      program :version, Sct::VERSION
-      program :summary, 'CLI helper tool for local SCT development'
-      program :description, 'SCT is a CLI tool for developers using the Visma Continuous Deployment Model in conjunction with the Google Cloud Platform (GCP). It provides multiple command to set up and maintain a kubernetes cluster on a machine for local development'
-
-    def self.take_off(cmds)
-      self.new.run
-      cmds.each { |cmd| registerCommand(cmd) }
-    end
-
-    def run 
-      
-    end
-
-    def self.registerCommand(cmd)
-      # validate Command Class
-      if cmd.class != Class ||
-        !cmd.name.end_with?('Command')
-        return
-      end
-    
-      # validate if Command is meant to be public
-      if !cmd::IS_PUBLIC_COMMAND
-        return
-      end
-    
-      # register public Commands as CLI command
-      command self.deduceCommandNameFromClass(cmd) do |c|
-        c.syntax = cmd::SYNTAX
-        c.summary = cmd::SUMMARY
-        c.description = cmd::DESCRIPTION
-        c.example cmd::EXAMPLE_DESCRIPTION, cmd::EXAMPLE
-        cmd::OPTIONS.each { |option| c.option option.name, option.type, option.description }
-        c.action do |args, options|
-          cmd.new.execute(args, options)
-        end
-      end
-    end
-
-    # retrieves cli command-name from Command's full Class name
-    def self.deduceCommandNameFromClass(c)
-      name = c.name
-      if name.include?('::')
-        name = name.partition('::')[2]
-      end
-      # TODO replace camel-case capitals with '-'
-      return name.chomp('Command').downcase
-    end
-
-  end
-end

data/lib/sct/command_interface.rb

@@ -1,18 +0,0 @@
-require 'class_interface'
-
-class CommandInterface
-  IS_PUBLIC_COMMAND = true | false
-  SYNTAX = String
-  SUMMARY = String
-  DESCRIPTION = String
-  EXAMPLE = String
-  EXAMPLE_DESCRIPTION = String
-  OPTIONS = Array
-
-  def initialize
-  end
-
-  def execute(args, options)
-  end
-
-end

data/lib/sct/command_option.rb

@@ -1,14 +0,0 @@
-module Sct
-
-  class CommandOption
-    attr_reader :name, :type, :description
-
-    def initialize(name, type, description)
-      @name = name
-      @type = type
-      @description = description
-    end
-
-  end
-
-end

data/lib/sct/commands/composer.rb

@@ -1,29 +0,0 @@
-require 'sct/command_interface'
-require 'sct/command_option'
-
-module Sct
-
-  class ComposerCommand
-    
-    IS_PUBLIC_COMMAND = true
-    SYNTAX = 'sct composer'
-    SUMMARY = 'Run composer commands through SCT'
-    EXAMPLE = 'sct composer install'
-    EXAMPLE_DESCRIPTION = 'sct composer install will update the project with the latest dependencies'
-    DESCRIPTION = "sct will run composer commands through the local docker installation"
-    
-    OPTIONS = [
-        CommandOption.new("--verbose", nil, "Increase verbosity of messages."),
-        CommandOption.new("--require STRING", String, "Package to require with a version constraint. Should be in format foo/bar:1.0.0"),
-        CommandOption.new("--require-dev STRING", String, "Development requirements, see --require."),
-        CommandOption.new("-V", nil, "Display this application version.")
-    ]
-
-    def execute(args, options)
-      require "sct/docker/composer"
-      Sct::Composer.exec(ARGV[1..(ARGV.length+1)])
-    end
-
-    implements CommandInterface
-  end
-end

data/lib/sct/commands/init.rb

@@ -1,51 +0,0 @@
-require 'sct/command_interface'
-require 'highline'
-
-module Sct
-
-  class InitCommand
-
-    IS_PUBLIC_COMMAND = true
-    SYNTAX = 'sct init'
-    SUMMARY = 'Initialize a base configuration file for sct'
-    EXAMPLE = 'sct init'
-    EXAMPLE_DESCRIPTION = 'sct init will create a configuration file'
-    DESCRIPTION = "sct init will create a configuration file"
-
-    OPTIONS = []
-
-    def initialize
-    end
-
-    def execute(args, options)
-
-      Sct::Config.dir
-
-      cli = HighLine.new
-
-      email = cli.ask("What is your email address?") { |q|
-          q.validate = URI::MailTo::EMAIL_REGEXP
-      }
-
-      cloud_proxy_path = cli.ask("What is the path of your cloud proxy json credentials?") { |q|
-          q.default = "~/.config/gcloud/application_default_credentials.json"
-      }
-
-      contents = ""
-      contents << "email=#{email}\n"
-      contents << "cloud-proxy-path=#{File.expand_path(cloud_proxy_path)}\n"
-
-      if !File.directory?(Sct::Config.dir)
-          FileUtils.mkdir_p(Sct::Config.dir)
-      end
-
-      File.write(Sct::Config.path, contents)
-
-      puts "Generated config file at #{Sct::Config.path}"
-    end
-
-    implements CommandInterface
-
-  end
-
-end

data/lib/sct/commands/mysqlproxy.rb

@@ -1,38 +0,0 @@
-require 'sct/command_interface'
-require 'sct/command_option'
-require "sct/config"
-require "sct/setup/helpers"
-
-module Sct
-
-  class Mysql_proxyCommand
-    
-    DEFAULT_SECRET_NAME = "gcloud-credentials"
-
-    IS_PUBLIC_COMMAND = true
-    SYNTAX = 'sct mysql_proxy'
-    SUMMARY = 'adds a secret for the mysql proxy'
-    DESCRIPTION = ""
-    EXAMPLE = ""
-    EXAMPLE_DESCRIPTION = ""
-    OPTIONS = []    
-
-    def execute(args, options)
-
-      return puts "SCT has not been initialized. Run 'sct init' first.".red unless Sct::Config.exists
-      
-      path = Sct::Config.get('cloud-proxy-path')
-
-      system("kubectl delete secret gcloud-credentials")
-      system("kubectl create secret generic gcloud-credentials --from-file=#{path}")
-      
-      puts "Authenticated with secret-name: '#{DEFAULT_SECRET_NAME}'".green
-
-      return true
-    end
-
-    implements CommandInterface
-  
-  end
-
-end

data/lib/sct/commands/php.rb

@@ -1,37 +0,0 @@
-require 'sct/command_interface'
-require 'sct/command_option'
-
-module Sct
-
-  class PhpCommand
-    
-    IS_PUBLIC_COMMAND = true
-    SYNTAX = 'sct php'
-    SUMMARY = 'Run php commands through SCT'
-    EXAMPLE = 'sct php -r "echo \'Hello World!\';"'
-    EXAMPLE_DESCRIPTION = 'sct php -r will execute a command directly through the php interpreter'
-    DESCRIPTION = "sct will run php commands through the local docker installation"
-    
-    OPTIONS = [
-        CommandOption.new("-r", String, "Run php code directy through the interpreter"),
-        CommandOption.new("-V", nil, "Get the current php version. Note that it's a capital V. The lowercase v will return the SCT tool version"),
-    ]
-
-    def execute(args, options)
-      require "sct/docker/php"
-
-      # Workaround for the version option being caught by the SCT tool itself
-      args=ARGV[1..(ARGV.length+1)].map { |arg| arg == '-V' ? arg = '-v' : arg}
-
-      # Another workaround for the -r option to add quotes around the value
-      if args.include? '-r'
-        codeIndex = args.index('-r') + 1
-        args[codeIndex] = "\"#{args[codeIndex]}\""
-      end
-
-      Sct::Php.exec(args)
-    end
-
-    implements CommandInterface
-  end
-end

data/lib/sct/commands/yarn.rb

@@ -1,26 +0,0 @@
-require 'sct/command_interface'
-require 'sct/command_option'
-
-module Sct
-
-  class YarnCommand
-    
-    IS_PUBLIC_COMMAND = true
-    SYNTAX = 'sct yarn'
-    SUMMARY = 'Run yarn commands through SCT'
-    EXAMPLE = 'sct yarn dev'
-    EXAMPLE_DESCRIPTION = 'sct yarn dev will start the dev installation of the current project'
-    DESCRIPTION = "sct will run yarn commands through the local docker installation"
-    
-    OPTIONS = [
-        CommandOption.new("--port PORTNUMBER", Integer, "The portnumber on which the server will be deployed")
-    ]
-
-    def execute(args, options)
-      require "sct/docker/yarn"
-      Sct::Yarn.exec(ARGV[1..(ARGV.length+1)])
-    end
-
-    implements CommandInterface
-  end
-end