Az Codez

Creating database tables and adding data in Magento 2 Adobe Commerce

Asrin Dayananda — Sat, 06 Aug 2022 19:39:54 GMT

Create a db schema

Reference https://devdocs.magento.com/guides/v2.4/extension-dev-guide/declarative-schema/db-schema.html
Path will be a similar path to this app\code\AzCodez\CustomerViewing\etc\db_schema.xml

Add this code to set up your table. Modify table names, columns, types to suit your own

<?xml version="1.0"?>
<!-- Database schema -->
<schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/schema. xsd">
  <table name="az_codez_followers" resource="default" engine="innodb" comment="Azcodez followers">
      <column xsi:type="int" name="follower_id" padding="19" unsigned="true" nullable="false" identity="true" comment="Follower id"/>
      <column xsi:type="text" name="name" nullable="false" comment="Follower Name"/>
      <column xsi:type="text" name="email" nullable="false" comment="Follower Contact"/>
      <constraint xsi:type="primary" referenceId="PRIMARY">
          <column name="follower_id"/>
      </constraint>
  </table>
</schema>

Generate generate db_schema_whitelist.json

docker-compose run --rm deploy magento-command setup:db-declaration:generate-whitelist

Redeploy

Find your table and see if it worked eg.

Select * From az_codez_followers;

Updating a database

Following this reference https://devdocs.magento.com/guides/v2.4/extension-dev-guide/declarative-schema/data-patches.html

Create a data patch

This file will run on deploy and modify table app\code\AzCodez\Databases\Setup\Patch\Data\NewColumn.php

## Add sample code from https://devdocs.magento.com/guides/v2.4/extension-dev-guide/declarative-schema/data-patches.html and add what you want to do

Here i will be creating a new table column with this patch


/**
 * Adds new column twitter_handle
 */

namespace AzCodez\Databases\Setup\Patch\Data;

use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\Patch\DataPatchInterface;
use Magento\Framework\Setup\Patch\PatchRevertableInterface;

class NewColumn implements DataPatchInterface, PatchRevertableInterface
{
    /**
     * @var ModuleDataSetupInterface
     */
    private $moduleDataSetup;

    /**
     * @param ModuleDataSetupInterface $moduleDataSetup
     */
    public function __construct(
        ModuleDataSetupInterface $moduleDataSetup
    ) {
        /**
         * If before, we pass $setup as argument in install/upgrade function, from now we start
         * inject it with DI. If you want to use setup, you can inject it, with the same way as here
         */
        $this->moduleDataSetup = $moduleDataSetup;
    }

    /**
     * @inheritdoc
     */
    public function apply()
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        //The code that you want apply in the patch
        //Please note, that one patch is responsible only for one setup version
        //So one UpgradeData can consist of few data patches
        $this->moduleDataSetup->getConnection()->addColumn('az_codez_followers', 'twitter_handle',
            [
            'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
            'length' => 64,
            'unsigned' => true,
            'nullable' => false,
            'comment' => 'twitter'
            ]
        );

        $this->moduleDataSetup->getConnection()->endSetup();
    }

    /**
     * @inheritdoc
     */
    public static function getDependencies()
    {
        /**
         * This is dependency to another patch. Dependency should be applied first
         * One patch can have few dependencies
         * Patches do not have versions, so if in old approach with Install/Ugrade data scripts you used
         * versions, right now you need to point from patch with higher version to patch with lower version
         * But please, note, that some of your patches can be independent and can be installed in any sequence
         * So use dependencies only if this important for you
         */
        return [
            SomeDependency::class
        ];
    }

    public function revert()
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        //Here should go code that will revert all operations from `apply` method
        //Please note, that some operations, like removing data from column, that is in role of foreign key reference
        //is dangerous, because it can trigger ON DELETE statement
        $this->moduleDataSetup->getConnection()->endSetup();
    }

    /**
     * @inheritdoc
     */
    public function getAliases()
    {
        /**
         * This internal Magento method, that means that some patches with time can change their names,
         * but changing name should not affect installation process, that's why if we will change name of the patch
         * we will add alias here
         */
        return [];
    }
}

Credits

https://devdocs.magento.com/
https://www.adobe.com/

Feel free to comment questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Automatically Tweet Hashnode blogs using GitHub Actions

Asrin Dayananda — Mon, 01 Aug 2022 07:31:00 GMT

This is how I post my Hashnode blogs to Twitter automatically by using GitHub Actions. You can see these tweets on my Twitter account.

Costs

Github provides 2,000 minutes a month for free account which is plenty!
This GitHub action only uses 20s / 1 billable minute

Setup Hashnode API

First, check out this awesome blog by Catalin about the Hashnode API and make sure you can call the API and your blogs
Load the Hashnode API playground https://api.hashnode.com/
Setup your Hashnode API playground like so, including your own blog name if hasnode playground hasn't done it for you already
```
{
user(username: "publication {
    posts(page: 0) {
      title
      brief
      slug

    }
  }
}
}
```

Create a GitHub Action

Follow this my previous blog on how to tweet using GitHub actions
Add some more steps before the tweet step

Add fetching Hashnode API

    # API request https://github.com/marketplace/actions/http-request-action
    - name: Deploy Stage
      id: myRequest
      uses: fjogeleit/http-request-action@master
      with:
        url: 'https://api.hashnode.com/'
        method: 'POST'
        data: '{"query":"{\n  user(username: \"\") {\n    publication {\n      posts(page: 0) {\n        title\n        brief\n        slug\n      }\n    }\n  }\n}\n"}'
        customHeaders: '{"headers": {"Content-Type": "application/json"}}'

Add another step to check your response

    - name: Show Response
      run: echo ${{ steps.myRequest.outputs.response }}

Add a JavaScript executor to run some JavaScript to modify the query

# Sort Json array https://github.com/marketplace/actions/execute-javascript-inline
    - name: Execute JavaScript inline
      id: quoteFiltered
      uses: satackey/action-js-inline@v0.0.2
      with:
        # Edit the following line to install packages required to run your script.
        required-packages: axios
        script: |
          //setup
          const core = require('@actions/core')
          const axios = require('axios')

          //set output from other step            
          const quoteJson = ${{ steps.myRequest.outputs.response }}

          //Filter what blog to receive 
          randomNumber = Math.floor(Math.random() * 6);            
          const title = (String(quoteJson['data']['user']['publication']['posts'][randomNumber]['title']));
          const slug = (String(quoteJson['data']['user']['publication']['posts'][randomNumber]['slug']));
          //What tweet contents will be
          const finalQuote = (title+' '+'https://blog.azcodez.com/'+slug+'{ by @az_codez } from @hashnode #softwaredevelopment #coding #softwareengineering #programming #techblog') 

          console.log(finalQuote)

          //Output
          core.setOutput('finalQuote', finalQuote)

Make sure you run your GitHub action multiple times to check what you are going to tweet is correct and GitHub Action passes

Now add your tweet to Twitter step

# Tweet to twitter https://github.com/marketplace/actions/tweet-to-twitter
    - name: TweetToTwitter
      uses: InfraWay/tweet-action@v1.0.1
      with:
        status: ${{ steps.quoteFiltered.outputs.finalQuote }}
        api_key: ${{ secrets.TWITTER_API_KEY }}
        api_key_secret: ${{ secrets.TWITTER_API_SECRET_KEY }}
        access_token: ${{ secrets.TWITTER_ACCESS_TOKEN }}
        access_token_secret: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}

Credits

Github Actions Image coletiv.com/blog/android-github-actions-setup
Twitter image https://www.nytimes.com/2014/08/10/magazine/who-made-that-twitter-bird.html

Shameless Plugs

Now you don't have to worry about reposing your blogs!

Hope this helps😁

Feel free to comment with questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Setup GitHub SSH key using Windows

