code-engine-tasks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0afbe9dc72c13a1216b539a9d1c1aa5845b42182bfc57fd701ec2512860d84ff
+  data.tar.gz: 0ecda8ab04be69e5e4e7625151cee45eba0e3befcc4406773057d69be4235fa3
+SHA512:
+  metadata.gz: 3659ea84d50a033e404d0e2dd8ca0009f09bc947e514f3e5875493027891ee7faf10f60046298f1225ac7a9ecc29b56f76dc6deaa0c1eb91cc5f079b5e073d82
+  data.tar.gz: 0a099ae7370c262d147151e7acc13a7a23bcc87b4115e88c3dd6da370b5f68f601f305921beb586536f63001c8a5c5903412e23c5934a2ed6ece477da36fc206

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    code-engine-tasks (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.43.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  code-engine-tasks!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Steffen Uhlig
+
+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.markdown

@@ -0,0 +1,64 @@
+# CodeEngine Rake Tasks
+
+A collection of Rake tasks for working with IBM Cloud Code Engine projects
+
+# Installation
+
+1. Add the gem to your project:
+
+   ```command
+   $ bundle add code-engine-tasks
+   ```
+
+1. Require the gem in your `Rakefile`:
+
+   ```ruby
+   require 'code_engine/tasks'
+   ```
+
+# Prerequisites
+
+The following envrionment variables need to be set:
+
+```command
+export CE_ACCOUNT=XXXXXXXX1234YYYYYYYY5678ZZZZZZZZ
+export CE_PROJECT=presentations
+export CE_APP=concourse-resource-presentation
+export CE_REGION=eu-de
+```
+
+Optionally, `CE_RESOURCE_GROUP` can be set; it defaults to `default`.
+
+How to get these values:
+
+* `CE_ACCOUNT` - running `ibmcloud account list` and use the "Account GUID" of the account the project resides in
+* `CE_REGION` - the region where your Code Engine app should run in (use `rake ce:regions` or check [the list](https://cloud.ibm.com/docs/codeengine?topic=codeengine-regions) for possible values)
+* `CE_PROJECT` - the name of your Code Engine project. Find existing ones with `ibmcloud ce project list` or provide the name for a new one, which will be created.
+* `CE_APP` - the name of your Code Engine app. Find existing ones with `ibmcloud ce application list` or provide the name for a new one, which will be created.
+
+# Usage
+
+> All Rake tasks have documentation; use `rake --tasks` to show it.
+
+If the app does not already exist, create a new one with
+
+```command
+$ rake ce:app:create
+```
+
+Subsequent updates of the app can be performed with
+
+```command
+$ rake ce:app:update
+```
+
+The URL of the app can be shown with
+
+```command
+$ rake ce:app:url
+```
+
+# TODO
+
+- cli tool to generate a boilerplate project (`ce init --type static-web-app`)
+

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/code-engine-tasks.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/code_engine/tasks/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "code-engine-tasks"
+  spec.version = CodeEngine::Tasks::VERSION
+  spec.authors = ["Steffen Uhlig"]
+  spec.email = ["Steffen.Uhlig@de.ibm.com"]
+
+  spec.summary = "Rake tasks for working with IBM Cloud Code Engine"
+  spec.description = "A collection of Rake tasks for working with IBM Cloud Code Engine projects."
+  spec.homepage = "https://github.com/suhlig/code-engine-tasks"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/code_engine/tasks/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CodeEngine
+  module Tasks
+    VERSION = "1.0.0"
+  end
+end

data/lib/code_engine/tasks.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative "tasks/version"
+
+module CodeEngine
+  # Rake tasks
+  module Tasks
+  end
+end
+
+CE_ACCOUNT = ENV.fetch("CE_ACCOUNT")
+CE_REGION = ENV.fetch("CE_REGION")
+CE_PROJECT = ENV.fetch("CE_PROJECT")
+CE_APP = ENV.fetch("CE_APP")
+CE_RESOURCE_GROUP = ENV.fetch("CE_RESOURCE_GROUP", "default")
+
+namespace :ce do
+  namespace :account do
+    desc "Target IBM Cloud account '#{CE_ACCOUNT}'"
+    task :target do
+      sh "ibmcloud target -g #{CE_RESOURCE_GROUP} -r #{CE_REGION} -c #{CE_ACCOUNT}"
+    end
+  end
+
+  desc "List regions where CE is available"
+  task :regions do
+    sh <<~HEREDOC.tr("\n", "").squeeze(" ").strip
+      ibmcloud catalog service codeengine --output json
+      | jq --raw-output
+        ' .[]
+          | select(.name == "codeengine")
+          | .children
+          | select(.[].kind == "plan")
+          | .[].children
+          | select(.[].kind == "deployment")
+          | .[].metadata.deployment.location'
+      | sort -u
+    HEREDOC
+  end
+
+  namespace :project do
+    desc "Create CE project '#{CE_PROJECT}'"
+    task :create do
+      sh "ibmcloud ce project create --name #{CE_PROJECT}"
+    end
+
+    desc "Fail if CE project '#{CE_PROJECT}' does not exist"
+    task exists: %i[account:target] do
+      sh "ibmcloud ce project get --name #{CE_PROJECT}", %i[out err] => "/dev/null"
+    rescue StandardError
+      abort "Error: The check for CE project #{CE_PROJECT} failed. You can create it with `rake ce:project:create`."
+    end
+  end
+
+  namespace :app do
+    desc "Create CE app '#{CE_APP}' in project '#{CE_PROJECT}'"
+    task create: %i[project:exists] do
+      sh "ibmcloud ce project target --name #{CE_PROJECT}"
+      sh "ibmcloud ce application create --name #{CE_APP} --build-source ."
+    end
+
+    desc "Show URL of CE app '#{CE_APP}' in project '#{CE_PROJECT}'"
+    task url: %i[app:exists] do
+      sh "ibmcloud ce application get --name #{CE_APP} -o json | jq --raw-output .status.url"
+    end
+
+    desc "Fail if CE app '#{CE_APP}' does not exist"
+    task exists: %i[project:exists] do
+      sh "ibmcloud ce application get --name #{CE_APP}", %i[out err] => "/dev/null"
+    rescue StandardError
+      abort "Error: The check for CE app '#{CE_APP}' failed. You can create it with `rake ce:app:create`."
+    end
+
+    desc "Update CE app '#{CE_APP}'"
+    task update: %i[app:exists] do
+      sh "ibmcloud ce application update --name #{CE_APP} --build-source ."
+    end
+  end
+end
+
+at_exit do
+  warn "\nCheck the messages above for errors.\n" if $! && !$!.success?
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: code-engine-tasks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steffen Uhlig
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-05 00:00:00.000000000 Z
+dependencies: []
+description: A collection of Rake tasks for working with IBM Cloud Code Engine projects.
+email:
+- Steffen.Uhlig@de.ibm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- code-engine-tasks.gemspec
+- lib/code_engine/tasks.rb
+- lib/code_engine/tasks/version.rb
+homepage: https://github.com/suhlig/code-engine-tasks
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/suhlig/code-engine-tasks
+  source_code_uri: https://github.com/suhlig/code-engine-tasks
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Rake tasks for working with IBM Cloud Code Engine
+test_files: []