tja4472 / ng-angularfire-testbed-single-app

This project was generated with Angular CLI version 12.2.8.

• Setup after cloning
  • serviceAccount-real.json
  • .emulator/.firebaserc
  • src/app/firebase/firebase-config-dev.ts
  • src/app/firebase/firebase-config-prod.ts
  • cypress/support/firebase/firebase-config-dev.ts
• Setup
  • App
    • Root Folder
      • .firebaserc
      • package.json
        • emulators:start-demo
    • Firebase Folder
      • firebase-config-dev.ts
      • firebase-config-prod.ts
  • Cypress
    • Root Folder
      • package.json
        • cypress:emulate-demo
        • cypress:emulate-real
      • serviceAccount-real.json
    • Firebase folder
      • firebase-config-dev.ts
• ** IGNORE BELOW HERE **
• Todo
• Firebase CLI
• Description
  • DDDD
• Setup
  • serviceAccount.json
  • .firebaserc
  • test-security-rules\firebase-info.ts
  • src\app\firebase\firebase-config.ts
  • - cypress\support\firebase\firebase-config.ts
• Test security rules using emulator
• Testing Security Rules with Jest
• Run app using emulator
• Run Cypress tests with emulator
  • Run unit tests with emulator?
• Scripts
  • Scripts
    • test-firestore-rules
    • test-firestore-rules:emulator
  • blah
• References
• Release Notes
• Notes
• aaa
  • Development server
  • Code scaffolding
  • Build
  • Running unit tests
  • Running end-to-end tests
  • Further help

Setup after cloning

serviceAccount-real.json

Service account file from Firebase.

.emulator/.firebaserc

src/app/firebase/firebase-config-dev.ts

src/app/firebase/firebase-config-prod.ts

cypress/support/firebase/firebase-config-dev.ts

Setup

You need Java to run the emulators. wsl2 test edit

npx ng generate @schematics/angular:library --name=MyLibrary --skip-install --skip-package-json --skip-ts-config

App

Root Folder

Create the following files.

.firebaserc

{
  "projects": {
    "default": "firebase project"
  }
}

package.json

Edit the following scripts:

emulators:start-demo

Edit --project to use your demo project.

"scripts": {
    "emulators:start-demo": "firebase emulators:start --only firestore,auth --project demo-1",
 }

Firebase Folder

src > app > firebase

firebase-config-dev.ts

// This file should be added to .gitignore.
import { FirebaseConfig } from './firebase-config-interface';

export const firebaseConfigDev: FirebaseConfig = {
  apiKey: 'XXXXXXXXX',
  authDomain: 'XXXXXXXXX',
  databaseURL: 'XXXXXXXXX',
  projectId: 'XXXXXXXXX',
  storageBucket: 'XXXXXXXXX',
  messagingSenderId: 'XXXXXXXXX',
  appId: 'XXXXXXXXX',
};

firebase-config-prod.ts

// This file should be added to .gitignore.
import { FirebaseConfig } from './firebase-config-interface';

export const firebaseConfigProd: FirebaseConfig = {
  apiKey: 'XXXXXXXXX',
  authDomain: 'XXXXXXXXX',
  databaseURL: 'XXXXXXXXX',
  projectId: 'XXXXXXXXX',
  storageBucket: 'XXXXXXXXX',
  messagingSenderId: 'XXXXXXXXX',
  appId: 'XXXXXXXXX',
};

Cypress

Root Folder

package.json

Edit the following scripts:

cypress:emulate-demo

Edit GCLOUD_PROJECT to use your demo project.

"scripts": {
    "cypress:emulate-demo": "cross-env FIRESTORE_EMULATOR_HOST=\"localhost:8080\" FIREBASE_AUTH_EMULATOR_HOST=\"localhost:9099\" CYPRESS_USE_DEMO_PROJECT=\"true\" GCLOUD_PROJECT=\"demo-1\" npm run cypress:open",
}

cypress:emulate-real

Edit GCLOUD_PROJECT to use your real project.

"scripts": {
     "cypress:emulate-real": "cross-env FIRESTORE_EMULATOR_HOST=\"localhost:8080\" FIREBASE_AUTH_EMULATOR_HOST=\"localhost:9099\" GCLOUD_PROJECT=\"emulators-codelab-a5a89\" npm run cypress:open",
}

serviceAccount-real.json

Service account file from Firebase.

Firebase folder

cypress > support > firebase

firebase-config-dev.ts

// This file should be added to .gitignore.
import { FirebaseConfig } from './firebase-config-interface';