Asrin Dayananda — Sat, 30 Jul 2022 13:27:56 GMT

This is how I installed Git and authenticated with my GitHub repo using a ssh key using Windows OS

Download and install git

https://git-scm.com/

Create a folder for a git repo

Create a folder in your windows system
Open folder in git by right clicking and selecting git bash

Create a ssh key (Open ssh type)

ssh-keygen -t ed25519 -C "AddYourEmail@email.com"

Follow prompts and save to your .ssh folder

View and copy your public key you need to add this later

nano <YOUR_LOCATION_YOU_ADDED_ABOVE>/.ssh/github-key.pub

Go to your github security settings

https://github.com/settings/profile
Cick SSH and GPG keys
Click NewSSH key
Add public key you copied before new SSH key and add add a Title
Add SSH key
You should have a success notification

Add your ssh-agent connection to .profile

Open your git folder using git bash again
Create a .profile or edit it
```
nano ~/.profile
```
Add these contents. Remember to edit to set path to your ssh key!
```
#! /bin/bash 
eval `ssh-agent -s` 
ssh-add ~/.ssh/
```

Add your ssh-agent connection to .bashrc

You will need to add to bash as well. eg. I am using git terminal in Android studio so I will need to change bashrc
Create a .bashrc or edit it
```
nano ~/.bashrc
```
Add these contents. Remember to edit to set path to your ssh key!
```
#! /bin/bash 
eval `ssh-agent -s` 
ssh-add ~/.ssh/
```
Restart the app that you are using git cli

You should see something like

Agent pid XXXX
Identity added: xxxxxxxxx

Go to one of your repos and fetch remote repo by running
```
git fetch
```
This should fetch contents without asking for key or ssh agent

Credits

https://stackoverflow.com/questions/3669001/getting-ssh-agent-to-work-with-git-run-from-windows-command-shell/15870387#15870387
https://stackoverflow.com/questions/18404272/running-ssh-agent-when-starting-git-bash-on-windows
https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
Create ssh key
Header Image

Shameless Plugs

Feel free to comment with questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Installing the AWS EB CLI command on Debian 11 (WSL2)

Asrin Dayananda — Sat, 02 Jul 2022 09:52:21 GMT

In order to create docker containers in Amazon Web Services Elastic Beanstalk, you need the EB CLI command to run. I didn’t find the installation of this very straightforward forward so hopefully, this helps you.

Install python

sudo apt update 
sudo apt -y upgrade
sudo apt install wget build-essential libreadline-gplv2-dev libncursesw5-dev \ libssl-dev libsqlite3-dev tk-dev libgdbm-dev libc6-dev libbz2-dev libffi-dev zlib1g-dev
sudo apt -y install wget
wget https://www.python.org/ftp/python/3.9.1/Python-3.9.1.tgz
tar xzf Python-3.9.1.tgz
python3.9 --version

Set python symlink to run off just the python command

sudo ln -s /usr/bin/python3.9 /usr/bin/python
python --version

Install pip

sudo apt-get -y install python3-pip

Install virtualenv

sudo pip install virtualenv
virtualenv --version

Install git

sudo apt-get -y install git

Create a folder and pull the eb command repo

sudo mkdir /eb-command
chown -R <ADDUSER>:<ADDUSER> /eb-command
cd eb-command
git clone https://github.com/aws/aws-elastic-beanstalk-cli-setup.git

Run EB CLI install file

python ./aws-elastic-beanstalk-cli-setup/scripts/ebcli_installer.py

A successful install will look like this

Run the bash command provided above

Test EB CLI Command

eb --help

Successful will look like this

Credits

https://github.com/aws/aws-elastic-beanstalk-cli-setup
https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-install.html#eb-cli3-install.scripts
https://linuxize.com/post/how-to-install-python-3-9-on-debian-10/
https://virtualenv.pypa.io/en/latest/user_guide.html
https://github.com/pyenv/pyenv
https://stackoverflow.com/questions/18363022/importerror-no-module-named-pip
https://stackoverflow.com/questions/31133050/virtualenv-command-not-found

Shameless Plugs

Now you can create apps in elastic beanstalk! I will blog creating an app soon.

Hope this helps😁

Feel free to comment with questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Creating a AWS EC2 using Github Actions and Terraform Cloud

Asrin Dayananda — Thu, 21 Apr 2022 17:35:20 GMT

These are steps on how I created an AWS EC2 using Github Actions and Terraform.

Create a Terraform Cloud account

Create Terraform Cloud Account using this link
Create a workspace - remember the name you called it
In your AWS portal
- Create a new AWS IAM user
- Give this IAM User full AWS EC2 access
- Store AWS Access Credentials in the Terraform cloud workspace under variables named
  - AWS_ACCESS_KEY_ID
  - AWS_SECRET_ACCESS_KEY

Create Terraform Cloud token

Go to this link which will take you to terraform tokens page
- https://app.terraform.io/app/settings/tokens?utm_source=learn
Create an API token Copy this token we will store this in Gitub Repo

Create a new GitHub repo

Follow these instructions on how to create a GitHub repo if you havent before
Add above Terraform Cloud API token secret
- In your GitHub repo
- Settings > Secrets > Actions
- Create repository secret named TF_API_TOKEN

Pull repo down locally to modify code

Add Terraform files

Copy this file to your repo main.tf

Add GitHub Action file

Copy this terraform.ym to your repo as well https://github.com/hashicorp/learn-terraform-github-actions/blob/main/.github/workflows/terraform.yml
See this for more info to what it does https://learn.hashicorp.com/tutorials/terraform/github-actions?in=terraform/automation

Change main.tf

Configure these lines to suit what you have created in terraform cloud
Change ADD_TERRAFORM_ORGANISATION_NAME & ADD_TERRAFORM_WORKSPACE_NAME

  cloud {
    organization = "ADD_TERRAFORM_ORGANISATION_NAME"

    workspaces {
      name = "ADD_TERRAFORM_WORKSPACE_NAME"
    }
  }
}

Change this line to where you want your EC2 to be created (us-west-2)
```
provider "aws" {
region = "us-west-2"
}
```

Create a branch and push changes up

git branch NewEC2
git checkout NewEC2
git push NewEC2

Create a in GitHub PR to merge into main

Create PR in GitHub Repo
GitHub Action Check will kick off and check if everything is ok

If you get errors like

Error: No valid credential sources found for AWS Provider.

Double check your organization and workspace in terraform or Terraform API key we added into secrets in github
If checks succeed you are ready to create your EC2 from Terraform code
Merge pull request into main
Wait for GitHub action to run

Check if EC2 got provisioned

Go to your Github Action in your repo and click under Terraform Apply step you should have a url to check server
Copy it and go to the site and check it should respond to hello world.
You also could login to your AWS account and find the server

Congrats you have created a server with GitHub Actions and Terraform 🎉

Now delete resources

Open your Terraform Cloud
Find your workspace
Click settings
Queue destroy plan
You will see triggers running to destroy it
You have to confirm you want to accept deleting
Check your url before is broken
Check your EC2 server is removed in the AWS portal or via AWS CLI command

Credits

Shameless Plugs

Feel free to comment with questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Automate login to GitHub with ssh key (linux)

Asrin Dayananda — Fri, 15 Apr 2022 20:35:58 GMT

Intro

If you have setup ssh authentification to GitHub and if you are annoyed at setting ssh-agent and github key everytime you pull/push to git, here is how you automate it 😁

Edit linux profile

This is based on linux WSL2 system

Edit your linux profile
```
nano ~/.profile
```

And add eval

