labclient 0.1.1 → 0.2.0

data/lib/labclient/generator/generator.rb

@@ -0,0 +1,70 @@
+# The glorious gitlab labclient of labs
+module LabClient
+  # Generator Namespace
+  module Generator
+    # Docs for the wizard
+    class GeneratorDocs
+      @group_name = 'Wizard'
+      extend Docs
+
+      doc 'Wizard' do
+        markdown <<~DOC
+          <h6 style="color:red"><b>Experimental</b></h6>
+
+          This is experimental and will be likely changing frequently and dramatically. This will create (*potentially many*) and manipulate objects within GitLab. **This is not recommended for use in production environments**
+        DOC
+      end
+
+      doc 'Wizard' do
+        title 'About'
+        markdown <<~DOC
+          The Wizard is designed to help setup test instances, and provide easy mechanisms for populating and testing GitLab features.
+
+          Requires 'faker' to function, which will need to be manually/added installed, as it is not a depdenency of the gem.
+        DOC
+
+        example 'gem install faker'
+      end
+
+      doc 'Wizard' do
+        title 'Client'
+        desc <<-DOC
+          The wizard client will self-populate with defaults and parameters from the main client object. But each can be manually configured.
+        DOC
+
+        example <<~DOC
+          wizard = client.wizard
+          => #<Wizard count={:users=>20, :projects=>5, :groups=>5, :issues=>2}, random=true, domain=labclient>
+
+          # Disable Random
+          wizard.random = false
+        DOC
+      end
+
+      doc 'Wizard' do
+        markdown <<~DOC
+          | Setting           | Type    | Description                                            |
+          | ----------------- | ------- | ------------------------------------------------------ |
+          | random            | Boolean | Run Populate. Setup random Users, Projects, and Groups |
+          | count             | Hash    | Settings for random. User, Project, Group count        |
+          | password          | String  | Default password for generated Users                   |
+          | domain            | String  | Defaults to client url. Default email domain for users |
+          | skip_confirmation | Boolean | Enable/Disable skip_confirmation on new users          |
+        DOC
+      end
+
+      doc 'Wizard' do
+        title 'Run one templates'
+        desc <<-DOC
+          Outside of the wizard at large, you can also select and manually run specific templates.
+        DOC
+
+        example <<~DOC
+          pages = client.wizard.template(:pages)
+          => #<LabClient::Template Pages>
+          pages.run! # Run pages template
+        DOC
+      end
+    end
+  end
+end

data/lib/labclient/generator/names.rb

@@ -0,0 +1,68 @@
+# Name Generator
+module LabClient
+  # Helper to Generate Data / Populate GitLab
+  module Generator
+    # Name Helper
+    module Names
+      def create_file(content, branch = :master, message = nil)
+        {
+          branch: branch,
+          commit_message: message || gen_description,
+          content: content
+        }
+      end
+
+      def gen_groups
+        [
+          Faker::Games::LeagueOfLegends.location,
+          Faker::Movies::LordOfTheRings.location,
+          Faker::TvShows::RickAndMorty.location,
+          Faker::TvShows::StarTrek.location,
+          Faker::Games::ElderScrolls.region,
+          Faker::Games::ElderScrolls.city,
+          Faker::Games::Zelda.location,
+          Faker::Games::SuperSmashBros.stage
+        ].map { |x| x.gsub(/[^0-9A-Za-z]/, '') }
+      end
+
+      def gen_projects
+        [
+          Faker::Games::ElderScrolls.creature,
+          Faker::Movies::LordOfTheRings.location,
+          Faker::Games::LeagueOfLegends.summoner_spell,
+          Faker::Games::Pokemon.move,
+          Faker::TvShows::RickAndMorty.location,
+          Faker::Games::LeagueOfLegends.masteries,
+          Faker::Superhero.power
+        ].map { |x| x.gsub(/[^0-9A-Za-z]/, '') }
+      end
+
+      def gen_people
+        [
+          Faker::Movies::LordOfTheRings.character,
+          Faker::Games::WorldOfWarcraft.hero,
+          Faker::TvShows::StarTrek.character,
+          Faker::Games::LeagueOfLegends.champion,
+          Faker::Movies::PrincessBride.character
+        ]
+      end
+
+      def gen_description
+        [
+          Faker::Hacker.say_something_smart,
+          Faker::Games::LeagueOfLegends.quote,
+          Faker::Company.bs,
+          Faker::Movies::PrincessBride.quote
+        ].sample
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def generate_names
+        @user_names = Array.new(count[:users]) { gen_people }.flatten.uniq.sample(count[:users])
+        @group_names = Array.new(count[:groups]) { gen_groups }.flatten.uniq.sample(count[:groups])
+        @project_names = Array.new(count[:projects]) { gen_projects }.flatten.uniq.sample(count[:projects])
+      end
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/labclient/generator/template_helper.rb

