This GitHub Action automatically installs azurite (Azure Storage Emulator) on Windows, macOS and Linux.
Azurite provides a free local environment for testing your Azure blob, queue storage, and table storage applications. When you're satisfied with how your application is working locally, you can then switch to using an Azure Storage account in the cloud. The emulator provides cross-platform support on Windows, Linux, and macOS.
Azurite supersedes the Azure Storage Emulator. Azurite will continue to be updated to support the latest versions of Azure Storage APIs - Microsoft docs
Just copy the code below to install and run Azure blob, queue storage, and table storage services over http.
- name: Install Azurite
id: azuright
uses: potatoqualitee/azuright@v1.1By default, blob storage runs over port 10000, queue storage runs over port 10001 and table storage runs over port 10002.
Create a workflow .yml file in your repositories .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.
directory- The workspace location path. The default is the OS temp directory.blob-port- The Blob service listening port. The default port is 10000.queue-port- The Queue service listening port. The default port is 10001.table-port- The Table service listening port, by default 10002.silent- Silent mode disables the access log. The default value is false.loose- Enables loose mode, which ignores unsupported headers and parameters.oauth- Azurite supports basic authentication using oauth which validates the incoming bearer token and checks the issuer, audience, and expiry. Azurite won't check the token signature or permissions.self-signed-cert- Create and trust a self-signed cert forlocalhostto easily enable HTTPS.cert-path- Path to a locally trusted PEM or PFX certificate file path to enable HTTPS mode.cert-password- Password for PFX file. Required when cert-path points to a PFX file.cert-key-path- Path to a locally trusted PEM key file, required when cert-path points to a PEM file.
connstring- a usable connection string to connect to the services
Azurite accepts the same well-known storage account and key and key used by the legacy Azure Storage Emulator.
Account name: devstoreaccount1
Account key: Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==
If you'd like to use alternative credentials, check out this article on custom storage accounts and keys.
In the workflow below, Az.Storage is installed on Linux, Windows and OSX, a self-signed cert is installed then a blob is created over https.
on: [push]
jobs:
test-everywhere:
name: Test Action on all platforms
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, windows-latest, macOS-latest]
steps:
- uses: actions/checkout@v2
- name: Install and cache PowerShell Modules
uses: potatoqualitee/psmodulecache@v4
with:
modules-to-cache: Az.Storage
- name: Install Azurite
id: azuright
uses: potatoqualitee/azuright@v1.1
with:
self-signed-cert: true
- name: Test
shell: pwsh
run: |
Import-Module Az.Storage
$connstring = "${{ steps.azuright.outputs.connstring }}"
$blob = New-Object Azure.Storage.Blobs.BlobContainerClient($connstring, "sample-container")
$blob.CreateIfNotExists()Pull requests are welcome!
The scripts and documentation in this project are released under the MIT License
In macOS Big Sur and above, this action runs sudo security authorizationdb write com.apple.trust-settings.admin allow which allows all users to write to the certificate root store. This is done in order to bypass a new requirement for interactive approval to add certificates to the root store, which is great when you are sitting at your computer, but not when you're running commands non-interactively (like within a GitHub Runner).
Also, if you're curious about what's installed on GitHub runners, check out their docs page.