`eval `ssh-agent` 
ssh-add ~/.ssh/github-key

Close current terminal and open new terminal

You should have these lines printed out at start of terminal

Agent pid XXXX Identity added: /root/.ssh/github-key XXXX

Test fetching/commiting and pushing a change. eg

git fetch
git commit --allow-empty -m "test"
git push

Credits

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
Create ssh key

Shameless Plugs

Hope this saves you some time and getting annoyed 😒😁

Feel free to comment with questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Add GitHub ssh-agent and ssh key on startup (Windows)

Asrin Dayananda — Sat, 26 Mar 2022 13:09:33 GMT

If you have GitHub ssh key setup to access your remote repo, whenever you log out your PC your ssh key drops out! So you have to run evalssh-agent -s&& ssh-add ~/.ssh/xxx-key everytime you login.😡

This is how I added ssh-agent and ssh key authentification on start up of git terminal in Windows and in Android studio git bash terminal.

Add your ssh-agent connection to .profile

In git terminal
Create a .profile or edit it
```
nano ~/.profile
```
Add these contents. Remember to edit to set path to your ssh key!
```
#! /bin/bash 
eval `ssh-agent -s` 
ssh-add ~/.ssh/
```

Add your ssh-agent connection to .bashrc

You will need to add to bash as well. eg. I am using git terminal in Android studio so I will need to change bashrc
Create a .bashrc or edit it
```
nano ~/.bashrc
```
Add these contents. Remember to edit to set path to your ssh key!
```
#! /bin/bash 
eval `ssh-agent -s` 
ssh-add ~/.ssh/
```
Restart the app that you are using git cli

You should see something like

Agent pid XXXX
Identity added: xxxxxxxxx

Go to one of your repos and fetch remote repo by running
```
git fetch
```
This should fetch contents without asking for key or ssh agent

Credits

https://stackoverflow.com/questions/3669001/getting-ssh-agent-to-work-with-git-run-from-windows-command-shell/15870387#15870387
https://stackoverflow.com/questions/18404272/running-ssh-agent-when-starting-git-bash-on-windows
https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
Create ssh key

Shameless Plugs

Hope this saves you some time and getting annoyed 😒😁

Feel free to comment with questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Create a database table in Magento 2

Asrin Dayananda — Fri, 04 Mar 2022 17:13:42 GMT

Below are steps I went though to create a new database table in Magento 2 / Adobe Commerce

Create a module

You can add to your existing module or follow this blog to create a module

Create a db schema

Refernce https://devdocs.magento.com/guides/v2.4/extension-dev-guide/declarative-schema/db-schema.html
Path will be similar path to this app\code\AzCodez\CustomerViewing\etc\db_schema.xml
Add this code to setup your table. Modify table names, columns, types to suit your own

<?xml version="1.0"?>
<!-- Database schema -->
<schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Setup/Declaration/Schema/etc/schema. xsd">
    <table name="az_codez_followers" resource="default" engine="innodb" comment="Azcodez followers">
        <column xsi:type="int" name="follower_id" padding="19" unsigned="true" nullable="false" identity="true" comment="Follower id"/>
        <column xsi:type="text" name="name" nullable="false" comment="Follower Name"/>
        <column xsi:type="text" name="email" nullable="false" comment="Follower Contact"/>
        <constraint xsi:type="primary" referenceId="PRIMARY">
            <column name="follower_id"/>
        </constraint>
    </table>
</schema>

Generate generate db_schema_whitelist.json

docker-compose run --rm deploy magento-command setup:db-declaration:generate-whitelist

Redeploy

Find your table and see if it worked eg.

Select * From az_codez_followers;

Shameless Plugs

Credits

Feel free to comment with questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Create a frontend page in Magento 2

Asrin Dayananda — Sat, 05 Feb 2022 18:18:55 GMT

Below are steps to how I created a front-end page using a controller in Magento 2.

Create a module

Create folders and paths as this example. Replace AzCodez\Page with your module.
- app\code\AzCodez\Page\Controller\Action\Index.php
In Index.php add the below code.
- This class creates a page and sets page contents to 'Hello From Custom Page'
- Replace AzCodez\Page with your module.


/**
 * Render page
 * 
 */
namespace AzCodez\Page\Controller\Action;

use Magento\Framework\View\Result\PageFactory;
use Magento\Framework\App\Action\Action;
use Magento\Framework\App\Action\Context;
use Magento\Framework\Controller\ResultInterface;

/**
 * Class Index
 * @package AzCodez\Page\Controller\Action
 */
class Index extends Action
{

     /**
     * @var PageFactory
     */
     protected $_pageFactory;

     /**
     * Index constructor.
     * @param Context $context
     * @param PageFactory $pageFactory
     */
     public function construct(
        Context $context,
        PageFactory $pageFactory
    )
    {
        $this->_pageFactory = $pageFactory;
        return parent::__construct($context);
     }

     /**
     * @return ResultInterface
     */
     public function execute()
     {
        $result = $this->resultFactory->create(\Magento\Framework\Controller\ResultFactory::TYPE_RAW);
        $result->setContents('Hello From AzCodez Custom Page');
        return $result;
     }

}

Create a route to route the page to the frontend. Replace AzCodez\Page with your module.
- This is the file path app\code\AzCodez\Page\etc\frontend\routes.xml

Add code for route. Replace AzCodez_Page with your module name

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
  <router id="standard">
      <route id="product_list" frontName="product_list">
          <module name="AzCodez_Page" />
      </route>
  </router>
</config>

Run deploy commands

If not running docker remove docker-compose run --rm deploy magento-command and replace with php bin/magento

rm -rf generated/code/* && 
rm -rf pub/static/frontend/* && 
rm -rf pub/static/adminhtml/* && 
docker-compose run --rm deploy magento-command setup:upgrade && 
docker-compose run --rm deploy magento-command setup:di:compile && 
docker-compose run --rm deploy cloud-deploy && 
docker-compose run --rm deploy magento-command cache:clean && 
docker-compose run --rm deploy magento-command cache:flush

Load the page http://magento2.docker/product_list/action/index

Shameless Plugs

Join me and invest commission-free with Freetrade. Get started with a free share worth £3-£200. https://magic.freetrade.io/join/asrin/447192e9
Want to start a blog on hashnode use this link so I get a free shirt. I will assist you with setup 🙂
Sign up for coinbase and get £7.42 of Bitcoin http://coinbase.com/join/dayana_m40?src=android-link

Credits

Feel free to comment if you get stuck or have questions or feedback✌️

Happy Coding 🙂

Az 👨🏾‍💻

Create a budget alert in Azure cloud

Asrin Dayananda — Sat, 29 Jan 2022 17:46:44 GMT

Below are steps on how I set up a budget in Azure cloud so it alerts me before I spend too much. I hope this helps you as well.

Sign in to your Azure portal
Search for cost management and click on cost management. You will have a screen like below

Click on budgets on the right hand side
Add a budget

Enter budget details
Set Budget name to whatever you like
Set Reset period to monthly to reset the budget monthly as usually you are charged monthly unless you have changed do a different way to pay
Set Creation date to the beginning of the month. This should be set for you
Set Expiration date to whenever you want the budget to end, say 10 years time
Set your Budget amount, this is what amount you are willing pay
My budget looks like this

Click Next after confirming
Set Alert conditions
Select Type of actual or forecasted. Actual means amount of services used and charged for and forecasted means prediction of azure services depending on how you use them. Eg. if a virtual server is on most of the time it's going to predict how much it's going to spend. I prefer actual.
Select % of budget, this percentage is when the percentage of budget you set in the previous screen will send an alert to you. I like to set this at 90%. The Amount will be worked out for you automatically
Action group is set to none
Add Alert recipients emails to who you want alerts to go to
Select language
Click create

Congrats, You have created an alert Now you will be notified when you are reaching your budget and there will be no nasty surprises.

More info at Microsoft docs https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/tutorial-acm-create-budgets

Shameless Plugs

Feel free to comment if you get stuck or have questions or feedback✌️

Happy Coding 🙂 Az 👨🏾‍💻

How to turn on AWS EC2 using Github Actions

Asrin Dayananda — Sat, 15 Jan 2022 15:25:21 GMT

Below we are going to write a Github Action that turns on an AWS EC2 server

Create a GitHub account

Create a new repository
Setup file for workflow
- Folder named .github
- Folder in .github called workflows
- Create a file called turnOnAWSEC2.yml
- See Link for more info

Add code to workflow (turnOnAWSEC2.yml) file

Please see comments starting with '#' explaining what each bit of the file does
This code is set up only to run when you click action in the repository
Github workflows servers that are used to run the workflows have AWS CLI commands built-in, so all you need to do is run the AWS CLI command See this link for more information

name: startMagent2DevEC2

# Controls when the action will run. 
# This code is set up only to run when you click action in the repository, If you require to run on a push or cron edit below
on:
  # Triggers the workflow on push or pull request events but only for the main branch
  # push:
  #  branches: [ main ]
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:

    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Below this are each of the steps that are run
    steps:

     # Name of step
      - name: Start AWS EC2
        # Run AWS Command on the GitHub Hosted runner which starts the instance using AWS authentication stored in GitHub Secrets (see below how to add)
        run: |
          aws ec2 start-instances --instance-ids ${{secrets.AWS_EC2_INSTANCE_ID }}
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}

Add GitHub Repository Secrets

In the above workflow, we have many secrets to add eg. ${{ secrets.AWS_ACCESS_KEY_ID }}
- Secrets are secret values stored so that GitHub workflow can use them without exposing them in your workflow file
Create AWS Keys
- Log into your AWS portal that has high privileges to create accounts
- Create a new IAM user as its AWS best practice to keep your logins separate from your root account See this link
- Logout and login as your new IAM user
- Click your cloud name
- Click 'My Security Credentials'
- Click create
- Here you will have 2 keys that you will need to add to your repository. Keep this page open or copy these to add to below
To add these AWS keys to your GitHub Repository
- Click settings in your repository
- Then secrets
- Add repository secret named AWS_ACCESS_KEY_ID and add the key from the AWS portal you generated above
- Create another secret named AWS_SECRET_ACCESS_KEY and add relevant keys from your keys created in your AWS Account
Create a secret for your instance id ie. ${{secrets.AWS_EC2_INSTANCE_ID }}
- Go to your AWS Console
- Select Services > EC2
- Instance ID is the identifier of what EC2 VM as below screenshot
- Copy this ID and add it to your GitHub Secrets
- Click settings in your repository
- Then secrets
- Add repository secret named AWS_EC2_INSTANCE_ID and add instance id

Create a secret for your AWS region where your AWS EC2 is running id ie. ${{ secrets.AWS_REGION }}
Go to your AWS Console
- Select Services > EC2
- Region is in the right-hand corner as below screenshot
- Make sure you match your region with code in this link
- Add to your GitHub Secrets
- Click settings in your repository
- Then secrets
- Add repository secret named AWS_REGION and add AWS region

Commit and push code if you haven't already

Run your GitHub action

In your repo
Click Actions
Select Action to run
Click run the workflow

If successful you should have a complete success workflow and your EC2 should be switched on in AWS.

Don't forget to turn off your EC2 if you don't want it to run.

Shameless Plugs

Join me and invest commission-free with Freetrade. Get started with a free share worth £3-£200. https://magic.freetrade.io/join/asrin/447192e9
Want to start a blog on hashnode use this link so I get a free shirt. I will assist you with setup 🙂
Sign up for coinbase and get £7.42 of Bitcoin http://coinbase.com/join/dayana_m40?src=android-link

Credits

Feel free to comment if you get stuck or have questions or feedback✌️

Happy Coding 🙂

Az 👨🏾‍💻

Method Chaining in PHP with PHPUnit test

Asrin Dayananda — Sun, 05 Dec 2021 19:17:22 GMT

What is method chaining

Method chaining is where you can call multiple methods after one another in one line like so

$methodChain->addHelloToChain()->addSpaceToChain()->addThereToChain()->getOutputOfChain();

Let's write some code

Setup an initial class with this code which has a few methods that you can call.



namespace AzCodez\MagentoTraining\Controller\UnitTesting;

class MethodChainingTest
{
    public $outputOfChain = '';

    public function __construct()
    {
        $this->outputOfChain = '';
    }

    public function addHelloToChain()
    {
        $this->outputOfChain .= "hello";
        return $this;
    }

    public function addSpaceToChain()
    {
        $this->outputOfChain .= " ";
        return $this;
    }

    public function addThereToChain()
    {
        $this->outputOfChain .= "there";
        return $this;
    }

    public function addByeToChain()
    {
        $this->outputOfChain .= "bye";
        return $this;
    }

    public function addNowToChain()
    {
        $this->outputOfChain .= "now";
        return $this;
    }

    public function getOutputOfChain()
    {
        return $this->outputOfChain;
    }
}

The above four methods are what you call to make your chain.

addHelloToChain()
addSpaceToChain()
addThereToChain()
addByeToChain()

The last method getOutputOfChain() gets the output of the chain result.

Write a PHPUnit Test

Now we will write a PHP Unit test, call the chain, and test output. Explanation is in comment of code.



use PHPUnit\Framework\TestCase;
use AzCodez\MagentoTraining\Controller\UnitTesting\TestClassMethodChaining;

class TestMethodChaining extends TestCase
{
    /**
     * Unit test to check method chaining of calling addByeToChain + addNowToChain() + addNowToChain should result in 'bye now'
     */
    public function testMethodChaningHelloThere()
    {
        //Arrange
        $methodChain = new TestClassMethodChaining();

        //Act
        $result = $methodChain->addHelloToChain()->addSpaceToChain()->addThereToChain()->getOutputOfChain();

        // Asset
        $this->assertEquals('hello there', $result);

    }

    /**
     * Unit test to check method chaining of calling addByeToChain + addNowToChain() + addNowToChain should result in 'bye now'
     */
    public function testMethodChaningByeNow()
    {
        //Arrange
        $methodChain = new TestClassMethodChaining();

        //Act
        $result = $methodChain->addByeToChain()->addSpaceToChain()->addNowToChain()->getOutputOfChain();

        // Asset
        $this->assertEquals('bye now', $result);

    }
}

Run the tests

./vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist app/code/AzCodez/MagentoTraining/Test/Unit/

Shameless Plugs

Join me and invest commission-free with Freetrade. Get started with a free share worth £3-£200. https://magic.freetrade.io/join/asrin/447192e9
Start a blog on Hashnode https://hashnode.com/@azcodez/joinme

Credits

https://www.php.net/
Image https://unsplash.com/photos/2zGTh-S5moM

Feel free to comment with questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Install Magento 2.4.3 Community on Docker WSL2

Asrin Dayananda — Mon, 29 Nov 2021 20:31:54 GMT

Install and activate Windows WSL2

Follow these instructions to setup your windows for linux subsystem
- https://docs.microsoft.com/en-us/windows/wsl/install-win10

Setup Debian

In windows search and open Microsoft store
Search for Debian App and Install it
Launch the Debian terminal and create a user account
Switch to using the "root" user for the whole installation as this is doesnt cause file permission issues for magento generating files NOTE: Only do this on developer environments!
Change the password for the root user.
```
sudo passwd root
```
Then login under root
```
su root
```
We then need to set root as the default user for Debian.
Close Debian
Open CMD or Powershell and run
```
debian config --default-user root
```
The root user has been set as the primary default user for Debian
Check if you have internet connectivity by running
```
apt update
```
If not see this for more info https://gist.github.com/coltenkrauter/608cfe02319ce60facd76373249b8ca6

Install Docker Desktop

See these instructions for installation
Once installed, Open docker desktop > Settings > General and select "Use the WSL 2 based engine".
Then click on Resources > WSL Integration and select Enable integration with my default WSL distro
Apply and restart Docker desktop
After Docker Desktop has reinitialized, restart windows to be save everything is set properly

Install php7.4 in Debian

Update apt
```
sudo apt update
```
Install wget
```
sudo apt install wget
```

Install dependencies

sudo apt install software-properties-common ca-certificates lsb-release apt-transport-https

Enable SURY repo

sudo sh -c 'echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" > /etc/apt/sources.list.d/php.list'

Install gnupg
```
apt-get update
```
```
apt install gnupg
```

Import the GPG key for the repository

wget -qO - https://packages.sury.org/php/apt.gpg | sudo apt-key add -

Install PHP7.4

sudo apt update

sudo apt install php7.4

sudo apt-get install php7.4-{bcmath,curl,xml,fpm,gd,intl,mbstring,mysql,zip,soap}

Check php is installed

php -v

Install composer in Debian

Install curl
```
sudo apt install curl
```

Get composer installer

curl -sS https://getcomposer.org/installer -o composer-setup.php

Get composer key from here and update below Hash variable https://composer.github.io/pubkeys.html

HASH=906a84df04cea2aa72f40b5f787e49f22d4c2f19492ac310e8cba5b96ac8b64115ac402c8cd292b8a03482574915d1a8

Check installer valid

php -r "if (hash_file('SHA384', 'composer-setup.php') === '$HASH') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"

Install composer

sudo php composer-setup.php --version=2.1.3 --install-dir=/usr/local/bin --filename=composer

Check installer is installed

composer -v

See WSL files

Open your windows file explorer and put below in your search bar. You will see your Debian installation here
```
\\wsl$
```

Install magento on docker desktop

Referencing these instructions

Get magento community repository using composer

composer create-project --repository-url=https://repo.magento.com/ magento/project-community-edition

Get magento auth keys
- Following this link
  - https://devdocs.magento.com/guides/v2.4/install-gde/prereq/connect-auth.html
- Rename auth.json.sample to auth.json and add your public and private keys here
- If asks for authentification required again using cli commands.
  - Public key = username
  - Private key = password
Go to your install directory of magento
```
cd project-community-edition/
```

Install magento ece tools

composer require --no-update --dev magento/ece-tools magento/magento-cloud-docker

Add .magento.docker.yml file to your repository

Check requirements https://devdocs.magento.com/guides/v2.4/install-gde/system-requirements.html

Add below code to .magento.docker.yml file (Make sure this is formatted properly)

name: magento
system:
mode: 'production'
services:
php:
  version: '7.4'
  extensions:
      enabled:
          - xsl
          - json
          - redis
mysql:
  version: '10.4'
  image: 'mariadb'
redis:
  version: '6.0'
  image: 'redis'
elasticsearch:
  version: '7.9'
  image: 'magento/magento-cloud-docker-elasticsearch'
hooks:
build: |
  set -e
  php ./vendor/bin/ece-tools run scenario/build/generate.xml
  php ./vendor/bin/ece-tools run scenario/build/transfer.xml
deploy: 'php ./vendor/bin/ece-tools run scenario/deploy.xml'
post_deploy: 'php ./vendor/bin/ece-tools run scenario/post-deploy.xml'
mounts:
var:
  path: 'var'
app-etc:
  path: 'app/etc'
pub-media:
  path: 'pub/media'
pub-static:
  path: 'pub/static'

Run install script (this may error, just continue installing)

curl -sL https://github.com/magento/magento-cloud-docker/releases/download/1.2.3/init-docker.sh | bash -s -- --php 7.4

If you get this error
```
Unable to find image 'magento/magento-cloud-docker-php:7.4-cli-1.1' locally docker: Error response from daemon: Get "https://registry-1.docker.io/v2/": net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers).
```
- Look at these links, this will help
  - https://gist.github.com/coltenkrauter/608cfe02319ce60facd76373249b8ca6#file-fix-wsl2-dns-resolution
  - https://stackoverflow.com/questions/59360629/docker-windows-timeout
    - This was my fix - commented out the registry one seems to work now

Deploy your magento installation (run all at once or remove the && if you want to run one at a time)

composer update &&
docker volume create --name=magento-sync && 
docker volume create --name=mymagento-magento-sync && 
./vendor/bin/ece-docker build:compose --mode="developer" --with-cron --expose-db-port=3306 --no-tls --host=magento2.docker && 
docker-compose up -d && 
docker-compose run --rm deploy php ./vendor/bin/ece-patches apply && 
docker-compose run --rm deploy cloud-deploy  || true && 
docker-compose run --rm deploy cloud-deploy  || true && 
docker-compose run --rm deploy magento-command deploy:mode:set developer && 
docker-compose run --rm deploy cloud-deploy  || true && 
docker-compose run --rm deploy cloud-deploy  || true && 
docker-compose run --rm deploy magento-command deploy:mode:set developer && 
docker-compose run --rm deploy magento-command config:set web/secure/use_in_adminhtml 0 && 
docker-compose run --rm deploy magento-command config:set web/secure/use_in_frontend 0 && 
docker-compose run --rm deploy magento-command config:set web/unsecure/base_url http://magento2.docker/ && 
docker-compose run --rm deploy magento-command config:set web/secure/base_url http://magento2.docker/ && 
docker-compose run --rm deploy cloud-deploy && 
docker-compose run --rm deploy magento-command deploy:mode:set developer

If you have any errors try redeploy few times

docker-compose run --rm deploy cloud-deploy && 
docker-compose run --rm deploy magento-command deploy:mode:set developer && 
docker-compose run --rm deploy magento-command config:set web/secure/use_in_adminhtml 0 && 
docker-compose run --rm deploy magento-command config:set web/secure/use_in_frontend 0 && 
docker-compose run --rm deploy magento-command config:set web/unsecure/base_url http://magento2.docker/ && 
docker-compose run --rm deploy magento-command config:set web/secure/base_url http://magento2.docker/ && 
docker-compose run --rm deploy cloud-deploy && 
docker-compose run --rm deploy magento-command deploy:mode:set developer

If errors on deploy, run cloud-deploy again until it works, this is just initially needs a few deploys

Call to undefined method Magento\Eav\Api\Data\AttributeExtension::setIsPagebuilderEnabled()#0 /app/vendor/magento/framework/Interception/Interceptor.php(146): Magento\
PageBuilder\Plugin\Catalog\Model\Product\Attribute\RepositoryPlugin->afterGet(Object(Magento\Catalog\Model\Product\Attribute\Repository\Interceptor), Object(Magento\Ca
talog\Model\ResourceModel\Eav\Attribute\Interceptor), 'sku')

docker-compose run --rm deploy cloud-deploy

Set your URL to magento instance and https off because its local

docker-compose run --rm deploy magento-command deploy:mode:set developer && 
docker-compose run --rm deploy magento-command config:set web/secure/use_in_adminhtml 0 && 
docker-compose run --rm deploy magento-command config:set web/secure/use_in_frontend 0 && 
docker-compose run --rm deploy magento-command config:set web/unsecure/base_url http://magento2.docker/ && 
docker-compose run --rm deploy magento-command config:set web/secure/base_url http://magento2.docker/ && 
docker-compose run --rm deploy cloud-deploy && 
docker-compose run --rm deploy magento-command deploy:mode:set developer

Set varnish

docker-compose run --rm deploy magento-command config:set system/full_page_cache/caching_application 2 --lock-env && 
docker-compose run --rm deploy magento-command setup:config:set --http-cache-hosts=varnish &&
docker-compose run --rm deploy cloud-deploy && 
docker-compose run --rm deploy cloud-post-deploy && 
docker-compose run --rm deploy magento-command cache:clean

Add localhost ip to your windows host file
- Go to C:\Windows\System32\drivers\etc and open hosts file and add
```
127.0.0.1 magento2.docker
```

Disable vernish as it was loading https

docker-compose run --rm deploy magento-command config:set system/full_page_cache/caching_application 0 --lock-env
docker-compose run --rm deploy cloud-deploy
docker-compose run --rm deploy magento-command cache:flush
docker-compose run --rm deploy magento-command cache:clean

This should load a blank magento luma theme site! http://magento2.docker/

To create an admin user run below, add your variables first.

docker-compose run --rm deploy magento-command admin:user:create --admin-user=<ADD_USER> --admin-password=<ADD_PASSWORD> --admin-email=<ADD_EMAIL>@gmail.com --admin-firstname=Az --admin-lastname=Codez

Credits

Windows Image https://www.pngkit.com/view/u2q8a9o0u2o0y3t4_upgrade-gobierno-open-business-logo-windows-10-home/
Docker image https://mobile.twitter.com/docker
Magento 2 logo https://en.wikipedia.org/wiki/Magento
https://docs.docker.com/
https://devdocs.magento.com/
https://www.adobe.com/
https://www.debian.org/

Feel free to comment questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Install Magento 2.4.3 Community on AWS EC2 (Debian 10)

Asrin Dayananda — Sun, 28 Nov 2021 12:46:28 GMT

First Calculate your costs

https://calculator.aws/#/createCalculator/EC2
Below we are using
- US East (N.Virginia)
- t2.medium
- 10gb storage
- Which should cost only $34.87USD on demand OR $21.95USD if you are using EC2 Savings Plan

Select EC2
Launch Instances
Search Debian
Choose Debian 10 (HVM), SSD Volume Type
Select Choose an Instance Type = t2.medium
Next Configure Instance Details
Next Add storage -Use minimum 10gb
Add tag if you want
Configure Security Group add following
- SSH = Open to IPs you want to ssh to
- HTTP = Anywhere
- HTTPS = Anywhere
Review and Launch
Launch
- Create a new key pair OR use exising one if you want

Add Static IP to EC2 if you prefer to keep same IP address

See this Link on how to setup a Elastic IP to your VM

SSH into VM

I am using WSL2 on windows and VScode for this
Add your .pem key to ~/.ssh folder

SSH using a VSCode Terminal connected to WSL2

ssh -i ~/.ssh/<SSH_KEY_NAME>.pem admin@<PUBLIC_IP_OR_DNS_OF_AWS_EC2_SERVER>

Install Docker

Below install steps from this link with slight modifications on commands
Set up the repository

Update the apt package index and install packages to allow apt to use a repository over HTTPS:

sudo apt-get update
sudo apt-get install \
  ca-certificates \
  curl \
  gnupg \
  lsb-release

Add Docker’s official GPG key:

curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg

Use the following command to set up the stable repository. To add the nightly or test repository, add the word nightly or test (or both) after the word stable in the commands below. Learn about nightly and test channels.

echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian \
$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

Install Docker Engine
This procedure works for Debian on x86_64 / amd64, armhf, arm64, and Raspbian.
Update the apt package index, and install the latest version of Docker Engine and containerd, or go to the next step to install a specific version:
```
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io
```
```
sudo service docker start
```
Make docker be able to run by non sudo user
```
sudo usermod -a -G docker admin
```
Reboot server
```
sudo reboot
```
Check whether can run docker with normal user
```
docker info
```
Install docker compose as we are going to build docker with docker-compose.yml
```
sudo apt install docker-compose
```

Go to install directory

Go to directory to install. This directory is already created with permissions already to add your whatever you need
```
cd /home/admin/
```

Install php7.4

Update apt
```
sudo apt update
```
Install wget
```
sudo apt install wget
```

Install dependancies

sudo apt install software-properties-common ca-certificates lsb-release apt-transport-https

Enable SURY repo

sudo sh -c 'echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" > /etc/apt/sources.list.d/php.list'

Install gnupg

sudo apt-get update && apt-get install -y gnupg

Import the GPG key for the repository

wget -qO - https://packages.sury.org/php/apt.gpg | sudo apt-key add -

Installing PHP7.4

sudo apt update
sudo apt install php7.4 
sudo apt-get install php7.4-{bcmath,curl,xml,fpm,gd,intl,mbstring,mysql,zip,soap}

Check php is installed
```
php -v
```
Should look like this

Install composer in Debian

Install curl
```
sudo apt install curl
```

Get composer installer

curl -sS https://getcomposer.org/installer -o composer-setup.php

Get composer key from here and update below Hash variable https://composer.github.io/pubkeys.html

HASH=906a84df04cea2aa72f40b5f787e49f22d4c2f19492ac310e8cba5b96ac8b64115ac402c8cd292b8a03482574915d1a8

Check installer valid

php -r "if (hash_file('SHA384', 'composer-setup.php') === '$HASH') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"

Install composer

sudo php composer-setup.php --version=2.1.3 --install-dir=/usr/local/bin --filename=composer

Check installer is installed
```
composer -v
```

Uninstall apache

Instructions from this link

stop the apache2 service

sudo service apache2 stop
sudo systemctl stop apache2

Remove apache2 packages

sudo apt-get purge apache2 apache2-utils apache2-bin apache2.2-common

Cleanup
```
sudo apt-get autoremove
```
Check if the apache has been removed, the following command line should return a blank line
```
which apache2
```

Install fresh Magento 2.4.3 community edition

Get repo

composer create-project --repository-url=https://repo.magento.com/ magento/project-community-edition

When it asks you for auth keys, get them from these instructions and store them
- https://devdocs.magento.com/guides/v2.4/install-gde/prereq/connect-auth.html
Go to directory
```
cd project-community-edition
```

Run composer require

composer require --no-update --dev magento/ece-tools magento/magento-cloud-docker

Create a .magento.docker.yml file
```
nano .magento.docker.yml
```

Add below, make sure you format yml correctly

name: magento
system:
mode: 'production'
services:
php:
  version: '7.4'
  extensions:
      enabled:
          - xsl
          - json
          - redis
mysql:
  version: '10.4'
  image: 'mariadb'
redis:
  version: '6.0'
  image: 'redis'
elasticsearch:
  version: '7.9'
  image: 'magento/magento-cloud-docker-elasticsearch'
hooks:
build: |
  set -e
  php ./vendor/bin/ece-tools run scenario/build/generate.xml
  php ./vendor/bin/ece-tools run scenario/build/transfer.xml
deploy: 'php ./vendor/bin/ece-tools run scenario/deploy.xml'
post_deploy: 'php ./vendor/bin/ece-tools run scenario/post-deploy.xml'
mounts:
var:
  path: 'var'
app-etc:
  path: 'app/etc'
pub-media:
  path: 'pub/media'
pub-static:
  path: 'pub/static'

Run install (This may error, but ignore it)

curl -sL https://github.com/magento/magento-cloud-docker/releases/download/1.2.3/init-docker.sh | bash -s -- --php 7.4

Dont worry about this error

Installing dependencies (including require-dev) from lock file
Warning: The lock file is not up to date with the latest changes in composer.json. You may be getting outdated dependencies. It is recommended that you run `composer update` or `composer update name>`.
Your requirements could not be resolved to an installable set of packages.

Get a domain name from AWS R53 or whereever you prefer

Build dockers and install

composer update
docker volume create --name=magento-sync
docker volume create --name=mymagento-magento-sync
./vendor/bin/ece-docker build:compose --mode="developer" --with-cron --expose-db-port=3306 --no-tls --host=<ADD_YOUR_HOST>.com
docker-compose up -d
docker-compose run --rm deploy php ./vendor/bin/ece-patches apply
docker-compose run --rm deploy cloud-deploy  || true 
docker-compose run --rm deploy cloud-deploy  || true
docker-compose run --rm deploy magento-command deploy:mode:set developer
docker-compose run --rm deploy cloud-deploy  || true
docker-compose run --rm deploy cloud-deploy  || true 
docker-compose run --rm deploy magento-command deploy:mode:set developer
docker-compose run --rm deploy magento-command config:set web/secure/use_in_adminhtml 0
docker-compose run --rm deploy magento-command config:set web/secure/use_in_frontend 0
docker-compose run --rm deploy magento-command config:set web/unsecure/base_url http://.com/
docker-compose run --rm deploy magento-command config:set web/secure/base_url http://.com/
docker-compose run --rm deploy cloud-deploy
docker-compose run --rm deploy magento-command deploy:mode:set developer

Point your domain at your EC2 at EC2 resource using Route53 point at resource or get Public IP of your EC2 and forward your domain to that IP
Load your shop http://.com/
This site is setup as dev environment at the moment. If going into production you need to switch site to production mode and check security settings

Credits

Docker image https://mobile.twitter.com/docker
AWS EC2 Image https://www.google.com/url?sa=i&url=https%3A%2F%2Fdev.to%2Faziz_amghar%2Fall-you-need-to-know-about-ec2-instance-55na&psig=AOvVaw2-8_PE61VZ-QhdiAJG2BmZ&ust=1638118229172000&source=images&cd=vfe&ved=0CAsQjRxqFwoTCNiAk5qAufQCFQAAAAAdAAAAABAI
Magento 2 logo https://en.wikipedia.org/wiki/Magento
https://calculator.aws/#/createCalculator/EC2
https://docs.docker.com/engine/install/debian/
https://www.codegrepper.com/code-examples/shell/debian+10+uninstall+apache2+safe+%3F
https://devdocs.magento.com/
https://www.adobe.com/
https://aws.amazon.com/

Feel free to comment questions or feedback✌️

Happy coding,

Az 👨🏾‍💻

Magento 2 - Creating an observer

Asrin Dayananda — Thu, 25 Nov 2021 20:29:08 GMT

In Magento 2 (Adobe Commerce) observers are events that are already setup thoughout the whole ecommerce eco-system.

This is a great way to customise magento. Just find an event that happens and put your custom code in after it.

Firstly view all observers and pick one you want to use all observers are listed in here via Adobe Magento Documentation

Here we will be using checkout_cart_add_product_complete. This fires when a product has been added to cart.

If you havent created a custom module please see my previous blog
Add events.xml file under your custom plugin eg. app\code\AzCodez\MagentoTraining\etc\events.xml

Add xml code as below

event name is the observer we picked to use

instance is your custom class that you are going to execute after this observer is fired


<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
<event name="controller_action_predispatch">
  <observer name="magento_training_test" instance="AzCodez\MagentoTraining\Observer\Log" shared="false" />
event>
config>

Add php observer class, this fires when observer is fired
- eg. magento2\app\code\AzCodez\MagentoTraining\Observer\Log.php
Add below php code to this file
- This code just logs a message to the system.log file
- Modify namespace to suit your's


/**
 * Observer Test
 * 
 */
namespace AzCodez\MagentoTraining\Observer;

use Psr\Log\LoggerInterface;
use Magento\Framework\Event\Observer;

class Log implements \Magento\Framework\Event\ObserverInterface
{
     /**
     * @var LoggerInterface
     */
     protected $logger;

     /**
     * Dependency Constructor
     * @param LoggerInterface $logger
     */
     public function construct(
         LoggerInterface $logger
        )
     {
        $this->logger = $logger;
     }

     /**
     * @param Observer $observer
     */
     public function execute(Observer $observer) 
    {
        $this->logger->debug("test");
     }
}

Hard Deploy Magento

rm -rf generated/code/* && 
rm -rf pub/static/frontend/* && 
rm -rf pub/static/adminhtml/* && 
docker-compose run --rm deploy magento-command setup:upgrade && 
docker-compose run --rm deploy magento-command setup:di:compile && 
docker-compose run --rm deploy cloud-deploy && 
docker-compose run --rm deploy magento-command cache:clean && 
docker-compose run --rm deploy magento-command cache:flush

Add product to cart and see if you get a log line in system.log

Hope this was helpful, Az 😎

Credits

https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html
https://devdocs.magento.com/guides/v2.4/extension-dev-guide/event-list.html#abstract_search_result_load_after
https://www.mageplaza.com/magento-2-module-development/magento-2-create-events.html

Create a AWS S3 bucket with Github Actions

Asrin Dayananda — Sat, 06 Nov 2021 13:14:03 GMT

Below we are going to run a Github Action that creates a S3 bucket in AWS Cloud

Github workflows have AWS CLI commands built in so all you need to do it run the command See this link for more information

Create a GiHub account

Create a new repository

Setup file for workflow

Folder named .github
Folder in .github called workflows
Create a file called addS3BucketAWS.yml
See Link for more info

Add Below code to workflow file

This code is setup only to run when you click action in repository

# This is a basic workflow to help you get started with Actions

name: addS3BucketAWS

# Controls when the action will run. 
on:
  # Triggers the workflow on push or pull request events but only for the main branch
  # push:
  #  branches: [ main ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:

  # This workflow contains a single job called "build"
  build:

   # The type of runner that the job will run on
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@master

      - name: Upload to S3
        run: |
          aws s3 mb s3://
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          AWS_DEFAULT_REGION: 'eu-west-1'

Change this in your action
```
<ADD BUCKET NAME MAKE SURE IT'S UNIQUE>
```
- Change it to a unique name. Remember S3 names are publicly chosen. Add a random string to end of your bucket name to make sure its unique eg. I used az-test-bucket-8923yhr98uh
Create AWS Keys
Log into your AWS portal
Click your cloud name
Click 'My Security Credentials'
Click create
Here you will have 2 keys which you will need to add to your repository

Add keys to your GitHub Repository

Click settings in your repository
Then secrets
Add repository secrets named AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY and add relevant keys from your keys created in your AWS Account

Commit and push code if you havent already

Run your action

In your repo
Click Actions
Select Action to run
Click run workflow

If successful you should have a complete success workflow like below

Hope this helped you, if this didn't please comment and I will try help you.

Remember to like, post a comment and share.

Happy Coding 🙂

Asrin 🤙

Want to start a blog on hashnode use this link so I get a free shirt. I will assist you with setup 🙂

If this helped you consider buying me a coffee 🙂

Credits

https://stackoverflow.com/questions/59166099/github-action-aws-cli
AWS CLI commands https://docs.aws.amazon.com/cli/latest/userguide/cli-services-s3-commands.html#using-s3-commands-managing-buckets-creating
Image https://chillplanet.org/tag/aws/
Image https://www.coletiv.com/blog/android-github-actions-setup/

Create new branch with git command line

Asrin Dayananda — Fri, 05 Nov 2021 20:35:15 GMT

Say you have made some changes on a branch currently but dont want to put these changes on this branch but instead on a new branch

First check your current status of your git
```
git status
```
Stash your changes, don't worry they wont be lost
```
git stash
```
Check your current branch status
```
git branch -a
```
Create a new branch, this will copy from current branch
```
git branch <ADD YOUR NEW BRANCH NAME>
```
Check your current branch status, see if your new branch exists
```
git branch -a
```

Switch to this new branch

git checkout <ADD YOUR NEW BRANCH NAME>

Check your current branch status
```
git branch -a
```
Your current branch will be green like so

Bring your changes back that you stashed before
```
git stash pop
```
You will have your changes back now, confirm this by running
```
git status
```
Add all your changes for commit by running
```
git add .
```
Add a commit message
```
git commit -m ""
```
Push your changes, setting the new branch to root of your directory
```
git push --set-upstream origin <ADD YOUR NEW BRANCH NAME>
```
Your changes will now be on your remote branch

Hope this helped you, if this didn't please comment and I will try help you.

Remember to like, post a comment and share.

Happy Coding 🙂

Asrin 🤙

Shameless Plugs

If this helped you consider buying me a coffee 🙂

Sync AWS S3 Bucket on Git Push using GitHub Actions

Asrin Dayananda — Wed, 03 Nov 2021 19:18:44 GMT

Below we are going to setup a GitHub Action to upload files to a S3 Bucket

If you haven't got an S3 bucket on AWS you can set one up using this link
If you want to host your files as a static web server set up instructions are here

Create a GitHub Reposiory
- https://github.com/
Add a github action workflow folder and file in repository
- Path should look like this /.github/workflows/.yml
Add this code to the yml file

# This is a basic workflow to help you get started with Actions

name: SyncToS3

# Controls when the action will run. 
on:
  # Triggers the workflow on push or pull request events but only for the main branch
  push:
    branches: [ main ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest
    # https://github.com/marketplace/actions/s3-sync 
    steps:
      - uses: actions/checkout@master
      - uses: jakejarvis/s3-sync-action@master
        with:
          args: --acl public-read --follow-symlinks --delete --exclude '.git/*' --exclude '.github/*'
        env:
          AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          AWS_REGION: ${{ secrets.AWS_REGION }}
          SOURCE_DIR: './public'

Create Secrets
- In your reposiory click Settings > Secrets
- Add below secrets, this link provides what secret should be

AWS_S3_BUCKET 
AWS_ACCESS_KEY_ID 
AWS_SECRET_ACCESS_KEY 
AWS_REGION

Create a folder in root of your repository called public
- Add files in this folder
Push your changes
- Check Actions in your repo to see if its building
Check your S3 Bucket to see whether files added

Hope this helped you, if this didn't please comment and I will try help you.

Remember to like, post a comment and share.

Happy Coding :)

Asrin

If this helped you consider buying me a coffee :)

Credits
- GitHub Action from https://github.com/marketplace/actions/s3-sync

Combine commands to run on Linux (Debian)

Asrin Dayananda — Sun, 31 Oct 2021 16:11:29 GMT

Below we are going to add a bunch of commands into a file and run them all at once where you need to. This should help with development time

In your debian instance

Create a file for your commands
```
nano /bin/new_script
```
Add some commands to your script with && symbols at end of each command to run after another like example

This is example is Magento 2 Commands when rebuilding code on developer environments

rm -rf generated/code/* && 
rm -rf pub/static/frontend/* && 
rm -rf pub/static/adminhtml/* && 
docker-compose run --rm deploy magento-command setup:upgrade && 
docker-compose run --rm deploy magento-command setup:di:compile && 
docker-compose run --rm deploy cloud-deploy && 
docker-compose run --rm deploy magento-command cache:clean && 
docker-compose run --rm deploy magento-command cache:flush

Add permissions to file so the script can run anywhere
```
chmod +x /bin/new_script
```
CD into directory you want to run script and run like so
```
new_script
```

If this didn't please comment and I will try help you.

Remember to like, post a comment and share this blog if this worked for you.

Happy Coding :)

Asrin

If this helped you consider buying me a coffee :)

PHPUnit checking method is called once

Asrin Dayananda — Thu, 28 Oct 2021 20:01:57 GMT

Below we are going to use PHP Unit to check if a function was called inside a method.

First setup your class that you are going to test.
This is a simple class with two functions. mainFunction calls secondFunction.



namespace AzCodez\MagentoTraining\Controller;

class TestOneMethod
{
    public function mainFunction()
    {
        $this->secondFunction();
    }

    public function secondFunction()
    {
        return 1;
    }
}

Setup your php unit test

First setup basic configuration of calling php unit dependency so we can run tests



use PHPUnit\Framework\TestCase;

class TestOneMethodCallsTest extends TestCase
{

}

Then add real class dependency and setup a variable for it



use PHPUnit\Framework\TestCase;
use AzCodez\MagentoTraining\Controller\TestOneMethod;

class TestOneMethodCallsTest extends TestCase
{
    /**
     * @var TestOneMethod
     */
    protected $testOneMethod;

}

Add a new test funtion with comments for arranging the test, asseting (checking), and calling real class to php unit tests your class



use PHPUnit\Framework\TestCase;
use AzCodez\MagentoTraining\Controller\TestOneMethod;

class TestOneMethodCallsTest extends TestCase
{
    /**
     * @var TestOneMethod
     */
    protected $testOneMethod;

    /**
     * 
     */
    public function testFirstUnitTest()
    {
        //Arrange

        //Asset

        //Act

    }
}

Add to Arrange setting up of method.
We are mocking method so we can test it here
We don't need to set method of 'mainFunction' as we want 'mainFunction' to act like normal and call our secondFunction. We don't want to do any mocking with 'mainFunction'



use PHPUnit\Framework\TestCase;
use AzCodez\MagentoTraining\Controller\TestOneMethod;

class TestOneMethodCallsTest extends TestCase
{
    /**
     * @var TestOneMethod
     */
    protected $testOneMethod;

    /**
     * 
     */
    public function testFirstUnitTest()
    {
        //Arrange
        $this->testOneMethod = $this->getMockBuilder(TestOneMethod::class)
            ->setMethods(['secondFunction'])
            ->getMock();

        //Asset

        //Act

    }
}

Add assert
Here we are testing if the 'secondFunction' is called only once



use PHPUnit\Framework\TestCase;
use AzCodez\MagentoTraining\Controller\TestOneMethod;

class TestOneMethodCallsTest extends TestCase
{
    /**
     * @var TestOneMethod
     */
    protected $testOneMethod;

    /**
     * 
     */
    public function testFirstUnitTest()
    {
        //Arrange
        $this->testOneMethod = $this->getMockBuilder(TestOneMethod::class)
            ->setMethods(['secondFunction'])
            ->getMock();

        //Asset
        $this->testOneMethod->expects($this->once())
        ->method('secondFunction');

        //Act

    }
}

Finally add act. This is where php unit test calls our real class



use PHPUnit\Framework\TestCase;
use AzCodez\MagentoTraining\Controller\TestOneMethod;

class TestOneMethodCallsTest extends TestCase
{
    /**
     * @var TestOneMethod
     */
    protected $testOneMethod;

    /**
     * 
     */
    public function testFirstUnitTest()
    {
        //Arrange
        $this->testOneMethod = $this->getMockBuilder(TestOneMethod::class)
            ->setMethods(['secondFunction'])
            ->getMock();

        //Asset
        $this->testOneMethod->expects($this->once())
        ->method('secondFunction');

        //Act
        $this->testOneMethod->mainFunction();
    }
}

Run your test (I am running a magento instance with phpUnit inside vendor/bin/phpunit folder

./vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist app/code/AzCodez/MagentoTraining/Test/Unit

If you want to check if you are testing properly change your assert to check if secondFunction never calls like below



use PHPUnit\Framework\TestCase;
use AzCodez\MagentoTraining\Controller\TestOneMethod;

class TestOneMethodCallsTest extends TestCase
{
    /**
     * @var TestOneMethod
     */
    protected $testOneMethod;

    /**
     * 
     */
    public function testFirstUnitTest()
    {
        //Arrange
        $this->testOneMethod = $this->getMockBuilder(TestOneMethod::class)
            ->setMethods(['secondFunction'])
            ->getMock();

        //Asset
        $this->testOneMethod->expects($this->never())
        ->method('secondFunction');

        //Act
        $this->testOneMethod->mainFunction();
    }
}

You should get error like below

Hope this works for you. Let me know if you get stuck.

Happy Coding, Asrin

If this helped you consider buying me a coffee :)

References

https://phpunit.readthedocs.io/en/9.5/
https://stackoverflow.com/questions/25214407/how-to-use-phpunit-to-test-a-method-that-calls-other-methods-of-the-same-class