labclient 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ea1ef7fca86883f565358293520dd1b39484ca9c190e543408d91eba2d2e0e5
-  data.tar.gz: 4d963d0f5b7740d9e514ab3e5bc170576a628e7f8642d59cf6777463cd0c3141
+  metadata.gz: ab2d7a4a0dcf9e876c42f3d92537ad03f6cc9d00391bf574188de36fa5dde3a6
+  data.tar.gz: 9bba10386c15059b97c79a0e6f0ed322af7614736b78e55fd968f362e767dd8e
 SHA512:
-  metadata.gz: b46b5af89a9b7beafd0b7287e7c6047200e748cfedcd72021231823d75885b1551158d4d80227b1a6ba6c09b6024c27a02f63cb0aaefa8ea399c13a669fcaa94
-  data.tar.gz: 5bf022a157f8f3cccdd0776a5e851bfe6a30ad189efcee4da7c3c43bc27cc5eb8ca185d857d165024f83edb17ec992657b4f33cc3a9065a19f2ab15655d9fc67
+  metadata.gz: 8998430e5b8d07584da6fe906d465238fd7725fa0773b9bb11a7b47dc755ce5fcb80d0cbb22055b16327665d70cbd034a24a63d310fabd11bd560c0ebd994f95
+  data.tar.gz: 3e61e5c568a93cfad5955198f6524349a89a06d729ead2d8f98c1d05c78e885edfb9fbb069fee2226731b26a1ab8c0404b857883f745d99c7564280e8f855b4d

data/lib/labclient.rb

@@ -3,7 +3,7 @@ require 'oj'
 require 'pry'
 require 'typhoeus'
 require 'active_support/all'
-require 'awesome_print'
+require 'amazing_print'
 require 'gitlab_chronic_duration'
 require 'ostruct'
 
@@ -13,8 +13,8 @@ require 'labclient/http'
 require 'labclient/access_levels'
 require 'labclient/common'
 require 'labclient/curl'
+require 'labclient/lab_struct'
 require 'labclient/klass'
-require 'labclient/open_struct'
 require 'labclient/class_helpers'
 require 'labclient/paginated_response'
 require 'labclient/error'
@@ -768,6 +768,7 @@ require 'labclient/files/delete'
 # Branches
 require 'labclient/branches/list'
 require 'labclient/branches/show'
+require 'labclient/branches/create'
 require 'labclient/branches/delete'
 require 'labclient/branches/delete_merged'
 require 'labclient/branches/branch'
@@ -844,12 +845,14 @@ require 'labclient/resource_labels/resource_label'
 
 # Generators
 require 'labclient/generator/names'
-require 'labclient/generator/templates/template' # Helper
-require 'labclient/generator/templates/pages'
+require 'labclient/generator/template_helper' # Default Include Template
 
 # Wizard
 require 'labclient/generator/generator'
 require 'labclient/generator/wizard'
 
+# Dynamically Require Templates (Simplify new template creation)
+Dir[File.dirname(__FILE__) + '/labclient/generator/templates/*.rb'].sort.each { |file| require file }
+
 # I am Very Last
 require 'labclient/client'

data/lib/labclient/branches/branch.rb

@@ -11,5 +11,30 @@ module LabClient
     def commit
       Commit.new(@table[:commit], response, client)
     end
+
+    def pipelines
+      project_id = collect_project_id
+      client.pipelines.list(project_id, ref: name)
+    end
+
+    # Wait for Import / Set a Hard Limit
+    def wait_for_pipelines(total_time = 300, sleep_time = 15)
+      Timeout.timeout(total_time) do
+        loop do
+          reload
+          puts 'Waiting for Pipelines'
+          break unless pipelines.empty?
+
+          sleep sleep_time
+        end
+      end
+    end
+
+    help do
+      subtitle 'Branch'
+      option 'commit', 'Show Commit information for branch'
+      option 'pipelines', 'Show Pipelines for this Branch/Ref'
+      option 'wait_for_pipelines', 'Looping, on newly created branches, wait for pipelines to populate (not finish) [Timeout, Interval]'
+    end
   end
 end