@@ -0,0 +1,81 @@
+module LabClient
+  module Generator
+    # Public Method Helpers
+    module TemplateMethods
+      extend ActiveSupport::Concern
+
+      @group_prefix = 'Environment'
+
+      class_methods do
+        def template_name
+          name.demodulize.underscore.to_sym
+        end
+      end
+    end
+
+    # Common Helper Class
+    class TemplateHelper
+      include TemplateMethods
+
+      attr_reader :client
+      attr_accessor :opts
+
+      def inspect
+        "#<LabClient::Template #{self.class.to_s.demodulize}>"
+      end
+
+      def initialize(client, opts = {})
+        @client = client
+        self.opts = opts
+        setup
+      end
+
+      def setup
+        # Blank Place Holder
+      end
+    end
+
+    # ====================================================
+    # Helper for  Common Group/Project Templates
+    # - Create Group, @group
+    # - Execute any `setup_` methods
+    # - Print all @projects, and @group
+    class GroupTemplateHelper < TemplateHelper
+      @group_prefix = 'Environment'
+      include Names
+      attr_accessor :group_name, :group_path, :group_suffix, :project_name
+
+      def run!
+        puts "Running: #{group_suffix}"
+        generate_group
+
+        # Run `setup_` prefixed classes
+        self.class.instance_methods.grep(/setup_/).each { |x| send(x) }
+
+        # Print Created Groups/Project
+        puts "#{@group.name} - #{@group.web_url}"
+        @projects.each do |project|
+          puts " - #{project.name} - #{project.web_url}"
+        end
+
+        {
+          group: @group,
+          projects: @projects
+        }
+      end
+
+      def setup
+        self.group_suffix = self.class.name.demodulize
+        self.group_name = opts[:group_name] || "#{gen_groups.sample} #{group_suffix}"
+        self.group_path = opts[:group_path] || group_name.downcase.gsub(' ', '-')
+
+        @projects = []
+      end
+
+      def generate_group
+        @group = client.groups.create(name: group_name, path: group_path)
+        raise 'Unable to Create Group' unless @group.success?
+      end
+    end
+  end
+end

data/lib/labclient/generator/templates/environments.rb

@@ -0,0 +1,98 @@
+module LabClient
+  module Generator
+    # Docs for the wizard
+    class GeneratorDocs
+      doc 'Templates' do
+        title 'Environments'
+        markdown <<~DOC
+          - On Stop: Create environment on new branch. Stop environment on merge
+
+          | Setting    | Default   | Type    | Description                            |
+          | ---------- | --------- | ------- | -------------------------------------- |
+          | group_name | Generated | String  | Parent Group name for pages projects   |
+          | group_path | Generated | String  | Parent Group path                      |
+        DOC
+      end
+    end
+
+    # Child and other Trigger Examples
+    # https://docs.gitlab.com/ee/ci/yaml/#trigger
+    class Environments < GroupTemplateHelper
+      def on_stop_yaml
+        <<~YAML
+          image: busybox:latest
+
+          build:
+            stage: build
+            script:
+              - echo "Build on both master and branches"
+
+          branch-review:
+            stage: deploy
+            environment:
+              name: ${CI_COMMIT_REF_NAME}
+              on_stop: review-teardown
+            script:
+              - echo "branch-review"
+            only:
+              - branches
+            except:
+              - master
+
+          review-teardown:
+            stage: deploy
+            when: manual
+            variables:
+              GIT_STRATEGY: none
+            environment:
+              name: ${CI_COMMIT_REF_NAME}
+              action: stop
+            script:
+              - echo "review-teardown"
+            only:
+              - branches
+            except:
+              - master
+        YAML
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def setup_master_branch_environment_on_stop
+        project = @group.project_create(
+          name: 'On Stop',
+          description: 'Environments created on non-master branches, stopped on merge',
+          auto_devops_enabled: false,
+          only_allow_merge_if_pipeline_succeeds: true
+        )
+
+        # Create Parent
+        project.file_create('README.md', create_file("# #{project.name}"))
+
+        # # Create Branch
+        project.branch_create(branch: :branch, ref: :master)
+
+        # Create Branch Files
+        project.file_create('.gitlab-ci.yml', create_file(on_stop_yaml, :branch))
+
+        # Create Merge Request
+        merge_request = project.merge_request_create(
+          title: 'Merge Test Branch!',
+          source_branch: :branch,
+          target_branch: :master
+        )
+
+        # Wait for Merge
+        merge_request.wait_for_merge_status
+
+        # Merge
+        merge_request.accept(
+          should_remove_source_branch: true,
+          merge_when_pipeline_succeeds: true
+        )
+
+        @projects.push project
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+  end
+end