export const firebaseConfigDev: FirebaseConfig = {
  apiKey: 'XXXXXXXXX',
  authDomain: 'XXXXXXXXX',
  databaseURL: 'XXXXXXXXX',
  projectId: 'XXXXXXXXX',
  storageBucket: 'XXXXXXXXX',
  messagingSenderId: 'XXXXXXXXX',
  appId: 'XXXXXXXXX',
};

** IGNORE BELOW HERE **

Todo

test https://firebase.google.com/docs/emulator-suite/connect_auth

There are 3 scenarios when testing with Cypress:

Run npm scripts:

1. Using real Firebase projects.

   1. start
   2. cypress:open

2. Using real firebase projects with emulators.

   1. emulators:start-real
   2. start:start:emulator-real
   3. cypress:emulate-real

3. Using demo projects with emulators.

   1. emulators:start-demo
   2. start:emulator-demo
   3. cypress:emulate-demo

• Testing data service.

Firebase CLI

• Install Firebase CLI. npm install -g firebase-tools

firebase init

Firestore and Emulators

Authentication, Functions, Firestore,& Hosting emulators.

Description

Intended to show:

• The use of AngularFire with the Firebase emulator.
• The use of Jest for testing the Firestore security rules with the Firebase emulator.
• The use of Cypress to test an app using AngularFire with the Firebase emulator.

DDDD

Setup

In the following YOUR_PROJECT_ID is the id of your Firebase project.

Add the following files

• serviceAccount.json
• .firebaserc
• test-security-rules\firebase-info.ts
• src\app\firebase\firebase-config.ts
• cypress\support\firebase\firebase-config.ts

Run npm install in root and in `test-security-rules.

serviceAccount.json

To generate a private key file for your service account:

1. In the Firebase console, open Settings > Service Accounts.

2. Click Generate New Private Key, then confirm by clicking Generate Key.

3. Securely store the JSON file containing the key.

.firebaserc

{
  "projects": {
    "default": "YOUR_PROJECT_ID"
  }
}

test-security-rules\firebase-info.ts

src\app\firebase\firebase-config.ts

- cypress\support\firebase\firebase-config.ts

Test security rules using emulator

Open test-security-rules folder in own copy of vscode. This allows the use of the Jest(vscode-jest) extension when developing tests.

Or from this project run scripts

• emulators:start
• test - test-security-rules

Testing Security Rules with Jest

• Open the test-security-rules folder in another instance of vscode. This will allow the use of the vscode-jest extension for working with the tests.
• Initially Jest will be stopped. View > Command Pallete > Jest: Start Ruuner will start Jest.
• The emulator needs to be running for the the tests to pass: emulators:start

Run app using emulator

Run scripts

• emulators:start
• start:emulator

Run Cypress tests with emulator

Run scripts

• emulators:start
• start:emulator
• cy:emulate

Run unit tests with emulator?

May have a requirement to run tests which require the emulator to be running. These tests should not run when the emulator is not running.

The current technique is to x the tests when not needed and f the tests when they are needed.

Or maybe switch to Jest.

Scripts

npm run ...	Description
cy:emulate	Opens Cypress after setting environment variable.
emulators:start	Starts emulator
start:emulator	Starts app using the emulator configuration. Requires the emulator to be running.

Scripts

test-firestore-rules

Runs security rules tests. Requires the emulator to be running.

test-firestore-rules:emulator

Starts emulator and runs security rules tests.

• emulators:start
  • Starts emulator
• test-firestore-rules
  • Runs security rules tests. Requires the emulator to be running.
• test-firestore-rules:emulator
  • Starts emulator and runs security rules tests.

• need to only run tests when emulator is running.

blah

Use Cypress.

References

• Test Security Rules

• https://firebase.google.com/docs/emulator-suite

• https://github.com/angular/angularfire

• Cypress

  • https://github.com/cypress-io/cypress
  • https://www.cypress.io/
  • https://github.com/cypress-io/cypress-realworld-app
  • https://github.com/prescottprue/cypress-firebase

• https://github.com/firebase/firebase-tools

• UKM

  • firestore.rules.spec.ts
  • transactions.service.spec.ts

• tickist-app

• angularfire

  • document.spec.ts

    • provide

Release Notes

• @angular-builders/jest
• @firebase/testing
• firebase
• firebase-admin
• firebase-tools
• cypress
• cypress-firebase
• Typescript

Notes

After upgrade Angular to v8: Can't resolve all parameters for Component: (?)

thymikee/jest-preset-angular#288

aaa

This project was generated with Angular CLI version 9.1.7.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the --prod flag for a production build.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor.

Further help

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.