data/lib/labclient/branches/create.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Branches < Common
+    doc 'Create' do
+      desc 'Get a list of repository branches from a project, sorted by name alphabetically. [Project ID, String]'
+      example 'client.branches.create(264, branch: :branch, ref: :master)'
+      result '[#<Branch name: feature>, #<Branch name: master>]'
+
+      markdown <<~DOC
+        | Attribute | Type    | Required | Description                                                                                                  |
+        |----------|--------|---------|-------------------------------------------------------------------------------------------------------------|
+        | id      | integer | yes      | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
+        | branch  | string  | yes      | Name of the branch.                                                                                          |
+        | ref     | string  | yes      | Branch name or commit SHA to create branch from.                                                             |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.branch_create(branch: :branch, ref: :master)
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/repository/branches", Branch, query)
+    end
+  end
+end

data/lib/labclient/client.rb

@@ -139,10 +139,10 @@ module LabClient
       resp
     end
 
-    # Assume we want OpenStruct if @klass is ever nil
+    # Assume we want LabStruct if @klass is ever nil
     def process(resp)
       case resp.data
-      when OpenStruct
+      when LabStruct
         klass ? klass.new(resp.data, resp, self) : resp.data
       when Array
         if @klass.nil?

data/lib/labclient/epics/epic.rb

@@ -51,6 +51,15 @@ module LabClient
       client.resource_labels.epics.show(group_id, id, resource_event_id)
     end
 
+    # Notes
+    def notes
+      client.notes.epics.list(group_id, iid)
+    end
+
+    def note_create(query)
+      client.notes.epics.create(group_id, iid, query)
+    end
+
     date_time_attrs %i[created_at closed_at updated_at]
 
     help do
@@ -64,6 +73,10 @@ module LabClient
       option 'issue_remove', 'Remove issue from Epic [Epic Issue ID]'
       option 'issue_update', 'Update issue association [Epic Issue ID, Hash]'
 
+      # Notes
+      option 'notes', 'List notes/comments. [Hash]'
+      option 'note_create', 'Creates a new note. [Hash]'
+
       # Resource Labels
       option 'resource_labels', 'List of all label events'
       option 'resource_label', 'Show single label event [Resource Event ID]'

data/lib/labclient/error.rb

@@ -3,6 +3,7 @@ module LabClient
   # Class Shim
   class Error < StandardError
     attr_reader :resp
+
     def initialize(resp)
       super
       @resp = resp

data/lib/labclient/files/create.rb

@@ -16,15 +16,18 @@ module LabClient
       result '{:file_path=>"new.md", :branch=>"master"}'
 
       markdown <<~DOC
-        **Parameters**:
+        Parameters
+
+        | **Attribute**  | **Required** | **Description**                                 |
+        | -------------- | ------------ | ----------------------------------------------- |
+        | branch         | yes          | Name of the branch                              |
+        | content        | yes          | File content                                    |
+        | start_branch   | no           | Name of the branch to start the new commit from |
+        | encoding       | no           | Change encoding to ‘base64’. Default is text.   |
+        | author_email   | no           | Specify the commit author’s email address       |
+        | author_name    | no           | Specify the commit author’s name                |
+        | commit_message | no           | Commit message                                  |
 
-        * branch (required) - Name of the branch
-        * start_branch (optional) - Name of the branch to start the new commit from
-        * encoding (optional) - Change encoding to ‘base64’. Default is text.
-        * author_email (optional) - Specify the commit author’s email address
-        * author_name (optional) - Specify the commit author’s name
-        * content (required) - File content
-        * commit_message (required) - Commit message
 
       DOC
     end
@@ -43,6 +46,9 @@ module LabClient
     def create(project_id, file_path, query)
       project_id = format_id(project_id)
 
+      # Path Name Encoding
+      file_path = CGI.escape(file_path)
+
       client.request(:post, "projects/#{project_id}/repository/files/#{file_path}", nil, query)
     end
   end

data/lib/labclient/generator/generator.rb

@@ -54,29 +54,17 @@ module LabClient
       end
 
       doc 'Wizard' do
-        title 'Templates'
+        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.pages
+          pages = client.wizard.template(:pages)
           => #<LabClient::Template Pages>
           pages.run! # Run pages template
         DOC
       end
-
-      doc 'Pages' do
-        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
   end
 end

data/lib/labclient/generator/names.rb

@@ -4,20 +4,34 @@ module LabClient
   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.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]/, '') }
@@ -45,8 +59,8 @@ module LabClient
       # 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
-        @project_names = Array.new(rand(count[:projects])) { gen_projects.sample }.uniq
+        @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

data/lib/labclient/generator/template_helper.rb

@@ -0,0 +1,82 @@
+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)
+        # puts "#{@group.name} - #{@group.web_url}"
+        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