data/lib/labclient/generator/templates/pages.rb

@@ -0,0 +1,67 @@
+module LabClient
+  module Generator
+    # Docs for the wizard
+    class GeneratorDocs
+      doc 'Templates' do
+        title 'Pages'
+        markdown <<~DOC
+          Create GitLab Pages group and test projects. Projects imported from Gitlab's [demo pages projects](https://gitlab.com/pages)
+
+          | Setting    | Default   | Type    | Description                            |
+          | ---------- | --------- | ------- | -------------------------------------- |
+          | group_name | Generated | String  | Parent Group name for pages projects   |
+          | group_path | Generated | String  | Parent Group path                      |
+          | count      | 5         | Integer | Number of projects to import (max: 28) |
+        DOC
+      end
+    end
+
+    # Page Import Creation
+    class Pages < GroupTemplateHelper
+      attr_accessor :count
+
+      # All Available Pages Projects
+      def list
+        %w[
+          brunch doxygen emacs-reveal frozen-flask gatsby
+          gitbook hakyll harp hexo hugo hyde ikiwiki
+          jekyll jigsaw lektor metalsmith
+          middleman mkdocs nanoc nikola nuxt octopress
+          org-mode pelican plain-html sphinx vuepress zim
+        ]
+      end
+
+      def setup
+        super
+        self.count = opts[:count] || 5
+      end
+
+      def generate_project(name)
+        @group.project_create(
+          name: name,
+          description: "#{name} Pages",
+          import_url: "https://gitlab.com/pages/#{name}.git"
+        )
+      end
+
+      def generate_pipelines
+        @projects.each do |project|
+          project.pipeline_create(ref: :master)
+        end
+      end
+
+      def wait_for_import
+        @projects.each(&:wait_for_import)
+      end
+
+      def setup_projects
+        @projects = list.sample(count).map do |name|
+          generate_project(name)
+        end
+
+        wait_for_import
+        generate_pipelines
+      end
+    end
+  end
+end

data/lib/labclient/generator/templates/pipeline_trigger.rb

@@ -0,0 +1,82 @@
+module LabClient
+  module Generator
+    # Docs for the wizard
+    class GeneratorDocs
+      doc 'Templates' do
+        title 'Pipeline Triggers'
+        markdown <<~DOC
+          Create GitLab Pipeline Triggers group and test projects.
+
+          - Child Pipeline: Parent pipeline with artifact, that is then executed as a child pipeline
+
+          | Setting    | Default   | Type    | Description                            |
+          | ---------- | --------- | ------- | -------------------------------------- |
+          | group_name | Generated | String  | Parent Group name for pages projects   |
+          | group_path | Generated | String  | Parent Group path                      |
+        DOC
+      end
+    end
+
+    # Child and other Trigger Examples
+    # https://docs.gitlab.com/ee/ci/yaml/#trigger
+    class PipelineTrigger < GroupTemplateHelper
+      def setup_projects
+        create_child_pipeline
+      end
+
+      def trigger_child_pipeline_yaml
+        <<~YAML
+          image: busybox:latest
+
+          build_child:
+            stage: build
+            script:
+              - cp child_pipeline.yml artifact.yml
+            artifacts:
+              paths:
+                - artifact.yml
+
+          trigger_child:
+            stage: deploy
+            trigger:
+              include:
+                - artifact: artifact.yml
+                  job: build_child
+
+        YAML
+      end
+
+      def child_pipeline_yaml
+        <<~YAML
+          image: busybox:latest
+
+          child:
+            script:
+              - echo "Do your build here"
+        YAML
+      end
+
+      def create_child_pipeline
+        project = @group.project_create(
+          name: 'Child Pipeline',
+          description: 'Child Pipeline',
+          auto_devops_enabled: false
+        )
+
+        # Create Child
+        project.file_create(
+          'child_pipeline.yml',
+          create_file(child_pipeline_yaml)
+        )
+
+        # Create Parent
+        project.file_create(
+          '.gitlab-ci.yml',
+          create_file(trigger_child_pipeline_yaml)
+        )
+
+        @projects.push project
+      end
+    end
+  end
+end