percy-appium-app 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba54dc346521591705be68354e98b25018a98a1af988b9d05c7b3e6d6120b92f
+  data.tar.gz: 5fe4abc08f138a09c1f5c95f327f9bebb8c9d4f7899cd0ffbe233d2d95cb5e86
+SHA512:
+  metadata.gz: 5434a1ce14329a48bf5411050de8c466ec40e77f3545fa159d566d077d28d88ce027a7ed87ea3a3cf0cc6a851350376a7218d93e6250de93cc165e5ba6179196
+  data.tar.gz: 2a8f9febe81d0490ed25d4f8bca3a2b24851a62d5c51ea33527629e72e810de9a4e0e94593f88727ffe42c25237c43aab785529d1e7bb4d24b5fd81488fedd8e

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,55 @@
+---
+name: Bug report
+about: Create a report to help us fix the issue
+title: ''
+labels: ''
+assignees: ''
+---
+
+<!--
+## Have you read the "Debugging SDKs" doc yet?
+
+There are common setup gotchas that happen with Percy's SDKs, it would be worth reading
+the debugging document, which might already answer your question:
+https://docs.percy.io/docs/debugging-sdk
+
+## Reach out to Percy support instead?
+
+If you’re having issues that _aren’t SDK bugs_, it would be best for you to
+reach out to support instead: support@percy.io or
+https://www.browserstack.com/contact#technical-support
+-->
+
+## The problem
+
+Briefly describe the issue you are experiencing (or the feature you want to see
+added to Percy). Tell us what you were trying to do and what happened
+instead. Remember, this is _not_ a place to ask questions. For that, go to
+https://github.com/percy/cli/discussions/new
+
+## Environment
+
+- Node version:
+- `@percy/cli` version:
+- Version of Percy SDK you’re using:
+- If needed, a build or snapshot ID:
+- OS version:
+- Type of shell command-line [interface]:
+
+## Details
+
+If necessary, describe the problem you have been experiencing in more detail.
+
+## Debug logs
+
+If you are reporting a bug, _always_ include logs! [Give the "Debugging SDKs"
+document a quick read for how to gather logs](https://docs.percy.io/docs/debugging-sdks#debugging-sdks)
+
+Please do not trim or edit these logs, often times there are hints in the full
+logs that help debug what is going on.
+
+## Code to reproduce issue
+
+Given the nature of testing/environment bugs, it’s best to try and isolate the
+issue in a reproducible repo. This will make it much easier for us to diagnose
+and fix.

data/.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: /
+  schedule:
+    interval: weekly
+  commit-message:
+    prefix: ⬆️
+- package-ecosystem: bundler
+  directory: /
+  schedule:
+    interval: weekly
+  commit-message:
+    prefix: ⬆️

data/.github/release-drafter.yml

@@ -0,0 +1,28 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '💥 Breaking Changes'
+    labels:
+      - 💥 breaking
+  - title: '✨ Enhancements'
+    labels:
+      - ✨ enhancement
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 🐛 bug
+  - title: '🏗 Maintenance'
+    labels:
+      - 🧹 maintenance
+  - title: '⬆️⬇️ Dependency Updates'
+    labels:
+      - ⬆️⬇️ dependencies
+change-title-escapes: '\<*_&#@'
+version-resolver:
+  major:
+    labels:
+      - 💥 breaking
+  minor:
+    labels:
+      - ✨ enhancement
+  default: patch
+template: '$CHANGES'

data/.github/workflows/Semgrep.yml

@@ -0,0 +1,48 @@
+# Name of this GitHub Actions workflow.
+name: Semgrep
+
+on:
+  # Scan changed files in PRs (diff-aware scanning):
+  # The branches below must be a subset of the branches above
+  pull_request:
+    branches: ["master", "main"]
+  push:
+    branches: ["master", "main"]
+  schedule:
+    - cron: '0 6 * * *'
+
+
+permissions:
+  contents: read
+
+jobs:
+  semgrep:
+    # User definable name of this GitHub Actions job.
+    permissions:
+      contents: read  # for actions/checkout to fetch code
+      security-events: write  # for github/codeql-action/upload-sarif to upload SARIF results
+    name: semgrep/ci 
+    # If you are self-hosting, change the following `runs-on` value: 
+    runs-on: ubuntu-latest
+
+    container:
+      # A Docker image with Semgrep installed. Do not change this.
+      image: returntocorp/semgrep
+
+    # Skip any PR created by dependabot to avoid permission issues:
+    if: (github.actor != 'dependabot[bot]')
+
+    steps:
+      # Fetch project source with GitHub Actions Checkout.
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+      # Run the "semgrep ci" command on the command line of the docker image.
+      - run: semgrep ci --sarif --output=semgrep.sarif
+        env:
+            # Add the rules that Semgrep uses by setting the SEMGREP_RULES environment variable. 
+            SEMGREP_RULES: p/default # more at semgrep.dev/explore
+
+      - name: Upload SARIF file for GitHub Advanced Security Dashboard
+        uses: github/codeql-action/upload-sarif@6c089f53dd51dc3fc7e599c3cb5356453a52ca9e # v2.20.0
+        with:
+          sarif_file: semgrep.sarif
+        if: always()

data/.github/workflows/changelog.yml

@@ -0,0 +1,11 @@
+name: Changelog
+on:
+  push:
+    branches: [main]
+jobs:
+  update_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+          bundler-cache: true
+      - uses: actions/cache@v2
+        with:
+          path: "./vendor/bundle"
+          key: v1/${{ runner.os }}/ruby-2.6/${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: v1/${{ runner.os }}/ruby-2.6/
+      - uses: cadwallion/publish-rubygems-action@master
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RELEASE_COMMAND: make release

data/.github/workflows/stale.yml

@@ -0,0 +1,30 @@
+name: 'Close stale issues and PRs'
+on:
+  schedule:
+    - cron: '0 19 * * 2'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v4
+        with:
+          stale-issue-message: >-
+            This issue is stale because it has been open for more than 14 days with no activity.
+            Remove stale label or comment or this will be closed in 14 days.
+          stale-pr-message: >-
+            This PR is stale because it has been open for more than 14 days with no activity.
+            Remove stale label or comment or this will be closed in 14 days.
+          close-issue-message: >-
+            This issue was closed because it has been stalled for 28 days with no activity.
+          close-pr-message: >-
+            This PR was closed because it has been stalled for 28 days with no activity.
+          days-before-issue-stale: 14
+          days-before-pr-stale: 14
+          # close 14 days _after_ initial warning
+          days-before-issue-close: 14
+          days-before-pr-close: 14
+          exempt-pr-labels: '❄️ on ice'
+          exempt-issue-labels: '🐛 bug,❄️ on ice,✨ enhancement'
+          exempt-all-assignees: true
+          stale-pr-label: '🍞 stale'

data/.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Test
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+    inputs:
+      branch:
+        required: false
+        type: string
+        default: master
+jobs:
+  test:
+    name: Test
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        ruby: ['2.6', '2.7', '3.0']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions-ecosystem/action-regex-match@v2
+        id: regex-match
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        with:
+          text: ${{ github.event.inputs.branch }}
+          regex: '^[a-zA-Z0-9_/\-]+$'
+      - name: Break on invalid branch name
+        run: exit 1
+        if: ${{ github.event_name == 'workflow_dispatch' && steps.regex-match.outputs && steps.regex-match.outputs.match == '' }}
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
+      - uses: actions/cache@v2
+        with:
+          path: "./vendor/bundle"
+          key: v1/${{ runner.os }}/ruby-${{ matrix.ruby }}/${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: v1/${{ runner.os }}/ruby-${{ matrix.ruby }}/
+      - run: bundle install
+      - run: for file in specs/*.rb; do ruby $file; done

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'appium_console'
+gem 'appium_lib'
+gem 'dotenv'
+gem 'minitest'
+gem 'rubocop', require: false
+gem 'tempfile'
+gem 'webmock', '~> 3.18', '>= 3.18.1'
+gem 'webrick', '~> 1.3', '>= 1.3.1'
+gem 'rake', '~> 13.0'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Percy
+
+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/Makefile

@@ -0,0 +1,3 @@
+release:
+	rake build
+	gem push pkg/percy-appium-app-*

data/README.md

@@ -0,0 +1 @@
+# percy-appium-ruby

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/percy/common/common.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'dotenv/load'
+
+PERCY_LOGLEVEL = ENV['PERCY_LOGLEVEL']
+PERCY_DEBUG = PERCY_LOGLEVEL == 'debug'
+LABEL = "[\e[35m#{PERCY_DEBUG ? 'percy:ruby' : 'percy'}\e[39m]"
+
+def log(message, on_debug: nil)
+  return unless on_debug.nil? || (on_debug.is_a?(TrueClass) && PERCY_DEBUG)
+
+  puts "#{LABEL} #{message}"
+end
+
+def hashed(object)
+  return object.as_json unless object.is_a?(Hash)
+
+  object
+end

data/percy/configs/devices.json

@@ -0,0 +1,232 @@
+{
+   "iphone 12 pro max": {
+      "scale_factor": "3",
+      "status_bar": "47"
+   },
+   "iphone 12 pro": {
+      "scale_factor": "3",
+      "status_bar": "47"
+   },
+   "iphone 12 mini": {
+      "scale_factor": "3",
+      "status_bar": "50"
+   },
+   "iphone 12": {
+      "scale_factor": "3",
+      "status_bar": "47"
+   },
+   "iphone 11 pro max": {
+      "scale_factor": "3",
+      "status_bar": "44"
+   },
+   "iphone 11 pro": {
+      "scale_factor": "3",
+      "status_bar": "44"
+   },
+   "iphone 11": {
+      "scale_factor": "2",
+      "status_bar": "48"
+   },
+   "iphone xs": {
+      "scale_factor": "3",
+      "status_bar": "44"
+   },
+   "iphone xs max": {
+      "scale_factor": "3",
+      "status_bar": "44"
+   },
+   "iphone xr": {
+      "scale_factor": "2",
+      "status_bar": "48"
+   },
+   "iphone x": {
+      "scale_factor": "3",
+      "status_bar": "44"
+   },
+   "iphone 8": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "iphone 8 plus": {
+      "scale_factor": "3",
+      "status_bar": "20"
+   },
+   "iphone 7": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "iphone 6s": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "iphone 6 plus": {
+      "scale_factor": "3",
+      "status_bar": "20"
+   },
+   "iphone 6s plus": {
+      "scale_factor": "3",
+      "status_bar": "20"
+   },
+   "iphone 6": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "iphone se 2022": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "iphone se 2020": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "iphone se": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad air 4": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad 9th": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad 10th": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad air 5": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad pro 12.9 2022": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad pro 12.9 2021": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad pro 12.9 2020": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad pro 11 2021": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad pro 11 2022": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad 8th": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad pro 12.9 2018": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad mini 2021": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad pro 11 2020": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad mini 2019": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad air 2019": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad 7th": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad pro 11 2018": {
+      "scale_factor": "2",
+      "status_bar": "24"
+   },
+   "ipad pro 9.7 2016": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad pro 12.9": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad mini 4": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad 6th": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "ipad 5th": {
+      "scale_factor": "2",
+      "status_bar": "20"
+   },
+   "google pixel 6 pro": {
+      "12": {
+         "status_bar": "143",
+         "nav_bar": "56"
+      },
+      "13": {
+         "status_bar": "130",
+         "nav_bar": "84"
+      }
+   },
+   "samsung galaxy s22 plus": {
+      "12": {
+         "status_bar": "74",
+         "nav_bar": "135"
+      }
+   },
+   "samsung galaxy s21": {
+      "12": {
+         "status_bar": "80",
+         "nav_bar": "144"
+      }
+   },
+   "samsung galaxy s22 ultra": {
+      "12": {
+         "status_bar": "75",
+         "nav_bar": "135"
+      }
+   },
+   "samsung galaxy s22": {
+      "12": {
+         "status_bar": "81",
+         "nav_bar": "144"
+      }
+   },
+   "samsung galaxy tab s8": {
+      "12": {
+         "status_bar": "51",
+         "nav_bar": "102"
+      }
+   },
+   "google pixel 5": {
+      "12": {
+         "status_bar": "145",
+         "nav_bar": "44"
+      }
+   },
+   "google pixel 6": {
+      "12": {
+         "status_bar": "124",
+         "nav_bar": "42"
+      }
+   },
+   "google pixel 7": {
+      "13": {
+         "status_bar": "118",
+         "nav_bar": "63"
+      }
+   }
+}

data/percy/environment.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'appium_lib'
+require 'appium_lib/version'
+require_relative 'version'
+
+class Environment
+  @percy_build_id = nil
+  @percy_build_url = nil
+  @session_type = nil
+
+  class << self
+    attr_accessor :percy_build_id, :percy_build_url, :session_type
+
+    def get_client_info(flag = false)
+      sdk_version = SDK_VERSION
+      flag ? "percy-appium-app-ruby/#{sdk_version}" : "percy-appium-app/#{sdk_version}"
+    end
+
+    def get_env_info
+      appium_version = Appium::VERSION # This assumes the 'appium_lib' gem provides a VERSION constant.
+      ["appium/#{appium_version}", "ruby/#{RUBY_VERSION}"]
+    end
+  end
+end

data/percy/exceptions/exceptions.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class BaseException < StandardError; end
+
+class UnsupportedDevice < BaseException; end
+
+class UnknownProvider < BaseException; end
+
+class PlatformNotSupported < BaseException; end
+
+class DriverNotSupported < BaseException; end
+
+class CLIException < StandardError; end

data/percy/lib/app_percy.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'appium_lib'
+require_relative '../exceptions/exceptions'
+require_relative 'percy_options'
+require_relative '../providers/provider_resolver'
+require_relative '../metadata/metadata_resolver'
+
+class AppPercy
+  attr_accessor :metadata, :provider
+
+  def initialize(driver)
+    raise DriverNotSupported unless driver.is_a?(Appium::Core::Base::Driver)
+
+    @driver = driver
+    @metadata = MetadataResolver.resolve(@driver)
+    @provider = ProviderResolver.resolve(@driver)
+    @percy_options = PercyOptions.new(@metadata.capabilities)
+  end
+
+  def screenshot(name, **kwargs)
+    return nil unless @percy_options.enabled
+
+    raise TypeError, 'Argument name should be a String' unless name.is_a?(String)
+
+    device_name = kwargs[:device_name]
+    raise TypeError, 'Argument device_name should be a String' if device_name && !device_name.is_a?(String)
+
+    fullscreen = kwargs[:full_screen]
+    if fullscreen && !fullscreen.is_a?(TrueClass) && !fullscreen.is_a?(FalseClass)
+      raise TypeError,
+            'Argument fullscreen should be a Boolean'
+    end
+
+    status_bar_height = kwargs[:status_bar_height]
+    if status_bar_height && !status_bar_height.is_a?(Integer)
+      raise TypeError,
+            'Argument status_bar_height should be an Integer'
+    end
+
+    nav_bar_height = kwargs[:nav_bar_height]
+    raise TypeError, 'Argument nav_bar_height should be an Integer' if nav_bar_height && !nav_bar_height.is_a?(Integer)
+
+    orientation = kwargs[:orientation]
+    if orientation && !orientation.is_a?(String)
+      raise TypeError,
+            'Argument orientation should be a String and portrait/landscape'
+    end
+
+    @provider.screenshot(name, **kwargs)
+    nil
+  end
+
+  attr_reader :percy_options
+end