This tutorial shows you how to build a bare-bones search and edit application using Angular and Angular CLI version 10.1.
For older versions of Angular, please see previous tutorials: Angular 9, Angular 7, Angular 6, and Angular 5.
đĄ
|
It appears youâre reading this document on GitHub. If you want a prettier view, install Asciidoctor.js Live Preview for Chrome, then view the raw document. Another option is to use the DocGist view. |
If youâd like to get right to it, the source is on GitHub. To run the app, use ng serve
. To test it, run ng test
. To run its integration tests, run ng e2e
.
Youâll build a simple web application with Angular CLI, a tool for Angular development. Youâll create an application with search and edit features.
-
About 30 minutes.
-
A favorite text editor or IDE. I recommend IntelliJ IDEA.
-
Node.js and npm installed.
-
Angular CLI installed. If you donât have Angular CLI installed, install it using
npm install -g @angular/[email protected]
.
Create a new project using the ng new
command:
ng new ng-demo
When prompted to install Angular routing, type "Y". For the stylesheet format, choose "CSS" (the default).
This will create a ng-demo
project and run npm install
in it. It takes about a minute to complete,
but will vary based on your internet connection speed.
You can see the what version of Angular CLI youâre using with ng version
.
$ ng version _ _ ____ _ ___ / \ _ __ __ _ _ _| | __ _ _ __ / ___| | |_ _| / âł \ | '_ \ / _` | | | | |/ _` | '__| | | | | | | / ___ \| | | | (_| | |_| | | (_| | | | |___| |___ | | /_/ \_\_| |_|\__, |\__,_|_|\__,_|_| \____|_____|___| |___/ Angular CLI: 10.1.0 Node: 14.8.0 OS: darwin x64 Angular: ... Ivy Workspace: Package Version ------------------------------------------------------ @angular-devkit/architect 0.1001.0 @angular-devkit/core 10.1.0 @angular-devkit/schematics 10.1.0 @schematics/angular 10.1.0 @schematics/update 0.1001.0 rxjs 6.6.2
If you run this command from the ng-demo
directory, youâll see even more information.
_ _ ____ _ ___ / \ _ __ __ _ _ _| | __ _ _ __ / ___| | |_ _| / âł \ | '_ \ / _` | | | | |/ _` | '__| | | | | | | / ___ \| | | | (_| | |_| | | (_| | | | |___| |___ | | /_/ \_\_| |_|\__, |\__,_|_|\__,_|_| \____|_____|___| |___/ Angular CLI: 10.1.0 Node: 14.8.0 OS: darwin x64 Angular: 10.1.0 ... animations, cli, common, compiler, compiler-cli, core, forms ... platform-browser, platform-browser-dynamic, router Ivy Workspace: Yes Package Version ----------------------------------------------------------- @angular-devkit/architect 0.1001.0 @angular-devkit/build-angular 0.1001.0 @angular-devkit/build-optimizer 0.1001.0 @angular-devkit/build-webpack 0.1001.0 @angular-devkit/core 10.1.0 @angular-devkit/schematics 10.1.0 @ngtools/webpack 10.1.0 @schematics/angular 10.1.0 @schematics/update 0.1001.0 rxjs 6.6.2 typescript 4.0.2 webpack 4.44.1
The project is configured with a simple web server for development. To start it, run:
ng serve
You should see a screen like the one below at http://localhost:4200.
You can make sure your new projectâs tests pass, run ng test
:
$ ng test ... Chrome 85.0.4183.83 (Mac OS 10.15.6): Executed 3 of 3 SUCCESS (0.156 secs / 0.118 secs)
To add a search feature, open the project in an IDE or your favorite text editor.
In a terminal window, cd into your projectâs directory and run the following command to create a search component.
ng g component search
Open src/app/search/search.component.html
and replace its default HTML with the following:
<h2>Search</h2>
<form>
<input type="search" name="query" [(ngModel)]="query" (keyup.enter)="search()">
<button type="button" (click)="search()">Search</button>
</form>
<pre>{{searchResults | json}}</pre>
If you try to start your app at this point, youâll receive a compilation error.
ERROR in src/app/search/search.component.html:3:50 - error TS2339: Property 'query' does not exist on type 'SearchComponent'.
To fix this, add a query
property to src/app/search/search.component.ts
. While youâre there, add a searchResults
property and an empty search()
method.
export class SearchComponent implements OnInit {
query: string;
searchResults: any;
constructor() { }
ngOnInit(): void { }
search(): void { }
}
The Router and navigation docs for Angular provides the information you need to setup a route to the SearchComponent
you just generated. Hereâs a quick summary:
In src/app/app-routing.module.ts
, modify the routes
constant to add SearchComponent
as the default:
import { SearchComponent } from './search/search.component';
const routes: Routes = [
{ path: 'search', component: SearchComponent },
{ path: '', redirectTo: '/search', pathMatch: 'full' }
];
Run ng serve
again you will see a compilation error.
ERROR in src/app/search/search.component.html:3:37 - error NG8002: Can't bind to 'ngModel' since it isn't a known property of 'input'.
To solve this, open src/app/app.module.ts
and add FormsModule
as an import in @NgModule
:
import { FormsModule } from '@angular/forms';
@NgModule({
...
imports: [
...
FormsModule
]
...
})
export class AppModule { }
Now you should be able to see the search form.
If yours looks different, itâs because I trimmed my app.component.html
to the bare minimum.
<h1>Welcome to {{ title }}!</h1>
<router-outlet></router-outlet>
If you want to add CSS for this component, open src/app/search/search.component.css
and add some CSS. For example:
:host {
display: block;
padding: 0 20px;
}
This section has shown you how to generate a new component and add it to a basic Angular application with Angular CLI. The next section shows you how to create and use a JSON file and localStorage
to create a fake API.
To get search results, create a SearchService
that makes HTTP requests to a JSON file. Start by generating a new service.
ng g service shared/search/search
Create src/assets/data/people.json
to hold your data.
mkdir -p src/assets/data
[
{
"id": 1,
"name": "Nikola JokiÄ",
"phone": "(720) 555-1212",
"address": {
"street": "2000 16th Street",
"city": "Denver",
"state": "CO",
"zip": "80202"
}
},
{
"id": 2,
"name": "Jamal Murray",
"phone": "(303) 321-8765",
"address": {
"street": "2654 Washington Street",
"city": "Lakewood",
"state": "CO",
"zip": "80568"
}
},
{
"id": 3,
"name": "Gary Harris",
"phone": "(303) 323-1233",
"address": {
"street": "99 Westside Way",
"city": "Breckenridge",
"state": "CO",
"zip": "82210"
}
}
]
Modify src/app/shared/search/search.service.ts
and provide HttpClient
as a dependency in its constructor.
In this same file, create a getAll()
method to gather all the people. Also, define the Address
and Person
classes that JSON will be marshalled to.
import { Injectable } from '@angular/core';
import { HttpClient } from '@angular/common/http';
@Injectable({
providedIn: 'root'
})
export class SearchService {
constructor(private http: HttpClient) { }
getAll() {
return this.http.get('assets/data/people.json');
}
}
export class Address {
street: string;
city: string;
state: string;
zip: string;
constructor(obj?: any) {
this.street = obj && obj.street || null;
this.city = obj && obj.city || null;
this.state = obj && obj.state || null;
this.zip = obj && obj.zip || null;
}
}
export class Person {
id: number;
name: string;
phone: string;
address: Address;
constructor(obj?: any) {
this.id = obj && Number(obj.id) || null;
this.name = obj && obj.name || null;
this.phone = obj && obj.phone || null;
this.address = obj && obj.address || null;
}
}
To make these classes easier to consume by your components, create src/app/shared/index.ts
and add the following:
export * from './search/search.service';
The reason for creating this file is so you can import multiple classes on a single line rather than having to import each individual class on separate lines.
In search.component.ts
, add imports for these classes.
import { Person, SearchService } from '../shared';
You can now add a proper type to the searchResults
variable. While youâre there, modify the constructor to inject the SearchService
.
export class SearchComponent implements OnInit {
query: string;
searchResults: Array<Person>;
constructor(private searchService: SearchService) { }
Then update the search()
method to call the serviceâs getAll()
method.
search(): void {
this.searchService.getAll().subscribe(
(data: any) => { this.searchResults = data; },
error => console.log(error)
);
}
At this point, youâll likely see the following message in your browserâs console.
NullInjectorError: No provider for HttpClient!
To fix the "No provider" error from above, update app.module.ts
to import HttpClientModule
.
import { HttpClientModule } from '@angular/common/http';
@NgModule({
...
imports: [
...
HttpClientModule
],
providers: [],
bootstrap: [AppComponent]
})
Now clicking the search button should work. To make the results look better, remove the <pre>
tag and replace it with a <table>
in search.component.html
.
<table *ngIf="searchResults">
<thead>
<tr>
<th>Name</th>
<th>Phone</th>
<th>Address</th>
</tr>
</thead>
<tbody>
<tr *ngFor="let person of searchResults; let i=index">
<td>{{person.name}}</td>
<td>{{person.phone}}</td>
<td>{{person.address.street}}<br/>
{{person.address.city}}, {{person.address.state}} {{person.address.zip}}
</td>
</tr>
</tbody>
</table>
Then add some additional CSS to search.component.css
to improve its table layout.
table {
margin-top: 10px;
border-collapse: collapse;
}
th {
text-align: left;
border-bottom: 2px solid #ddd;
padding: 8px;
}
td {
border-top: 1px solid #ddd;
padding: 8px;
}
Now the search results look better.
But wait, you still donât have search functionality! To add a search feature, add a search()
method to SearchService
.
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
...
search(q: string): Observable<any> {
if (!q || q === '*') {
q = '';
} else {
q = q.toLowerCase();
}
return this.getAll().pipe(
map((data: any) => data
.filter(item => JSON.stringify(item).toLowerCase().includes(q)))
);
}
Then refactor SearchComponent
to call this method with its query
variable.
search(): void {
this.searchService.search(this.query).subscribe(
(data: any) => { this.searchResults = data; },
error => console.log(error)
);
}
Now search results will be filtered by the query value you type in.
This section showed you how to fetch and display search results. The next section builds on this and shows how to edit and save a record.
Modify search.component.html
to wrap the personâs name with a link.
<td><a [routerLink]="['/edit', person.id]">{{person.name}}</a></td>
Run the following command to generate an EditComponent
.
ng g component edit
Add a route for this component in app-routing.module.ts
:
import { EditComponent } from './edit/edit.component';
const routes: Routes = [
{ path: 'search', component: SearchComponent },
{ path: 'edit/:id', component: EditComponent },
{ path: '', redirectTo: '/search', pathMatch: 'full' }
];
Update src/app/edit/edit.component.html
to display an editable form. You might notice Iâve added id
attributes to most elements. This is to make things easier when writing integration tests with Protractor.
<div *ngIf="person">
<h3>{{editName}}</h3>
<div>
<label>Id:</label>
{{person.id}}
</div>
<div>
<label>Name:</label>
<input [(ngModel)]="editName" name="name" id="name" placeholder="name"/>
</div>
<div>
<label>Phone:</label>
<input [(ngModel)]="editPhone" name="phone" id="phone" placeholder="Phone"/>
</div>
<fieldset>
<legend>Address:</legend>
<address>
<input [(ngModel)]="editAddress.street" id="street"><br/>
<input [(ngModel)]="editAddress.city" id="city">,
<input [(ngModel)]="editAddress.state" id="state" size="2">
<input [(ngModel)]="editAddress.zip" id="zip" size="5">
</address>
</fieldset>
<button (click)="save()" id="save">Save</button>
<button (click)="cancel()" id="cancel">Cancel</button>
</div>
Modify EditComponent
to import model and service classes and to use the SearchService
to get data.
import { Component, OnInit, OnDestroy } from '@angular/core';
import { Address, Person, SearchService } from '../shared';
import { Subscription } from 'rxjs';
import { ActivatedRoute, Router } from '@angular/router';
@Component({
selector: 'app-edit',
templateUrl: './edit.component.html',
styleUrls: ['./edit.component.css']
})
export class EditComponent implements OnInit, OnDestroy {
person: Person;
editName: string;
editPhone: string;
editAddress: Address;
sub: Subscription;
constructor(private route: ActivatedRoute,
private router: Router,
private service: SearchService) {
}
ngOnInit(): void {
this.sub = this.route.params.subscribe(params => {
const id = + params.id; // (+) converts string 'id' to a number
this.service.get(id).subscribe(person => {
if (person) {
this.editName = person.name;
this.editPhone = person.phone;
this.editAddress = person.address;
this.person = person;
} else {
this.gotoList();
}
});
});
}
ngOnDestroy(): void {
if (this.sub) {
this.sub.unsubscribe();
}
}
cancel() {
this.router.navigate(['/search']);
}
save() {
this.person.name = this.editName;
this.person.phone = this.editPhone;
this.person.address = this.editAddress;
this.service.save(this.person);
this.gotoList();
}
gotoList() {
if (this.person) {
this.router.navigate(['/search', {term: this.person.name} ]);
} else {
this.router.navigate(['/search']);
}
}
}
Modify SearchService
to contain functions for finding a person by their id, and saving them. While youâre in there, modify the search()
method to be aware of updated objects in localStorage
.
search(q: string): Observable<any> {
if (!q || q === '*') {
q = '';
} else {
q = q.toLowerCase();
}
return this.getAll().pipe(
map((data: any) => data
.map(item => !!localStorage['person' + item.id] ?
JSON.parse(localStorage['person' + item.id]) : item)
.filter(item => JSON.stringify(item).toLowerCase().includes(q))
));
}
get(id: number) {
return this.getAll().pipe(map((all: any) => {
if (localStorage['person' + id]) {
return JSON.parse(localStorage['person' + id]);
}
return all.find(e => e.id === id);
}));
}
save(person: Person) {
localStorage['person' + person.id] = JSON.stringify(person);
}
You can add CSS to src/app/edit/edit.component.css
if you want to make the form look a bit better.
:host {
display: block;
padding: 0 20px;
}
button {
margin-top: 10px;
}
At this point, you should be able to search for a person and update their information.
The <form> in src/app/edit/edit.component.html
calls a save()
function to update a personâs data. You already implemented this above.
The function calls a gotoList()
function that appends the personâs name to the URL when sending the user back to the search screen.
gotoList() {
if (this.person) {
this.router.navigate(['/search', {term: this.person.name} ]);
} else {
this.router.navigate(['/search']);
}
}
Since the SearchComponent
doesnât execute a search automatically when you execute this URL, add the following logic to do so in its ngOnInit
method.
import { ActivatedRoute } from '@angular/router';
import { Subscription } from 'rxjs';
...
sub: Subscription;
constructor(private searchService: SearchService, private route: ActivatedRoute) { }
ngOnInit(): void {
this.sub = this.route.params.subscribe(params => {
if (params.term) {
this.query = decodeURIComponent(params.term);
this.search();
}
});
}
Youâll want to implement OnDestroy
and define the ngOnDestroy
method to clean up this subscription.
import { Component, OnInit, OnDestroy } from '@angular/core';
export class SearchComponent implements OnInit, OnDestroy {
...
ngOnDestroy(): void {
if (this.sub) {
this.sub.unsubscribe();
}
}
}
After making all these changes, you should be able to search/edit/update a personâs information. If it works - nice job!
One thing you might notice is you can clear any input element in the form and save it. At the very least, the name
field should be required. Otherwise, thereâs nothing to click on in the search results.
To make name required, modify edit.component.html
to add a required
attribute to the name <input>
and bind it to Angularâs validation with #name="ngModel"
. Add a <div>
next to the field to display an error message when validation fails.
<input [(ngModel)]="editName" name="name" id="name" placeholder="name" required #name="ngModel"/>
<div [hidden]="name.valid || name.pristine" style="color: red">
Name is required
</div>
Youâll also need to wrap everything in a <form>
element. Add <form>
after the <h3>
tag and close it before the last </div>
. Youâll also need to add an (ngSubmit)
handler to the form, give it a name of editForm
, and change the save button to be a regular submit button thatâs disabled when the form is invalid.
<h3>{{editName}}</h3>
<form (ngSubmit)="save()" #editForm="ngForm">
...
<button type="submit" id="save" [disabled]="!editForm.form.valid">Save</button>
<button (click)="cancel()" id="cancel">Cancel</button>
</form>
After making these changes, the name field will be required.
In this screenshot, you might notice the address fields are blank and the save button is enabled. This is explained by the error in your console.
If ngModel is used within a form tag, either the name attribute must be set or the form control must be defined as 'standalone' in ngModelOptions. Example 1: <input [(ngModel)]="person.firstName" name="first"> Example 2: <input [(ngModel)]="person.firstName" [ngModelOptions]="{standalone: true}">
To fix, add a name
attribute to all the address fields. For example:
<address>
<input [(ngModel)]="editAddress.street" name="street" id="street"><br/>
<input [(ngModel)]="editAddress.city" name="city" id="city">,
<input [(ngModel)]="editAddress.state" name="state" id="state" size="2">
<input [(ngModel)]="editAddress.zip" name="zip" id="zip" size="5">
</address>
Now values display in all fields, name
is required, and save is enabled.
To learn more about forms and validation, see Angular Forms Validation documentation.
Now that youâve built an application, itâs important to test it to ensure it works. The best reason for writing tests is to automate your testing. Without tests, youâll likely be testing manually. This manual testing will take longer and longer as your application grows.
đĄ
|
If you didnât complete the previous section, you can clone the git clone -b test-start https://github.com/mraible/ng-demo.git cd ng-demo && npm i |
In this section, youâll learn to use Jasmine for unit testing controllers and Protractor for integration testing. Angularâs testing documentation lists good reasons to test, but doesnât currently have many examples.
If you run ng test
, youâll likely get failures for the components and service you created. These failures will be solved as you complete the section below.
đĄ
|
You can use x and f prefixes Jasmineâs describe and it functions to exclude only run only a particular test.
|
If you changed the app.component.html
template like I did, youâll need to modify app.component.spec.ts
to account for the change in HTML. Change its last test to look for an <h1>
element and the welcome message inside it.
it('should render title', () => {
const fixture = TestBed.createComponent(AppComponent);
fixture.detectChanges();
const compiled = fixture.nativeElement;
expect(compiled.querySelector('h1').textContent).toContain('Welcome to ng-demo!');
});
Now this test should pass.
Modify src/app/shared/search/search.service.spec.ts
and setup the testâs infrastructure (a.k.a. TestBed
) using HttpClientTestingModule
and HttpTestingController
.
import { TestBed } from '@angular/core/testing';
import { SearchService } from './search.service';
import { HttpClientTestingModule, HttpTestingController } from '@angular/common/http/testing';
describe('SearchService', () => {
let service: SearchService;
let httpMock: HttpTestingController;
beforeEach(() => {
TestBed.configureTestingModule({
imports: [HttpClientTestingModule],
providers: [SearchService]
});
service = TestBed.inject(SearchService);
httpMock = TestBed.inject(HttpTestingController);
});
it('should be created', () => {
expect(service).toBeTruthy();
});
});
If you run ng test
, you will likely see some errors about the test stubs that Angular CLI created for you. You can ignore these for now.
NullInjectorError: R3InjectorError(DynamicTestModule)[SearchService -> HttpClient -> HttpClient]: NullInjectorError: No provider for HttpClient! NullInjectorError: R3InjectorError(DynamicTestModule)[ActivatedRoute -> ActivatedRoute]: NullInjectorError: No provider for ActivatedRoute!
HttpTestingController
allows you to mock requests and use its flush()
method to provide response values. Since the HTTP request methods return an Observable
, you can subscribe to it and create expectations in the callback methods. Add the first test of getAll()
to search.service.spec.ts
.
The test below should be on the same level as beforeEach
.
it('should retrieve all search results', () => {
const mockResponse = [
{name: 'Nikola JokiÄ'},
{name: 'Mike Malone'}
];
service.getAll().subscribe((people: any) => {
expect(people.length).toBe(2);
expect(people[0].name).toBe('Nikola JokiÄ');
expect(people).toEqual(mockResponse);
});
const req = httpMock.expectOne('assets/data/people.json');
expect(req.request.method).toBe('GET');
req.flush(mockResponse);
});
While youâre there, add an afterEach()
to verify requests.
afterEach(() => {
httpMock.verify();
});
Add a couple more tests for filtering by search term and fetching by id.
it('should filter by search term', () => {
const mockResponse = [{name: 'Nikola JokiÄ'}];
service.search('nik').subscribe((people: any) => {
expect(people.length).toBe(1);
expect(people[0].name).toBe('Nikola JokiÄ');
});
const req = httpMock.expectOne('assets/data/people.json');
expect(req.request.method).toBe('GET');
req.flush(mockResponse);
});
it('should fetch by id', () => {
const mockResponse = [
{id: 1, name: 'Nikola JokiÄ'},
{id: 2, name: 'Mike Malone'}
];
service.get(2).subscribe((person: any) => {
expect(person.name).toBe('Mike Malone');
});
const req = httpMock.expectOne('assets/data/people.json');
expect(req.request.method).toBe('GET');
req.flush(mockResponse);
});
To unit test the SearchComponent
, you can mock the methods in SearchService
with spies. These allow you to spy on functions to check if they were called.
Create src/app/shared/search/mocks/routes.ts
to mock Angularâs Router
and ActivatedRoute
.
import { ActivatedRoute, Params } from '@angular/router';
import { Observable, of } from 'rxjs';
export class MockActivatedRoute extends ActivatedRoute {
params: Observable<Params>;
constructor(parameters?: { [key: string]: any; }) {
super();
this.params = of(parameters);
}
}
export class MockRouter {
navigate = jasmine.createSpy('navigate');
}
With this mock in place, you can TestBed.configureTestingModule()
to setup SearchComponent
to use it as a provider. In the second beforeEach()
, you can see that the search()
method is spied on and its results are mocked. The response isnât important in this case because youâre just unit testing the SearchComponent
.
import { ComponentFixture, TestBed } from '@angular/core/testing';
import { SearchComponent } from './search.component';
import { SearchService } from '../shared';
import { ActivatedRoute } from '@angular/router';
import { RouterTestingModule } from '@angular/router/testing';
import { FormsModule } from '@angular/forms';
import { MockActivatedRoute } from '../shared/search/mocks/routes';
import { of } from 'rxjs';
import { HttpClientTestingModule } from '@angular/common/http/testing';
describe('SearchComponent', () => {
let component: SearchComponent;
let fixture: ComponentFixture<SearchComponent>;
let mockSearchService: SearchService;
let mockActivatedRoute: MockActivatedRoute;
beforeEach((() => {
mockActivatedRoute = new MockActivatedRoute({term: 'nikola'});
TestBed.configureTestingModule({
declarations: [SearchComponent],
providers: [
{provide: ActivatedRoute, useValue: mockActivatedRoute}
],
imports: [FormsModule, RouterTestingModule, HttpClientTestingModule]
}).compileComponents();
}));
beforeEach(() => {
// mock response
mockSearchService = TestBed.inject(SearchService);
mockSearchService.search = jasmine.createSpy().and.returnValue(of([]));
// initialize component
fixture = TestBed.createComponent(SearchComponent);
component = fixture.componentInstance;
fixture.detectChanges();
});
it('should create', () => {
expect(component).toBeTruthy();
});
});
Add two tests, one to verify a search term is used when itâs set on the component, and a second to verify search is called when a term is passed in as a route parameter.
it('should search when a term is set and search() is called', () => {
component = fixture.debugElement.componentInstance;
component.query = 'J';
component.search();
expect(mockSearchService.search).toHaveBeenCalledWith('J');
});
it('should search automatically when a term is on the URL', () => {
fixture.detectChanges();
expect(mockSearchService.search).toHaveBeenCalledWith('nikola');
});
Update the test for EditComponent
, verifying fetching a single record works. Notice how you can access the component directly with fixture.debugElement.componentInstance
, or its rendered version with fixture.debugElement.nativeElement
.
import { EditComponent } from './edit.component';
import { TestBed } from '@angular/core/testing';
import { Address, Person, SearchService } from '../shared';
import { MockActivatedRoute, MockRouter } from '../shared/search/mocks/routes';
import { ActivatedRoute, Router } from '@angular/router';
import { FormsModule } from '@angular/forms';
import { of } from 'rxjs';
import { HttpClientTestingModule } from '@angular/common/http/testing';
describe('EditComponent', () => {
let mockSearchService: SearchService;
let mockActivatedRoute: MockActivatedRoute;
let mockRouter: MockRouter;
beforeEach(() => {
mockActivatedRoute = new MockActivatedRoute({id: 1});
mockRouter = new MockRouter();
TestBed.configureTestingModule({
declarations: [EditComponent],
providers: [
{provide: ActivatedRoute, useValue: mockActivatedRoute},
{provide: Router, useValue: mockRouter}
],
imports: [FormsModule, HttpClientTestingModule]
}).compileComponents();
mockSearchService = TestBed.inject(SearchService);
});
it('should fetch a single record', () => {
const fixture = TestBed.createComponent(EditComponent);
const person = new Person({id: 1, name: 'Gary Harris'});
person.address = new Address({city: 'Denver'});
// mock response
spyOn(mockSearchService, 'get').and.returnValue(of(person));
// initialize component
fixture.detectChanges();
// verify service was called
expect(mockSearchService.get).toHaveBeenCalledWith(1);
// verify data was set on component when initialized
const editComponent = fixture.debugElement.componentInstance;
expect(editComponent.editAddress.city).toBe('Denver');
// verify HTML renders as expected
const compiled = fixture.debugElement.nativeElement;
expect(compiled.querySelector('h3').innerHTML).toBe('Gary Harris');
});
});
You should see "Executed 11 of 11 SUCCESS (0.118 secs / 0.096 secs)" in the shell window thatâs running ng test
. If you donât, try cancelling the command and restarting.
To test if the application works end-to-end, you can write tests with Protractor. These are also known as integration tests, since they test the integration between all layers of your application.
To verify end-to-end tests work in the project before you begin, run the following command in a terminal window.
ng e2e
Youâll likely see the following error:
1) workspace-project App should display welcome message - Failed: No element found using locator: By(css selector, app-root .content span)
This happens because you changed the HTML structure of app.component.html
. To fix it, change the selector in app.po.ts
to look for the <h1>
element.
getTitleText(): Promise<string> {
return element(by.css('app-root h1')).getText() as Promise<string>;
}
Youâll also need to change the test in app.e2e-spec.ts
to use the new welcome message.
it('should display welcome message', () => {
page.navigateTo();
expect(page.getTitleText()).toEqual('Welcome to ng-demo!');
});
Now you should be able to run ng e2e
and have everything pass.
$ ng e2e [23:47:29] I/update - chromedriver: file exists /Users/mraible/ng-demo/node_modules/protractor/node_modules/webdriver-manager/selenium/chromedriver_85.0.4183.87.zip [23:47:29] I/update - chromedriver: unzipping chromedriver_85.0.4183.87.zip [23:47:29] I/update - chromedriver: setting permissions to 0755 for /Users/mraible/ng-demo/node_modules/protractor/node_modules/webdriver-manager/selenium/chromedriver_85.0.4183.87 [23:47:29] I/update - chromedriver: chromedriver_85.0.4183.87 up to date chunk {main} main.js, main.js.map (main) 41.5 kB [initial] [rendered] chunk {polyfills} polyfills.js, polyfills.js.map (polyfills) 141 kB [initial] [rendered] chunk {runtime} runtime.js, runtime.js.map (runtime) 6.15 kB [entry] [rendered] chunk {styles} styles.js, styles.js.map (styles) 12.5 kB [initial] [rendered] chunk {vendor} vendor.js, vendor.js.map (vendor) 2.99 MB [initial] [rendered] Date: 2020-09-05T05:47:35.554Z - Hash: 1f37ff085dda89695218 - Time: 4956ms ** Angular Live Development Server is listening on localhost:4200, open your browser on http://localhost:4200/ ** : Compiled successfully. [23:47:35] I/launcher - Running 1 instances of WebDriver [23:47:35] I/direct - Using ChromeDriver directly... Jasmine started workspace-project App â should display welcome message Executed 1 of 1 spec SUCCESS in 0.315 sec. [23:47:38] I/launcher - 0 instance(s) of WebDriver still running [23:47:38] I/launcher - chrome #01 passed Execution time: 11 s.
Create end-to-end tests in e2e/src/search.e2e-spec.ts
to verify the search feature works. Populate it with the following code:
import { browser, by, element } from 'protractor';
describe('Search', () => {
beforeEach(async () => {
await browser.get('/search');
});
it('should have an input and search button', () => {
expect(element(by.css('app-root app-search form input')).isPresent()).toEqual(true);
expect(element(by.css('app-root app-search form button')).isPresent()).toEqual(true);
});
it('should allow searching', async () => {
const searchButton = element(by.css('button'));
const searchBox = element(by.css('input'));
await searchBox.sendKeys('A');
await searchButton.click();
const list = element.all(by.css('app-search table tbody tr'));
expect(list.count()).toBe(3);
});
});
Create a e2e/src/edit.e2e-spec.ts
test to verify the EditComponent
renders a personâs information and that their information can be updated.
import { browser, by, element } from 'protractor';
describe('Edit', () => {
beforeEach(async () => {
await browser.get('/edit/1');
});
const name = element(by.id('name'));
const street = element(by.id('street'));
const city = element(by.id('city'));
it('should allow viewing a person', async () => {
expect(await element(by.css('h3')).getText()).toEqual('Nikola JokiÄ');
expect(await name.getAttribute('value')).toEqual('Nikola JokiÄ');
expect(await street.getAttribute('value')).toEqual('2000 16th Street');
expect(await city.getAttribute('value')).toEqual('Denver');
});
it('should allow updating a name', async () => {
const save = element(by.id('save'));
name.sendKeys(' Rocks!');
await save.click();
// verify one element matched this change
const list = element.all(by.css('app-search table tbody tr'));
expect(list.count()).toBe(1);
});
});
Run ng e2e
to verify all your end-to-end tests pass. You should see a success message similar to the one below in your terminal window.
If you made it this far and have all your specs passing - congratulations! Youâre well on your way to writing quality code with Angular and verifying it works.
You can see the test coverage of your project by running ng test --codeCoverage=true
.
Youâll see a print out of code coverage in your terminal window.
=============================== Coverage summary =============================== Statements : 80.56% ( 58/72 ) Branches : 71.43% ( 30/42 ) Functions : 82.76% ( 24/29 ) Lines : 78.79% ( 52/66 ) ================================================================================
You can also open coverage/ng-demo/index.html
in your browser.
You might notice that the EditComponent
could use some additional coverage. If you feel the need to improve this coverage, please create a pull request!
At the time of this writing, Angular CLI did not have any continuous integration support. This section shows you how to setup continuous integration with GitHub Actions, Travis CI and Jenkins.
đĽ
|
In the commands below, I use master as the branch name. I use this because itâs the default. I recommend you change your default branch name to main .
|
If youâve checked your project into GitHub, you can use GitHub Actions.
Create a .github/workflows/main.yml
file. Add the following YAML to it. This will run both unit tests and integrations tests.
name: Angular
on: [push, pull_request]
jobs:
build:
name: Build and Test
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Use Node 12.x
uses: actions/setup-node@v1
with:
node-version: '14.x'
- name: Install latest Chrome
run: |
sudo apt update
sudo apt --only-upgrade install google-chrome-stable
google-chrome --version
- name: Install dependencies
run: npm ci
- name: Run unit tests
run: xvfb-run npm test -- --watch=false
- name: Run integration tests
run: xvfb-run --server-args="-screen 0 1024x768x24" --auto-servernum npm run e2e
Check it in on a branch, create a pull request for that branch, and you should see your tests running.
Here is a build showing all unit and integration tests passing.
If youâve checked in your project to GitHub, you can use Travis CI.
-
Login to Travis CI and enable builds for the GitHub repo you published the project to.
-
Add the following
.travis.yml
in your root directory andgit commit/push
it. This will trigger the first build.
dist: bionic
os:
- linux
services:
- docker
- xvfb
language: node_js
node_js:
- "14.x"
addons:
apt:
packages:
- dpkg
chrome: stable
cache:
directories:
- node_modules
branches:
only:
- master
install:
- npm ci
script:
- npm test -- --watch=false
- npm run e2e
notifications:
webhooks:
on_success: change
on_failure: always
on_start: false
Here is a build showing all unit and integration tests passing.
If youâve checked your project into source control, you can use Jenkins to automate testing.
-
Create a
Jenkinsfile
in the root directory and commit/push it.
node { def nodeHome = tool name: 'node-14.x', type: 'jenkins.plugins.nodejs.tools.NodeJSInstallation' env.PATH = "${nodeHome}/bin:${env.PATH}" stage('check tools') { sh "node -v" sh "npm -v" } stage('checkout') { checkout scm } stage('npm install') { sh "npm install" } stage('unit tests') { sh "npm test -- --watch=false" } stage('protractor tests') { sh "npm run e2e" } }
-
Install Jenkins on your hard drive and start it.
-
Login to Jenkins at
http://localhost:8080
and install the Node.js plugin. -
Go to Manage Jenkins > Global Tool Configuration > NodeJS. Install and configure the name of your Node.js installation to match your build script.
-
Create a new project with Pipeline > Pipeline script from SCM (near the bottom). Point it at your projectâs repository.
-
Click Build Now.
This section shows you how to deploy an Angular app to Cloud Foundry and Heroku.
Login to your account.
cf login -a api.run.pivotal.io
Then run the following commands to build and deploy your application.
ng build --prod
cd dist && touch Staticfile
# enable pushstate so no 404s on refresh
echo 'root: ng-demo\npushstate: enabled' > Staticfile
cf push ng-demo
đ
|
You might need to use an app name other than ng-demo . For example, coolest-ever .
|
Create a Heroku account, install the heroku CLI, and run heroku login
.
Then run the following commands to build and deploy your application.
Run heroku create
to create an app on Heroku.
Create a static.json
file with the configuration for secure headers and redirect all HTTP requests to HTTPS.
{
"headers": {
"/**": {
"Content-Security-Policy": "default-src 'self'; script-src 'self' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; frame-ancestors 'none'; connect-src 'self' https://*.okta.com https://*.herokuapp.com",
"Referrer-Policy": "no-referrer, strict-origin-when-cross-origin",
"Strict-Transport-Security": "max-age=63072000; includeSubDomains",
"X-Content-Type-Options": "nosniff",
"X-Frame-Options": "DENY",
"X-XSS-Protection": "1; mode=block",
"Feature-Policy": "accelerometer 'none'; camera 'none'; microphone 'none'"
}
},
"https_only": true,
"root": "dist/ng-demo/",
"routes": {
"/**": "index.html"
}
}
đ
|
In this code, you might notice that some https URLs are allowed in the content security policy. Those are there this app can make XHR requests to those domains when that functionality is added. |
For static.json
to be read, you have to use the Heroku static buildpack.
Add --prod
to the build
script since the static buildback uses this command.
"scripts": {
"ng": "ng",
"start": "ng serve",
"build": "ng build --prod",
"test": "ng test",
"lint": "ng lint",
"e2e": "ng e2e"
},
Commit your changes to Git, add the Node.js + static buildpack, and redeploy your Angular app.
git add .
git commit -m "Configure secure headers and static buildpack"
heroku buildpacks:add heroku/nodejs
heroku buildpacks:add https://github.com/heroku/heroku-buildpack-static.git
git push heroku master
View the application in your browser with heroku open
. Try your appâs URL on https://securityheaders.com to be pleasantly suprised.
đĄ
|
You can watch your appâs logs using heroku logs --tail .
|
A completed project with this code in it is available on GitHub at https://github.com/mraible/ng-demo.
I hope youâve enjoyed this in-depth tutorial on how to get started with Angular and Angular CLI. Angular CLI takes much of the pain out of setting up an Angular project and using Typescript. I expect great things from Angular CLI, mostly because the Angular setup process can be tedious and CLI greatly simplifies things.
If youâd like to see how to integrate Angular Material, Bootstrap 4, authentication with Okta, or Electron this section is for you!
Iâve created branches to show how to integrate each of these libraries. Click on the links below to see each branchâs documentation.